initial public commit
This commit is contained in:
commit
6456bc19ce
3
.gitignore
vendored
Normal file
3
.gitignore
vendored
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
/.vscode
|
||||||
|
/test-in-vm/
|
||||||
|
/.env
|
675
LICENSE.md
Normal file
675
LICENSE.md
Normal file
|
@ -0,0 +1,675 @@
|
||||||
|
# GNU GENERAL PUBLIC LICENSE
|
||||||
|
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc.
|
||||||
|
<https://fsf.org/>
|
||||||
|
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies of this
|
||||||
|
license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
## Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom
|
||||||
|
to share and change all versions of a program--to make sure it remains
|
||||||
|
free software for all its users. We, the Free Software Foundation, use
|
||||||
|
the GNU General Public License for most of our software; it applies
|
||||||
|
also to any other work released this way by its authors. You can apply
|
||||||
|
it to your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you
|
||||||
|
have certain responsibilities if you distribute copies of the
|
||||||
|
software, or if you modify it: responsibilities to respect the freedom
|
||||||
|
of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the
|
||||||
|
manufacturer can do so. This is fundamentally incompatible with the
|
||||||
|
aim of protecting users' freedom to change the software. The
|
||||||
|
systematic pattern of such abuse occurs in the area of products for
|
||||||
|
individuals to use, which is precisely where it is most unacceptable.
|
||||||
|
Therefore, we have designed this version of the GPL to prohibit the
|
||||||
|
practice for those products. If such problems arise substantially in
|
||||||
|
other domains, we stand ready to extend this provision to those
|
||||||
|
domains in future versions of the GPL, as needed to protect the
|
||||||
|
freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish
|
||||||
|
to avoid the special danger that patents applied to a free program
|
||||||
|
could make it effectively proprietary. To prevent this, the GPL
|
||||||
|
assures that patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
## TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
### 0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds
|
||||||
|
of works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of
|
||||||
|
an exact copy. The resulting work is called a "modified version" of
|
||||||
|
the earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user
|
||||||
|
through a computer network, with no transfer of a copy, is not
|
||||||
|
conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices" to
|
||||||
|
the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
### 1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work for
|
||||||
|
making modifications to it. "Object code" means any non-source form of
|
||||||
|
a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users can
|
||||||
|
regenerate automatically from other parts of the Corresponding Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that same
|
||||||
|
work.
|
||||||
|
|
||||||
|
### 2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not convey,
|
||||||
|
without conditions so long as your license otherwise remains in force.
|
||||||
|
You may convey covered works to others for the sole purpose of having
|
||||||
|
them make modifications exclusively for you, or provide you with
|
||||||
|
facilities for running those works, provided that you comply with the
|
||||||
|
terms of this License in conveying all material for which you do not
|
||||||
|
control copyright. Those thus making or running the covered works for
|
||||||
|
you must do so exclusively on your behalf, under your direction and
|
||||||
|
control, on terms that prohibit them from making any copies of your
|
||||||
|
copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under the
|
||||||
|
conditions stated below. Sublicensing is not allowed; section 10 makes
|
||||||
|
it unnecessary.
|
||||||
|
|
||||||
|
### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such
|
||||||
|
circumvention is effected by exercising rights under this License with
|
||||||
|
respect to the covered work, and you disclaim any intention to limit
|
||||||
|
operation or modification of the work as a means of enforcing, against
|
||||||
|
the work's users, your or third parties' legal rights to forbid
|
||||||
|
circumvention of technological measures.
|
||||||
|
|
||||||
|
### 4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
### 5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these
|
||||||
|
conditions:
|
||||||
|
|
||||||
|
- a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
- b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under
|
||||||
|
section 7. This requirement modifies the requirement in section 4
|
||||||
|
to "keep intact all notices".
|
||||||
|
- c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
- d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
### 6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms of
|
||||||
|
sections 4 and 5, provided that you also convey the machine-readable
|
||||||
|
Corresponding Source under the terms of this License, in one of these
|
||||||
|
ways:
|
||||||
|
|
||||||
|
- a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
- b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the Corresponding
|
||||||
|
Source from a network server at no charge.
|
||||||
|
- c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
- d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
- e) Convey the object code using peer-to-peer transmission,
|
||||||
|
provided you inform other peers where the object code and
|
||||||
|
Corresponding Source of the work are being offered to the general
|
||||||
|
public at no charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal,
|
||||||
|
family, or household purposes, or (2) anything designed or sold for
|
||||||
|
incorporation into a dwelling. In determining whether a product is a
|
||||||
|
consumer product, doubtful cases shall be resolved in favor of
|
||||||
|
coverage. For a particular product received by a particular user,
|
||||||
|
"normally used" refers to a typical or common use of that class of
|
||||||
|
product, regardless of the status of the particular user or of the way
|
||||||
|
in which the particular user actually uses, or expects or is expected
|
||||||
|
to use, the product. A product is a consumer product regardless of
|
||||||
|
whether the product has substantial commercial, industrial or
|
||||||
|
non-consumer uses, unless such uses represent the only significant
|
||||||
|
mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to
|
||||||
|
install and execute modified versions of a covered work in that User
|
||||||
|
Product from a modified version of its Corresponding Source. The
|
||||||
|
information must suffice to ensure that the continued functioning of
|
||||||
|
the modified object code is in no case prevented or interfered with
|
||||||
|
solely because modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or
|
||||||
|
updates for a work that has been modified or installed by the
|
||||||
|
recipient, or for the User Product in which it has been modified or
|
||||||
|
installed. Access to a network may be denied when the modification
|
||||||
|
itself materially and adversely affects the operation of the network
|
||||||
|
or violates the rules and protocols for communication across the
|
||||||
|
network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
### 7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders
|
||||||
|
of that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
- a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
- b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
- c) Prohibiting misrepresentation of the origin of that material,
|
||||||
|
or requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
- d) Limiting the use for publicity purposes of names of licensors
|
||||||
|
or authors of the material; or
|
||||||
|
- e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
- f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions
|
||||||
|
of it) with contractual assumptions of liability to the recipient,
|
||||||
|
for any liability that these contractual assumptions directly
|
||||||
|
impose on those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions; the
|
||||||
|
above requirements apply either way.
|
||||||
|
|
||||||
|
### 8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your license
|
||||||
|
from a particular copyright holder is reinstated (a) provisionally,
|
||||||
|
unless and until the copyright holder explicitly and finally
|
||||||
|
terminates your license, and (b) permanently, if the copyright holder
|
||||||
|
fails to notify you of the violation by some reasonable means prior to
|
||||||
|
60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
### 9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or run
|
||||||
|
a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
### 10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
### 11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims owned
|
||||||
|
or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within the
|
||||||
|
scope of its coverage, prohibits the exercise of, or is conditioned on
|
||||||
|
the non-exercise of one or more of the rights that are specifically
|
||||||
|
granted under this License. You may not convey a covered work if you
|
||||||
|
are a party to an arrangement with a third party that is in the
|
||||||
|
business of distributing software, under which you make payment to the
|
||||||
|
third party based on the extent of your activity of conveying the
|
||||||
|
work, and under which the third party grants, to any of the parties
|
||||||
|
who would receive the covered work from you, a discriminatory patent
|
||||||
|
license (a) in connection with copies of the covered work conveyed by
|
||||||
|
you (or copies made from those copies), or (b) primarily for and in
|
||||||
|
connection with specific products or compilations that contain the
|
||||||
|
covered work, unless you entered into that arrangement, or that patent
|
||||||
|
license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
### 12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under
|
||||||
|
this License and any other pertinent obligations, then as a
|
||||||
|
consequence you may not convey it at all. For example, if you agree to
|
||||||
|
terms that obligate you to collect a royalty for further conveying
|
||||||
|
from those to whom you convey the Program, the only way you could
|
||||||
|
satisfy both those terms and this License would be to refrain entirely
|
||||||
|
from conveying the Program.
|
||||||
|
|
||||||
|
### 13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
### 14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions
|
||||||
|
of the GNU General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in
|
||||||
|
detail to address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the Program
|
||||||
|
specifies that a certain numbered version of the GNU General Public
|
||||||
|
License "or any later version" applies to it, you have the option of
|
||||||
|
following the terms and conditions either of that numbered version or
|
||||||
|
of any later version published by the Free Software Foundation. If the
|
||||||
|
Program does not specify a version number of the GNU General Public
|
||||||
|
License, you may choose any version ever published by the Free
|
||||||
|
Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future versions
|
||||||
|
of the GNU General Public License can be used, that proxy's public
|
||||||
|
statement of acceptance of a version permanently authorizes you to
|
||||||
|
choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
### 15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
|
||||||
|
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
|
||||||
|
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
|
||||||
|
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
|
||||||
|
CORRECTION.
|
||||||
|
|
||||||
|
### 16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
|
||||||
|
CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||||
|
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
|
||||||
|
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
|
||||||
|
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
|
||||||
|
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
|
||||||
|
TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
|
||||||
|
PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
||||||
|
|
||||||
|
### 17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
## How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these
|
||||||
|
terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest to
|
||||||
|
attach them to the start of each source file to most effectively state
|
||||||
|
the exclusion of warranty; and each file should have at least the
|
||||||
|
"copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper
|
||||||
|
mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands \`show w' and \`show c' should show the
|
||||||
|
appropriate parts of the General Public License. Of course, your
|
||||||
|
program's commands might be different; for a GUI interface, you would
|
||||||
|
use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or
|
||||||
|
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||||
|
necessary. For more information on this, and how to apply and follow
|
||||||
|
the GNU GPL, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your
|
||||||
|
program into proprietary programs. If your program is a subroutine
|
||||||
|
library, you may consider it more useful to permit linking proprietary
|
||||||
|
applications with the library. If this is what you want to do, use the
|
||||||
|
GNU Lesser General Public License instead of this License. But first,
|
||||||
|
please read <https://www.gnu.org/licenses/why-not-lgpl.html>.
|
53
README.md
Normal file
53
README.md
Normal file
|
@ -0,0 +1,53 @@
|
||||||
|
# Libre-Chip server setup scripts
|
||||||
|
|
||||||
|
## Testing Locally
|
||||||
|
|
||||||
|
* Using `libvirt` (you can use the `virt-manager` gui frontend), create a VM with 6GB RAM and 4 CPUs and at least 30GB of disk space running Debian 12 with a btrfs root filesystem. The VM should be named `libre-chip.test`. Do *NOT* create a non-root user yet, that comes later.
|
||||||
|
|
||||||
|
* Install some packages in the VM:
|
||||||
|
```
|
||||||
|
apt install openssh-server sudo
|
||||||
|
```
|
||||||
|
|
||||||
|
* Copy your ssh public key from your user on the host (e.g. `~/.ssh/id_rsa.pub`) and put it in the VM's `/root/.ssh/authorized_keys` and make sure both that file and the parent `.ssh` directory have been chmod-ed to `600`.
|
||||||
|
|
||||||
|
* Get the IPv4 address of the VM:
|
||||||
|
```
|
||||||
|
ip addr
|
||||||
|
```
|
||||||
|
|
||||||
|
* Add the following lines to your *host's* `/etc/hosts`:
|
||||||
|
```
|
||||||
|
<public-IP-address-of-your-host> pebble
|
||||||
|
<IP-address-of-your-VM> libre-chip.test
|
||||||
|
<IP-address-of-your-VM> librechip.test
|
||||||
|
<IP-address-of-your-VM> mail.libre-chip.test
|
||||||
|
<IP-address-of-your-VM> mail.librechip.test
|
||||||
|
<IP-address-of-your-VM> git.libre-chip.test
|
||||||
|
<IP-address-of-your-VM> git.librechip.test
|
||||||
|
<IP-address-of-your-VM> forum.libre-chip.test
|
||||||
|
<IP-address-of-your-VM> forum.librechip.test
|
||||||
|
```
|
||||||
|
|
||||||
|
* (Optional) Create a non-root user with UID 1001, being careful to not use UID 1000 or GID 1000:
|
||||||
|
```
|
||||||
|
adduser --uid 1001 your-user-name
|
||||||
|
adduser your-user-name sudo
|
||||||
|
```
|
||||||
|
|
||||||
|
* logout from the VM but leave it running.
|
||||||
|
|
||||||
|
Create a snapshot of the VM while its running but no users are logged in, and name the snapshot `start`.
|
||||||
|
|
||||||
|
Now you're ready to test! Just run `./test-in-vm.sh` on the host, it will automatically reset the VM and login over ssh and run the setup script.
|
||||||
|
|
||||||
|
## Installing on the public server
|
||||||
|
|
||||||
|
***Not Tested Yet!***
|
||||||
|
|
||||||
|
Make sure the VM has no users with UID 1000, and that the VM has a btrfs root filesystem.
|
||||||
|
|
||||||
|
Run the setup script on the VM:
|
||||||
|
```
|
||||||
|
sudo ./setup.sh --production
|
||||||
|
```
|
72
docker-compose.yml
Normal file
72
docker-compose.yml
Normal file
|
@ -0,0 +1,72 @@
|
||||||
|
version: "3"
|
||||||
|
services:
|
||||||
|
watchtower:
|
||||||
|
image: containrrr/watchtower
|
||||||
|
restart: always
|
||||||
|
command: --label-enable
|
||||||
|
volumes:
|
||||||
|
- /var/run/docker.sock:/var/run/docker.sock
|
||||||
|
nginx:
|
||||||
|
image: nginx:bookworm
|
||||||
|
restart: always
|
||||||
|
volumes:
|
||||||
|
- ./nginx_templates:/etc/nginx/templates:ro
|
||||||
|
- /etc/letsencrypt:/etc/letsencrypt:ro
|
||||||
|
- /var/www/.well-known/acme-challenge:/var/www/.well-known/acme-challenge:ro
|
||||||
|
- /var/www/html:/var/www/html:ro
|
||||||
|
- /etc/ssl/certs:/etc/ssl/certs:ro
|
||||||
|
- /usr/local/share/ca-certificates:/usr/local/share/ca-certificates:ro
|
||||||
|
- /var/discourse/shared/standalone/:/forum
|
||||||
|
ports:
|
||||||
|
- "80:80"
|
||||||
|
- "443:443"
|
||||||
|
environment:
|
||||||
|
- BASE_DOMAIN_NAME=${BASE_DOMAIN_NAME}
|
||||||
|
- ALT_BASE_DOMAIN_NAME=${ALT_BASE_DOMAIN_NAME}
|
||||||
|
- DOLLAR=$$
|
||||||
|
- NGINX_ENVSUBST_OUTPUT_DIR=/etc/nginx
|
||||||
|
links:
|
||||||
|
- forgejo
|
||||||
|
- mail
|
||||||
|
labels:
|
||||||
|
- "com.centurylinklabs.watchtower.enable=true"
|
||||||
|
forgejo:
|
||||||
|
image: codeberg.org/forgejo/forgejo:7
|
||||||
|
restart: always
|
||||||
|
environment:
|
||||||
|
- USER_UID=1000
|
||||||
|
- USER_GID=1000
|
||||||
|
volumes:
|
||||||
|
- /var/lib/forgejo/:/data/git
|
||||||
|
- /etc/forgejo/:/data/gitea/conf
|
||||||
|
- /var/www/html:/var/www/html
|
||||||
|
- /etc/ssl/certs:/etc/ssl/certs:ro
|
||||||
|
- /usr/local/share/ca-certificates:/usr/local/share/ca-certificates:ro
|
||||||
|
expose:
|
||||||
|
- '3000'
|
||||||
|
ports:
|
||||||
|
- "127.0.0.1:2222:22"
|
||||||
|
links:
|
||||||
|
- mail:mail.${BASE_DOMAIN_NAME}
|
||||||
|
labels:
|
||||||
|
- "com.centurylinklabs.watchtower.enable=true"
|
||||||
|
mail:
|
||||||
|
image: stalwartlabs/mail-server:v0.8.4
|
||||||
|
# build:
|
||||||
|
# context: https://github.com/programmerjake/mail-server.git#fix-567
|
||||||
|
restart: always
|
||||||
|
expose:
|
||||||
|
- '80'
|
||||||
|
ports:
|
||||||
|
- '25:25'
|
||||||
|
- '465:465'
|
||||||
|
- '587:587'
|
||||||
|
- '993:993'
|
||||||
|
- '995:995'
|
||||||
|
volumes:
|
||||||
|
- /var/lib/stalwart-mail:/opt/stalwart-mail
|
||||||
|
- /etc/letsencrypt:/etc/letsencrypt:ro
|
||||||
|
- /etc/ssl/certs:/etc/ssl/certs:ro
|
||||||
|
- /usr/local/share/ca-certificates:/usr/local/share/ca-certificates:ro
|
||||||
|
# labels:
|
||||||
|
# - "com.centurylinklabs.watchtower.enable=true"
|
13
http_only_nginx_templates/default.conf.template
Normal file
13
http_only_nginx_templates/default.conf.template
Normal file
|
@ -0,0 +1,13 @@
|
||||||
|
server {
|
||||||
|
listen 80 default_server;
|
||||||
|
listen [::]:80 default_server;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
root /usr/share/nginx/html;
|
||||||
|
index index.html index.htm;
|
||||||
|
}
|
||||||
|
|
||||||
|
location /.well-known/acme-challenge {
|
||||||
|
root /var/www;
|
||||||
|
}
|
||||||
|
}
|
97
nginx_templates/conf.d/default.conf.template
Normal file
97
nginx_templates/conf.d/default.conf.template
Normal file
|
@ -0,0 +1,97 @@
|
||||||
|
server {
|
||||||
|
listen 80;
|
||||||
|
|
||||||
|
return 301 https://${DOLLAR}host${DOLLAR}request_uri;
|
||||||
|
}
|
||||||
|
|
||||||
|
server {
|
||||||
|
include /etc/nginx/ssl_listen.conf;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
error_page 404 /404.html;
|
||||||
|
root /var/www/html;
|
||||||
|
index index.html index.htm;
|
||||||
|
}
|
||||||
|
|
||||||
|
location /.well-known/acme-challenge {
|
||||||
|
root /var/www;
|
||||||
|
}
|
||||||
|
|
||||||
|
location ~ /\.(?!well-known).* {
|
||||||
|
return 404;
|
||||||
|
access_log off;
|
||||||
|
log_not_found off;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
server {
|
||||||
|
include /etc/nginx/ssl_listen.conf;
|
||||||
|
|
||||||
|
server_name git.${BASE_DOMAIN_NAME};
|
||||||
|
|
||||||
|
location /.well-known/acme-challenge {
|
||||||
|
root /var/www;
|
||||||
|
}
|
||||||
|
|
||||||
|
location / {
|
||||||
|
proxy_pass http://forgejo:3000;
|
||||||
|
|
||||||
|
proxy_set_header Connection ${DOLLAR}http_connection;
|
||||||
|
proxy_set_header Upgrade ${DOLLAR}http_upgrade;
|
||||||
|
proxy_set_header Host ${DOLLAR}host;
|
||||||
|
proxy_set_header X-Real-IP ${DOLLAR}remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For ${DOLLAR}proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto ${DOLLAR}scheme;
|
||||||
|
|
||||||
|
client_max_body_size 512M;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
server {
|
||||||
|
include /etc/nginx/ssl_listen.conf;
|
||||||
|
|
||||||
|
location /.well-known/acme-challenge {
|
||||||
|
root /var/www;
|
||||||
|
}
|
||||||
|
|
||||||
|
server_name mail.${BASE_DOMAIN_NAME};
|
||||||
|
location / {
|
||||||
|
proxy_pass http://mail:80;
|
||||||
|
|
||||||
|
proxy_set_header Connection ${DOLLAR}http_connection;
|
||||||
|
proxy_set_header Upgrade ${DOLLAR}http_upgrade;
|
||||||
|
proxy_set_header Host ${DOLLAR}host;
|
||||||
|
proxy_set_header X-Real-IP ${DOLLAR}remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For ${DOLLAR}proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto ${DOLLAR}scheme;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
server {
|
||||||
|
include /etc/nginx/ssl_listen.conf;
|
||||||
|
|
||||||
|
location /.well-known/acme-challenge {
|
||||||
|
root /var/www;
|
||||||
|
}
|
||||||
|
|
||||||
|
server_name forum.${BASE_DOMAIN_NAME};
|
||||||
|
location / {
|
||||||
|
proxy_pass http://unix:/forum/nginx.http.sock:;
|
||||||
|
|
||||||
|
proxy_http_version 1.1;
|
||||||
|
proxy_set_header Connection ${DOLLAR}http_connection;
|
||||||
|
proxy_set_header Upgrade ${DOLLAR}http_upgrade;
|
||||||
|
proxy_set_header Host ${DOLLAR}host;
|
||||||
|
proxy_set_header X-Real-IP ${DOLLAR}remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For ${DOLLAR}proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto ${DOLLAR}scheme;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
server {
|
||||||
|
include /etc/nginx/ssl_listen.conf;
|
||||||
|
|
||||||
|
server_name ~^(?<subdomain>.*)${ALT_BASE_DOMAIN_NAME}${DOLLAR};
|
||||||
|
return 301 https://${DOLLAR}{subdomain}${BASE_DOMAIN_NAME}${DOLLAR}request_uri;
|
||||||
|
}
|
||||||
|
|
14
nginx_templates/options-ssl-nginx.conf.template
Normal file
14
nginx_templates/options-ssl-nginx.conf.template
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
# This file contains important security parameters. If you modify this file
|
||||||
|
# manually, Certbot will be unable to automatically provide future security
|
||||||
|
# updates. Instead, Certbot will print and log an error message with a path to
|
||||||
|
# the up-to-date file that you will need to refer to when manually updating
|
||||||
|
# this file. Contents are based on https://ssl-config.mozilla.org
|
||||||
|
|
||||||
|
ssl_session_cache shared:le_nginx_SSL:10m;
|
||||||
|
ssl_session_timeout 1440m;
|
||||||
|
ssl_session_tickets off;
|
||||||
|
|
||||||
|
ssl_protocols TLSv1.2 TLSv1.3;
|
||||||
|
ssl_prefer_server_ciphers off;
|
||||||
|
|
||||||
|
ssl_ciphers "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384";
|
8
nginx_templates/ssl-dhparams.pem.template
Normal file
8
nginx_templates/ssl-dhparams.pem.template
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
-----BEGIN DH PARAMETERS-----
|
||||||
|
MIIBCAKCAQEA//////////+t+FRYortKmq/cViAnPTzx2LnFg84tNpWp4TZBFGQz
|
||||||
|
+8yTnc4kmz75fS/jY2MMddj2gbICrsRhetPfHtXV/WVhJDP1H18GbtCFY2VVPe0a
|
||||||
|
87VXE15/V8k1mE8McODmi3fipona8+/och3xWKE2rec1MKzKT0g6eXq8CrGCsyT7
|
||||||
|
YdEIqUuyyOP7uWrat2DX9GgdT0Kj3jlN9K5W7edjcrsZCwenyO4KbXCeAvzhzffi
|
||||||
|
7MA0BM0oNC9hkXL+nOmFg/+OTxIy7vKBg8P+OxtMb61zO7X8vC7CIAXFjvGDfRaD
|
||||||
|
ssbzSibBsu/6iGtCOGEoXJf//////////wIBAg==
|
||||||
|
-----END DH PARAMETERS-----
|
8
nginx_templates/ssl_listen.conf.template
Normal file
8
nginx_templates/ssl_listen.conf.template
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
listen 443 ssl;
|
||||||
|
|
||||||
|
http2 on;
|
||||||
|
|
||||||
|
ssl_certificate /etc/letsencrypt/live/server/fullchain.pem;
|
||||||
|
ssl_certificate_key /etc/letsencrypt/live/server/privkey.pem;
|
||||||
|
include /etc/nginx/options-ssl-nginx.conf;
|
||||||
|
ssl_dhparam /etc/nginx/ssl-dhparams.pem;
|
0
options-ssl-nginx.conf
Normal file
0
options-ssl-nginx.conf
Normal file
3
production.env
Normal file
3
production.env
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
ALT_BASE_DOMAIN_NAME='librechip.org'
|
||||||
|
BASE_DOMAIN_NAME='libre-chip.org'
|
||||||
|
ACME_SERVER_URL='https://acme-v02.api.letsencrypt.org/directory'
|
566
setup.sh
Executable file
566
setup.sh
Executable file
|
@ -0,0 +1,566 @@
|
||||||
|
#!/bin/bash
|
||||||
|
set -e
|
||||||
|
|
||||||
|
test_ca_list=()
|
||||||
|
case "$1" in
|
||||||
|
--test)
|
||||||
|
ln -sf test.env .env
|
||||||
|
test_ca_list=(test/certs/cur-root.crt test/certs/pebble.minica.pem)
|
||||||
|
;;
|
||||||
|
--production)
|
||||||
|
ln -sf production.env .env
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echo "usage: $0 --test|--production" >&2
|
||||||
|
exit 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
. .env
|
||||||
|
|
||||||
|
subdomains=('' mail git forum)
|
||||||
|
|
||||||
|
function fatal()
|
||||||
|
{
|
||||||
|
echo "fatal: $*" >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
function random_passwd()
|
||||||
|
{
|
||||||
|
tr -dc 'a-zA-Z0-9' < /dev/urandom | head -c 16
|
||||||
|
}
|
||||||
|
|
||||||
|
function wait_for_server()
|
||||||
|
{
|
||||||
|
local i
|
||||||
|
echo "waiting for server to start up..."
|
||||||
|
for i in {1..30}; do
|
||||||
|
sleep 1
|
||||||
|
if curl "http://$BASE_DOMAIN_NAME/" >/dev/null; then
|
||||||
|
echo "server up"
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
fatal "server failed to start up after $i attempts"
|
||||||
|
}
|
||||||
|
|
||||||
|
function retry_if_failed()
|
||||||
|
{
|
||||||
|
local retry error_args=": $*"
|
||||||
|
if [[ "$1" == "-q" ]]; then
|
||||||
|
error_args=""
|
||||||
|
shift
|
||||||
|
fi
|
||||||
|
for retry in {1..3}; do
|
||||||
|
if "$@"; then
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
echo "command failed (retry $retry)$error_args" >&2
|
||||||
|
sleep 2
|
||||||
|
done
|
||||||
|
fatal "command failed$error_args"
|
||||||
|
}
|
||||||
|
|
||||||
|
function forgejo()
|
||||||
|
{
|
||||||
|
docker run --rm codeberg.org/forgejo/forgejo:7 forgejo "$@"
|
||||||
|
}
|
||||||
|
|
||||||
|
if [[ "$(id -u)" != 0 ]]; then
|
||||||
|
fatal "must be ran as root"
|
||||||
|
fi
|
||||||
|
|
||||||
|
mkdir -p /var/lib/stalwart-mail
|
||||||
|
apt-get update -y -q
|
||||||
|
apt-get install jq -y -q
|
||||||
|
# force using overlay2 driver so btrfs snapshots will snapshot the entire system and not miss all the docker stuff
|
||||||
|
mkdir -p /etc/docker
|
||||||
|
if [[ -f /etc/docker/daemon.json ]]; then
|
||||||
|
[[ "$(jq -sc '[.[0]?["storage-driver"]?]' < /etc/docker/daemon.json)" == '["overlay2"]' ]] ||
|
||||||
|
fatal '/etc/docker/daemon.json exists but `storage-driver` is not set to overlay2'
|
||||||
|
elif [[ "$(dpkg-query -W --showformat='${db:Status-Abbrev}\n' docker.io 2> /dev/null)" =~ ^$|^.[nc]' '$ ]]; then
|
||||||
|
cat > /etc/docker/daemon.json <<EOF
|
||||||
|
{
|
||||||
|
"storage-driver": "overlay2"
|
||||||
|
}
|
||||||
|
EOF
|
||||||
|
else
|
||||||
|
fatal 'docker.io package is installed but `storage-driver` is not set to overlay2'
|
||||||
|
fi
|
||||||
|
apt-get install certbot docker-compose docker.io sudo openssl crudini git ssl-cert -y -q
|
||||||
|
if ((${#test_ca_list[@]})); then
|
||||||
|
install -m 644 "${test_ca_list[0]}" /usr/local/share/ca-certificates/test-root.crt
|
||||||
|
install -m 644 "${test_ca_list[1]}" /usr/local/share/ca-certificates/test-root2.crt
|
||||||
|
update-ca-certificates
|
||||||
|
fi
|
||||||
|
addgroup --gid=1000 git || true
|
||||||
|
[[ "$(getent group 1000)" =~ ^'git:x:1000:' ]] ||
|
||||||
|
fatal "some other group has gid 1000, which is needed for the git group"
|
||||||
|
adduser --system --shell=/bin/bash --gecos 'Git Version Control' --uid=1000 --ingroup=git --disabled-password --home=/var/lib/forgejo git || true
|
||||||
|
[[ "$(getent passwd 1000)" == 'git:x:1000:1000:Git Version Control,,,:/var/lib/forgejo:/bin/bash' ]] ||
|
||||||
|
fatal "some other user has gid 1000, which is needed for the git user"
|
||||||
|
[[ -f ~git/.ssh/id_ed25519 ]] || sudo -u git ssh-keygen -f ~git/.ssh/id_ed25519 -t ed25519 -C "Forgejo Host Key" -N ""
|
||||||
|
[[ -f ~git/.ssh/authorized_keys ]] || sudo -u git cat ~git/.ssh/id_ed25519.pub | sudo -u git tee ~git/.ssh/authorized_keys
|
||||||
|
sudo -u git chmod 600 ~git/.ssh/authorized_keys
|
||||||
|
cat <<"EOF" > /usr/local/bin/gitea
|
||||||
|
#!/bin/sh
|
||||||
|
exec ssh -p 2222 -o StrictHostKeyChecking=no git@127.0.0.1 "SSH_ORIGINAL_COMMAND=\"$SSH_ORIGINAL_COMMAND\" $0 $@"
|
||||||
|
EOF
|
||||||
|
chmod +x /usr/local/bin/gitea
|
||||||
|
mkdir -p /etc/forgejo
|
||||||
|
rm -rf /var/www/html
|
||||||
|
mkdir -p /var/www/html
|
||||||
|
chown git:git /var/www/html
|
||||||
|
chmod 775 /var/www/html
|
||||||
|
(cd /var/www/html && sudo -u git git init --no-initial-branch)
|
||||||
|
(cd /var/www/html && sudo -u git git remote add -t heads/rendered --mirror=fetch origin /data/git/repositories/libre-chip/website.git)
|
||||||
|
chown root:git /etc/forgejo
|
||||||
|
chmod 770 /etc/forgejo
|
||||||
|
if [[ ! -f /etc/forgejo/app.ini ]]; then
|
||||||
|
cat <<EOF > /etc/forgejo/app.ini
|
||||||
|
APP_NAME = Libre-Chip.org
|
||||||
|
RUN_MODE = prod
|
||||||
|
RUN_USER = git
|
||||||
|
WORK_PATH = /data/gitea
|
||||||
|
|
||||||
|
[repository]
|
||||||
|
ROOT = /data/git/repositories
|
||||||
|
|
||||||
|
[repository.local]
|
||||||
|
LOCAL_COPY_PATH = /data/gitea/tmp/local-repo
|
||||||
|
|
||||||
|
[repository.upload]
|
||||||
|
TEMP_PATH = /data/gitea/uploads
|
||||||
|
|
||||||
|
[server]
|
||||||
|
APP_DATA_PATH = /data/gitea
|
||||||
|
DOMAIN = git.$BASE_DOMAIN_NAME
|
||||||
|
SSH_DOMAIN = git.$BASE_DOMAIN_NAME
|
||||||
|
HTTP_PORT = 3000
|
||||||
|
ROOT_URL = https://git.$BASE_DOMAIN_NAME/
|
||||||
|
DISABLE_SSH = false
|
||||||
|
SSH_PORT = 22
|
||||||
|
SSH_LISTEN_PORT = 22
|
||||||
|
LFS_START_SERVER = true
|
||||||
|
OFFLINE_MODE = false
|
||||||
|
LFS_JWT_SECRET = $(forgejo generate secret LFS_JWT_SECRET)
|
||||||
|
|
||||||
|
[database]
|
||||||
|
PATH = /data/gitea/gitea.db
|
||||||
|
DB_TYPE = sqlite3
|
||||||
|
HOST = localhost:3306
|
||||||
|
NAME = gitea
|
||||||
|
USER = root
|
||||||
|
PASSWD =
|
||||||
|
LOG_SQL = false
|
||||||
|
SCHEMA =
|
||||||
|
SSL_MODE = disable
|
||||||
|
|
||||||
|
[indexer]
|
||||||
|
ISSUE_INDEXER_PATH = /data/gitea/indexers/issues.bleve
|
||||||
|
|
||||||
|
[session]
|
||||||
|
PROVIDER_CONFIG = /data/gitea/sessions
|
||||||
|
PROVIDER = file
|
||||||
|
|
||||||
|
[picture]
|
||||||
|
AVATAR_UPLOAD_PATH = /data/gitea/avatars
|
||||||
|
REPOSITORY_AVATAR_UPLOAD_PATH = /data/gitea/repo-avatars
|
||||||
|
|
||||||
|
[attachment]
|
||||||
|
PATH = /data/gitea/attachments
|
||||||
|
|
||||||
|
[log]
|
||||||
|
MODE = console
|
||||||
|
LEVEL = info
|
||||||
|
ROOT_PATH = /data/gitea/log
|
||||||
|
|
||||||
|
[security]
|
||||||
|
INSTALL_LOCK = true
|
||||||
|
SECRET_KEY = $(forgejo generate secret SECRET_KEY)
|
||||||
|
REVERSE_PROXY_LIMIT = 1
|
||||||
|
REVERSE_PROXY_TRUSTED_PROXIES = *
|
||||||
|
PASSWORD_HASH_ALGO = pbkdf2_hi
|
||||||
|
DISABLE_GIT_HOOKS = false
|
||||||
|
INTERNAL_TOKEN = $(forgejo generate secret INTERNAL_TOKEN)
|
||||||
|
|
||||||
|
[service]
|
||||||
|
DISABLE_REGISTRATION = false
|
||||||
|
REQUIRE_SIGNIN_VIEW = false
|
||||||
|
REGISTER_EMAIL_CONFIRM = true
|
||||||
|
ENABLE_NOTIFY_MAIL = true
|
||||||
|
ALLOW_ONLY_EXTERNAL_REGISTRATION = false
|
||||||
|
ENABLE_CAPTCHA = true
|
||||||
|
DEFAULT_KEEP_EMAIL_PRIVATE = false
|
||||||
|
DEFAULT_ALLOW_CREATE_ORGANIZATION = false
|
||||||
|
DEFAULT_ENABLE_TIMETRACKING = true
|
||||||
|
NO_REPLY_ADDRESS = noreply.$BASE_DOMAIN_NAME
|
||||||
|
|
||||||
|
[lfs]
|
||||||
|
PATH = /data/git/lfs
|
||||||
|
|
||||||
|
[mailer]
|
||||||
|
ENABLED = true
|
||||||
|
PROTOCOL = smtps
|
||||||
|
SMTP_ADDR = mail.$BASE_DOMAIN_NAME
|
||||||
|
SMTP_PORT = 465
|
||||||
|
FROM = forgejo@$BASE_DOMAIN_NAME
|
||||||
|
USER = forgejo
|
||||||
|
PASSWD = $(random_passwd)
|
||||||
|
|
||||||
|
[openid]
|
||||||
|
ENABLE_OPENID_SIGNIN = true
|
||||||
|
ENABLE_OPENID_SIGNUP = true
|
||||||
|
|
||||||
|
[cron.update_checker]
|
||||||
|
ENABLED = false
|
||||||
|
|
||||||
|
[repository.pull-request]
|
||||||
|
DEFAULT_MERGE_STYLE = merge
|
||||||
|
|
||||||
|
[repository.signing]
|
||||||
|
DEFAULT_TRUST_MODEL = committer
|
||||||
|
|
||||||
|
[ssh.minimum_key_sizes]
|
||||||
|
RSA = 2047
|
||||||
|
|
||||||
|
[oauth2]
|
||||||
|
JWT_SECRET = $(forgejo generate secret JWT_SECRET)
|
||||||
|
EOF
|
||||||
|
chown root:git /etc/forgejo/app.ini
|
||||||
|
chmod 640 /etc/forgejo/app.ini
|
||||||
|
fi
|
||||||
|
mkdir -p /var/lib/stalwart-mail/etc
|
||||||
|
mail_passwd=""
|
||||||
|
mail_passwd_hash=""
|
||||||
|
if [[ ! -f /var/lib/stalwart-mail/etc/config.toml ]]; then
|
||||||
|
mail_passwd="$(random_passwd)"
|
||||||
|
cat > /var/lib/stalwart-mail/cli.sh <<EOF
|
||||||
|
mail_passwd="$mail_passwd"
|
||||||
|
function stalwart-cli()
|
||||||
|
{
|
||||||
|
(cd $(pwd) && CREDENTIALS="admin:$mail_passwd" exec docker-compose -p server exec -T -e CREDENTIALS mail stalwart-cli -u "http://localhost" "\$@")
|
||||||
|
}
|
||||||
|
EOF
|
||||||
|
chmod 500 /var/lib/stalwart-mail/cli.sh
|
||||||
|
mail_passwd_hash="$(echo -n "$mail_passwd" | openssl passwd -6 -stdin)"
|
||||||
|
cat > /var/lib/stalwart-mail/etc/config.toml <<EOF
|
||||||
|
[server.listener."smtp"]
|
||||||
|
bind = ["[::]:25"]
|
||||||
|
protocol = "smtp"
|
||||||
|
|
||||||
|
[server.listener."submission"]
|
||||||
|
bind = ["[::]:587"]
|
||||||
|
protocol = "smtp"
|
||||||
|
|
||||||
|
[server.listener."submissions"]
|
||||||
|
bind = ["[::]:465"]
|
||||||
|
protocol = "smtp"
|
||||||
|
tls.implicit = true
|
||||||
|
|
||||||
|
[server.listener."imaptls"]
|
||||||
|
bind = ["[::]:993"]
|
||||||
|
protocol = "imap"
|
||||||
|
tls.implicit = true
|
||||||
|
|
||||||
|
[server.listener.pop3s]
|
||||||
|
bind = "[::]:995"
|
||||||
|
protocol = "pop3"
|
||||||
|
tls.implicit = true
|
||||||
|
|
||||||
|
[server.listener.http]
|
||||||
|
protocol = "http"
|
||||||
|
bind = "[::]:80"
|
||||||
|
|
||||||
|
[server.http]
|
||||||
|
use-x-forwarded = true
|
||||||
|
|
||||||
|
[certificate.default]
|
||||||
|
cert = "%{file:/etc/letsencrypt/live/server/fullchain.pem}%"
|
||||||
|
private-key = "%{file:/etc/letsencrypt/live/server/privkey.pem}%"
|
||||||
|
default = true
|
||||||
|
|
||||||
|
[storage]
|
||||||
|
data = "rocksdb"
|
||||||
|
fts = "rocksdb"
|
||||||
|
blob = "rocksdb"
|
||||||
|
lookup = "rocksdb"
|
||||||
|
directory = "internal"
|
||||||
|
|
||||||
|
[store.rocksdb]
|
||||||
|
type = "rocksdb"
|
||||||
|
path = "/opt/stalwart-mail/data"
|
||||||
|
compression = "lz4"
|
||||||
|
|
||||||
|
[directory.internal]
|
||||||
|
type = "internal"
|
||||||
|
store = "rocksdb"
|
||||||
|
|
||||||
|
[tracer.log]
|
||||||
|
type = "log"
|
||||||
|
level = "info"
|
||||||
|
path = "/opt/stalwart-mail/logs"
|
||||||
|
prefix = "stalwart.log"
|
||||||
|
rotate = "daily"
|
||||||
|
ansi = false
|
||||||
|
enable = true
|
||||||
|
|
||||||
|
[authentication.fallback-admin]
|
||||||
|
user = "admin"
|
||||||
|
secret = "$mail_passwd_hash"
|
||||||
|
|
||||||
|
[lookup.default]
|
||||||
|
hostname = "mail.$BASE_DOMAIN_NAME"
|
||||||
|
|
||||||
|
[session.auth]
|
||||||
|
must-match-sender = [ {if = "authenticated_as == 'forum-noreply'", then = false},
|
||||||
|
{else = true} ]
|
||||||
|
EOF
|
||||||
|
chmod 600 /var/lib/stalwart-mail/etc/config.toml
|
||||||
|
fi
|
||||||
|
. /var/lib/stalwart-mail/cli.sh
|
||||||
|
if [[ ! -f /var/discourse/containers/app.yml ]]; then
|
||||||
|
if [[ ! -d /var/discourse/containers ]]; then
|
||||||
|
git clone https://github.com/discourse/discourse_docker.git /var/discourse
|
||||||
|
chmod 700 /var/discourse/containers
|
||||||
|
fi
|
||||||
|
forum_smtp_passwd="$(random_passwd)"
|
||||||
|
cat > /var/discourse/containers/app.yml <<EOF
|
||||||
|
## this is the all-in-one, standalone Discourse Docker container template
|
||||||
|
##
|
||||||
|
## After making changes to this file, you MUST rebuild
|
||||||
|
## /var/discourse/launcher rebuild app
|
||||||
|
##
|
||||||
|
## Based on https://meta.discourse.org/t/run-other-websites-on-the-same-machine-as-discourse/17247
|
||||||
|
|
||||||
|
templates:
|
||||||
|
- "templates/postgres.template.yml"
|
||||||
|
- "templates/redis.template.yml"
|
||||||
|
- "templates/web.template.yml"
|
||||||
|
## Uncomment the next line to enable the IPv6 listener
|
||||||
|
#- "templates/web.ipv6.template.yml"
|
||||||
|
- "templates/web.ratelimited.template.yml"
|
||||||
|
- "templates/web.socketed.template.yml"
|
||||||
|
## Uncomment these two lines if you wish to add Lets Encrypt (https)
|
||||||
|
#- "templates/web.ssl.template.yml"
|
||||||
|
#- "templates/web.letsencrypt.ssl.template.yml"
|
||||||
|
|
||||||
|
## which TCP/IP ports should this container expose?
|
||||||
|
## If you want Discourse to share a port with another webserver like Apache or nginx,
|
||||||
|
## see https://meta.discourse.org/t/17247 for details
|
||||||
|
#expose:
|
||||||
|
# - "80:80" # http
|
||||||
|
# - "443:443" # https
|
||||||
|
|
||||||
|
params:
|
||||||
|
db_default_text_search_config: "pg_catalog.english"
|
||||||
|
|
||||||
|
## Set db_shared_buffers to a max of 25% of the total memory.
|
||||||
|
## will be set automatically by bootstrap based on detected RAM, or you can override
|
||||||
|
db_shared_buffers: "512MB"
|
||||||
|
|
||||||
|
## can improve sorting performance, but adds memory usage per-connection
|
||||||
|
#db_work_mem: "40MB"
|
||||||
|
|
||||||
|
## Which Git revision should this container use? (default: tests-passed)
|
||||||
|
#version: tests-passed
|
||||||
|
|
||||||
|
env:
|
||||||
|
LC_ALL: en_US.UTF-8
|
||||||
|
LANG: en_US.UTF-8
|
||||||
|
LANGUAGE: en_US.UTF-8
|
||||||
|
# DISCOURSE_DEFAULT_LOCALE: en
|
||||||
|
|
||||||
|
## How many concurrent web requests are supported? Depends on memory and CPU cores.
|
||||||
|
## will be set automatically by bootstrap based on detected CPUs, or you can override
|
||||||
|
UNICORN_WORKERS: 4
|
||||||
|
|
||||||
|
## TODO: The domain name this Discourse instance will respond to
|
||||||
|
## Required. Discourse will not work with a bare IP number.
|
||||||
|
DISCOURSE_HOSTNAME: forum.${BASE_DOMAIN_NAME}
|
||||||
|
|
||||||
|
## Uncomment if you want the container to be started with the same
|
||||||
|
## hostname (-h option) as specified above (default "\$hostname-\$config")
|
||||||
|
#DOCKER_USE_HOSTNAME: true
|
||||||
|
|
||||||
|
## TODO: List of comma delimited emails that will be made admin and developer
|
||||||
|
## on initial signup example 'user1@example.com,user2@example.com'
|
||||||
|
DISCOURSE_DEVELOPER_EMAILS: 'postmaster@${BASE_DOMAIN_NAME}'
|
||||||
|
|
||||||
|
## TODO: The SMTP mail server used to validate new accounts and send notifications
|
||||||
|
# SMTP ADDRESS, username, and password are required
|
||||||
|
# WARNING the char '#' in SMTP password can cause problems!
|
||||||
|
DISCOURSE_SMTP_ADDRESS: ${BASE_DOMAIN_NAME}
|
||||||
|
DISCOURSE_SMTP_PORT: 587
|
||||||
|
DISCOURSE_SMTP_USER_NAME: forum-noreply
|
||||||
|
DISCOURSE_SMTP_PASSWORD: "${forum_smtp_passwd}"
|
||||||
|
#DISCOURSE_SMTP_ENABLE_START_TLS: true # (optional, default true)
|
||||||
|
DISCOURSE_SMTP_DOMAIN: ${BASE_DOMAIN_NAME}
|
||||||
|
DISCOURSE_NOTIFICATION_EMAIL: forum-noreply@${BASE_DOMAIN_NAME}
|
||||||
|
|
||||||
|
## If you added the Lets Encrypt template, uncomment below to get a free SSL certificate
|
||||||
|
#LETSENCRYPT_ACCOUNT_EMAIL: me@example.com
|
||||||
|
|
||||||
|
## The http or https CDN address for this Discourse instance (configured to pull)
|
||||||
|
## see https://meta.discourse.org/t/14857 for details
|
||||||
|
#DISCOURSE_CDN_URL: https://discourse-cdn.example.com
|
||||||
|
|
||||||
|
## The maxmind geolocation IP account ID and license key for IP address lookups
|
||||||
|
## see https://meta.discourse.org/t/-/173941 for details
|
||||||
|
#DISCOURSE_MAXMIND_ACCOUNT_ID: 123456
|
||||||
|
#DISCOURSE_MAXMIND_LICENSE_KEY: 1234567890123456
|
||||||
|
|
||||||
|
## The Docker container is stateless; all data is stored in /shared
|
||||||
|
volumes:
|
||||||
|
- volume:
|
||||||
|
host: /var/discourse/shared/standalone
|
||||||
|
guest: /shared
|
||||||
|
- volume:
|
||||||
|
host: /var/discourse/shared/standalone/log/var-log
|
||||||
|
guest: /var/log
|
||||||
|
- volume:
|
||||||
|
host: /usr/local/share/ca-certificates
|
||||||
|
guest: /usr/local/share/ca-certificates:ro
|
||||||
|
|
||||||
|
## Plugins go here
|
||||||
|
## see https://meta.discourse.org/t/19157 for details
|
||||||
|
hooks:
|
||||||
|
after_code:
|
||||||
|
- exec:
|
||||||
|
cd: \$home/plugins
|
||||||
|
cmd:
|
||||||
|
- git clone https://github.com/discourse/docker_manager.git
|
||||||
|
|
||||||
|
## Any custom commands to run after building
|
||||||
|
run:
|
||||||
|
- exec: echo "Beginning of custom commands"
|
||||||
|
- exec: |-
|
||||||
|
if rails r 'exit(1) if User.find_by_email("postmaster@${BASE_DOMAIN_NAME}")'; then
|
||||||
|
rails r "SiteSetting.pop3_polling_openssl_verify = false" || exit
|
||||||
|
rails site_settings:import <<EOF2 || exit
|
||||||
|
---
|
||||||
|
title: Libre-Chip Forum
|
||||||
|
exclude_rel_nofollow_domains: ${BASE_DOMAIN_NAME}
|
||||||
|
share_links: email
|
||||||
|
share_quote_buttons: email
|
||||||
|
default_dark_mode_color_scheme_id: '1'
|
||||||
|
enable_badges: 'false'
|
||||||
|
pending_users_reminder_delay_minutes: '5'
|
||||||
|
title_prettify: 'false'
|
||||||
|
title_fancy_entities: 'false'
|
||||||
|
enable_markdown_typographer: 'false'
|
||||||
|
highlighted_languages: bash|c|cpp|csharp|css|diff|ini|javascript|json|lua|makefile|markdown|plaintext|python|python-repl|rust|shell|typescript|xml|yaml|wasm|llvm|coq|x86asm|verilog|vhdl|scala
|
||||||
|
enable_emoji_shortcuts: 'false'
|
||||||
|
reply_by_email_address: forum+%{reply_key}@${BASE_DOMAIN_NAME}
|
||||||
|
pop3_polling_period_mins: '1'
|
||||||
|
pop3_polling_host: ${BASE_DOMAIN_NAME}
|
||||||
|
pop3_polling_username: forum
|
||||||
|
pop3_polling_password: ${forum_smtp_passwd}
|
||||||
|
pop3_polling_enabled: 'true'
|
||||||
|
reply_by_email_enabled: 'true'
|
||||||
|
log_mail_processing_failures: 'true'
|
||||||
|
email_in: 'true'
|
||||||
|
email_in_allowed_groups: 1|2|0
|
||||||
|
default_trust_level: '1'
|
||||||
|
force_https: 'true'
|
||||||
|
moderators_manage_categories_and_groups: 'true'
|
||||||
|
moderators_view_emails: 'true'
|
||||||
|
allowed_iframes: https://www.google.com/maps/embed?|https://www.openstreetmap.org/export/embed.html?|https://calendar.google.com/calendar/embed?|https://codepen.io/|http://forum.${BASE_DOMAIN_NAME}/discobot/certificate.svg|https://forum.${BASE_DOMAIN_NAME}/discobot/certificate.svg
|
||||||
|
default_navigation_menu_categories: 2|3|4
|
||||||
|
automatic_backups_enabled: 'false'
|
||||||
|
sequential_replies_threshold: '4'
|
||||||
|
get_a_room_threshold: '10000'
|
||||||
|
default_composer_category: '4'
|
||||||
|
share_anonymized_statistics: 'false'
|
||||||
|
default_email_mailing_list_mode: 'true'
|
||||||
|
disable_mailing_list_mode: 'false'
|
||||||
|
enable_offline_indicator: 'true'
|
||||||
|
chat_enabled: 'false'
|
||||||
|
EOF2
|
||||||
|
rails r "SiteSetting.pop3_polling_openssl_verify = true" || exit
|
||||||
|
rails r - <<EOF2 || exit
|
||||||
|
u = User.new
|
||||||
|
u.email = "postmaster@${BASE_DOMAIN_NAME}"
|
||||||
|
u.username = "postmaster"
|
||||||
|
u.password = "$mail_passwd"
|
||||||
|
u.name = "Admin User"
|
||||||
|
u.save!
|
||||||
|
u.active = true
|
||||||
|
u.save!
|
||||||
|
u.grant_admin!
|
||||||
|
u.change_trust_level!(1) if u.trust_level < 1
|
||||||
|
u.email_tokens.update_all confirmed: true
|
||||||
|
u.activate
|
||||||
|
EOF2
|
||||||
|
fi
|
||||||
|
- file:
|
||||||
|
path: /etc/runit/1.d/000-update-certificates
|
||||||
|
chmod: "+x"
|
||||||
|
contents: |
|
||||||
|
#!/bin/bash
|
||||||
|
exec update-ca-certificates
|
||||||
|
- exec: echo "End of custom commands"
|
||||||
|
EOF
|
||||||
|
chmod 400 /var/discourse/containers/app.yml
|
||||||
|
fi
|
||||||
|
wd="$(pwd)"
|
||||||
|
if ! [[ "$wd" =~ ^/[-/a-zA-Z0-9_]*$ ]]; then
|
||||||
|
fatal "invalid characters in current directory: $wd"
|
||||||
|
fi
|
||||||
|
nginx_container="$(docker create --rm -v /var/www/.well-known/acme-challenge:/var/www/.well-known/acme-challenge:ro -v "$wd"/http_only_nginx_templates:/etc/nginx/templates:ro -p 80:80 nginx:bookworm)"
|
||||||
|
docker start "$nginx_container"
|
||||||
|
trap 'docker stop "$nginx_container"' EXIT
|
||||||
|
echo "waiting for server to come up..."
|
||||||
|
for _ in {0..30}; do
|
||||||
|
sleep 1
|
||||||
|
if curl "http://$BASE_DOMAIN_NAME/" >/dev/null; then
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
echo "server up"
|
||||||
|
certbot_args=(certonly -n --email "postmaster@$BASE_DOMAIN_NAME" "--server=$ACME_SERVER_URL" --cert-name server --agree-tos --webroot --webroot-path /var/www)
|
||||||
|
certbot_args+=(--disable-hook-validation --post-hook "cd '$wd' && docker-compose -p server restart")
|
||||||
|
for subdomain in "${subdomains[@]}"; do
|
||||||
|
if [[ -n "$subdomain" ]]; then
|
||||||
|
subdomain+=.
|
||||||
|
fi
|
||||||
|
certbot_args+=(-d "$subdomain$BASE_DOMAIN_NAME")
|
||||||
|
certbot_args+=(-d "$subdomain$ALT_BASE_DOMAIN_NAME")
|
||||||
|
done
|
||||||
|
retry_if_failed certbot "${certbot_args[@]}"
|
||||||
|
trap EXIT
|
||||||
|
docker stop "$nginx_container"
|
||||||
|
DOCKER_BUILDKIT=1 docker-compose -p server up -d
|
||||||
|
sleep 1
|
||||||
|
if [[ -n "$mail_passwd_hash" ]]; then
|
||||||
|
forgejo_smtp_passwd="$(crudini --get /etc/forgejo/app.ini mailer PASSWD)"
|
||||||
|
stalwart-cli domain create "$BASE_DOMAIN_NAME"
|
||||||
|
curl -u "admin:$mail_passwd" "https://mail.$BASE_DOMAIN_NAME/api/dkim" --data-binary '{"id":null,"algorithm":"Ed25519","domain":"'"$BASE_DOMAIN_NAME"'","selector":null}' > /dev/null
|
||||||
|
curl -u "admin:$mail_passwd" "https://mail.$BASE_DOMAIN_NAME/api/dkim" --data-binary '{"id":null,"algorithm":"Rsa","domain":"'"$BASE_DOMAIN_NAME"'","selector":null}' > /dev/null
|
||||||
|
stalwart-cli account create -d 'Admin Account' -i true -a "postmaster@$BASE_DOMAIN_NAME" 'admin' "$mail_passwd"
|
||||||
|
stalwart-cli account create -d 'Forgejo Server' -i false -a "forgejo@$BASE_DOMAIN_NAME" 'forgejo' "$forgejo_smtp_passwd"
|
||||||
|
add_postmaster=(docker-compose -p server exec -T -u git forgejo forgejo admin user create --admin --username postmaster --password "$mail_passwd" --email "postmaster@$BASE_DOMAIN_NAME")
|
||||||
|
retry_if_failed -q "${add_postmaster[@]}"
|
||||||
|
forum_smtp_passwd="$(sed 's/^ *DISCOURSE_SMTP_PASSWORD: "*\([^"]*\)"$/\1/p; d' < /var/discourse/containers/app.yml)"
|
||||||
|
[[ -n "$forum_smtp_passwd" ]] || fatal "can't parse smtp password out of /var/discourse/containers/app.yml"
|
||||||
|
stalwart-cli account create -d 'Forum Replies' -i false -a "@$BASE_DOMAIN_NAME" 'forum' "$forum_smtp_passwd"
|
||||||
|
stalwart-cli account create -d 'Forum Notifications' -i false -a "forum-noreply@$BASE_DOMAIN_NAME" 'forum-noreply' "$forum_smtp_passwd"
|
||||||
|
forgejo_api=(retry_if_failed -q curl --fail-with-body -u "postmaster:$mail_passwd" -H 'Accept: application/json' -H 'Content-Type: application/json')
|
||||||
|
"${forgejo_api[@]}" -X 'POST' "https://git.$BASE_DOMAIN_NAME/api/v1/orgs" -d '{"username": "libre-chip"}' > /dev/null
|
||||||
|
"${forgejo_api[@]}" -X 'POST' "https://git.$BASE_DOMAIN_NAME/api/v1/orgs/libre-chip/repos" -d '{"name": "website"}' > /dev/null
|
||||||
|
post_receive_hook="$(jq -csR '{content:.}' <<'EOF'
|
||||||
|
#!/bin/bash
|
||||||
|
set -e
|
||||||
|
cd /var/www/html
|
||||||
|
env -i PATH="$PATH" git fetch
|
||||||
|
env -i PATH="$PATH" git checkout -q --detach rendered
|
||||||
|
EOF
|
||||||
|
)"
|
||||||
|
"${forgejo_api[@]}" -X 'PATCH' "https://git.$BASE_DOMAIN_NAME/api/v1/repos/libre-chip/website/hooks/git/post-receive" -d "$post_receive_hook" > /dev/null
|
||||||
|
fi
|
||||||
|
(
|
||||||
|
cd /var/discourse
|
||||||
|
# must run after starting mail server since it validates POP3
|
||||||
|
./launcher bootstrap app
|
||||||
|
./launcher start app
|
||||||
|
)
|
51
test-in-vm.sh
Executable file
51
test-in-vm.sh
Executable file
|
@ -0,0 +1,51 @@
|
||||||
|
#!/bin/bash
|
||||||
|
set -e
|
||||||
|
mkdir -p test-in-vm
|
||||||
|
if [[ ! -f test/certs/pebble.minica.pem ]]; then
|
||||||
|
if ! which minica > /dev/null; then
|
||||||
|
cat <<'EOF' >&2
|
||||||
|
minica is not installed; install by following:
|
||||||
|
https://github.com/jsha/minica/blob/v1.1.0/README.md#installation
|
||||||
|
and ensuring ~/go/bin is in your PATH.
|
||||||
|
Do *not* use the minica from apt/apt-get, that is a completely separate program.
|
||||||
|
EOF
|
||||||
|
exit 1
|
||||||
|
elif [[ "$(minica --help 2>&1)" =~ $'\n'' '*'-domains ' ]]; then
|
||||||
|
(cd test/certs; minica -ca-alg RSA -ca-cert pebble.minica.pem -ca-key pebble.minica.key.pem -domains localhost,pebble -ip-addresses 127.0.0.1)
|
||||||
|
else
|
||||||
|
cat <<'EOF' >&2
|
||||||
|
you have the wrong minica installed; run `sudo apt uninstall minica` then
|
||||||
|
install the correct one by following:
|
||||||
|
https://github.com/jsha/minica/blob/v1.1.0/README.md#installation
|
||||||
|
and ensuring ~/go/bin is in your PATH.
|
||||||
|
Do *not* use the minica from apt/apt-get, that is a completely separate program.
|
||||||
|
EOF
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
if ! which pebble > /dev/null; then
|
||||||
|
cat <<'EOF' >&2
|
||||||
|
pebble is not installed; install either using `sudo apt install pebble` or by following:
|
||||||
|
https://github.com/letsencrypt/pebble/blob/v2.6.0/README.md#install
|
||||||
|
and ensuring ~/go/bin is in your PATH.
|
||||||
|
EOF
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
PEBBLE_VA_NOSLEEP=1 pebble -config test/config/pebble-config.json -strict false&
|
||||||
|
# intentionally capture the PID now, since otherwise it will be lost by the time the trap runs
|
||||||
|
# shellcheck disable=SC2064
|
||||||
|
trap "kill $!" EXIT
|
||||||
|
sleep 1
|
||||||
|
CURL_CA_BUNDLE=test/certs/pebble.minica.pem curl https://127.0.0.1:15000/roots/0 -o test/certs/cur-root.crt
|
||||||
|
rm -f test-in-vm/index
|
||||||
|
GIT_INDEX_FILE=test-in-vm/index git add .
|
||||||
|
GIT_INDEX_FILE=test-in-vm/index git add -f test/certs/pebble.minica.pem test/certs/cur-root.crt
|
||||||
|
commit_tree="$(GIT_INDEX_FILE=test-in-vm/index git write-tree)"
|
||||||
|
commit="$(git commit-tree -m "commit created by test-in-vm.sh" "$commit_tree")"
|
||||||
|
echo "commit: $commit"
|
||||||
|
virsh snapshot-revert libre-chip.test --snapshotname start
|
||||||
|
sleep 1
|
||||||
|
ssh root@libre-chip.test bash -c ':; hwclock --hctosys; rm -rf ~/test-in-vm; mkdir ~/test-in-vm; cd ~/test-in-vm; git init'
|
||||||
|
git push root@libre-chip.test:test-in-vm "$commit":refs/tags/test-in-vm
|
||||||
|
ssh root@libre-chip.test bash -c ':; cd ~/test-in-vm; git checkout test-in-vm; ./setup.sh --test'
|
||||||
|
read -p 'press enter to terminate acme server and exit'
|
4
test.env
Normal file
4
test.env
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
ALT_BASE_DOMAIN_NAME='librechip.test'
|
||||||
|
BASE_DOMAIN_NAME='libre-chip.test'
|
||||||
|
ACME_SERVER_URL='https://pebble:14000/dir'
|
||||||
|
PEBBLE_CA_BUNDLE='test/certs/pebble.minica.pem'
|
3
test/certs/.gitignore
vendored
Normal file
3
test/certs/.gitignore
vendored
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
*
|
||||||
|
!/.gitignore
|
||||||
|
!/README.md
|
25
test/certs/README.md
Normal file
25
test/certs/README.md
Normal file
|
@ -0,0 +1,25 @@
|
||||||
|
# certs/
|
||||||
|
|
||||||
|
This directory contains a CA certificate (`pebble.minica.pem`) and a private key
|
||||||
|
(`pebble.minica.key.pem`) that are used to issue a end-entity certificate (See
|
||||||
|
`certs/localhost`) for the Pebble HTTPS server.
|
||||||
|
|
||||||
|
To get your **testing code** to use Pebble without HTTPS errors you should
|
||||||
|
configure your ACME client to trust the `pebble.minica.pem` CA certificate. Your
|
||||||
|
ACME client should offer a runtime option to specify a list of root CAs that you
|
||||||
|
can configure to include the `pebble.minica.pem` file.
|
||||||
|
|
||||||
|
**Do not** add this CA certificate to the system trust store or in production
|
||||||
|
code!!! The CA's private key is **public** and anyone can use it to issue
|
||||||
|
certificates that will be trusted by a system with the Pebble CA in the trust
|
||||||
|
store.
|
||||||
|
|
||||||
|
To re-create all of the Pebble certificates run:
|
||||||
|
|
||||||
|
minica -ca-cert pebble.minica.pem \
|
||||||
|
-ca-key pebble.minica.key.pem \
|
||||||
|
-domains localhost,pebble \
|
||||||
|
-ip-addresses 127.0.0.1
|
||||||
|
|
||||||
|
From the `test/certs/` directory after [installing
|
||||||
|
MiniCA](https://github.com/jsha/minica#installation)
|
18
test/config/pebble-config.json
Normal file
18
test/config/pebble-config.json
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
{
|
||||||
|
"pebble": {
|
||||||
|
"listenAddress": "0.0.0.0:14000",
|
||||||
|
"managementListenAddress": "0.0.0.0:15000",
|
||||||
|
"certificate": "test/certs/localhost/cert.pem",
|
||||||
|
"privateKey": "test/certs/localhost/key.pem",
|
||||||
|
"httpPort": 80,
|
||||||
|
"tlsPort": 443,
|
||||||
|
"ocspResponderURL": "",
|
||||||
|
"externalAccountBindingRequired": false,
|
||||||
|
"domainBlocklist": [],
|
||||||
|
"retryAfter": {
|
||||||
|
"authz": 3,
|
||||||
|
"order": 5
|
||||||
|
},
|
||||||
|
"certificateValidityPeriod": 6000
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in a new issue