forked from toolshed/docs.coopcloud.tech
Compare commits
295
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6151e1845a | ||
|
|
d04478fedb | ||
|
|
132cea798d | ||
|
|
a450b19796 | ||
|
|
4f827af4d4
|
||
|
|
788e1abd63
|
||
|
|
4ec8c3481c | ||
|
|
0d70e80830 | ||
|
|
5e9b2bf7af | ||
|
|
50e9ff89df | ||
|
|
be29c344bb
|
||
|
|
8d641a620a | ||
|
|
acae9a51b2 | ||
|
|
fcc663c5cf | ||
|
|
37be3ef096
|
||
|
|
b4a8ea1291
|
||
|
|
50bef0416e
|
||
|
|
f227a8d212
|
||
|
|
743394d2ab
|
||
|
|
8d3f7f7a22
|
||
|
|
47c1dc8ca3 | ||
|
|
4ec58bf9d4 | ||
|
|
1096793c24 | ||
|
|
692b0892cb | ||
|
|
2f8ba6b358 | ||
|
|
c1a16ff02b | ||
|
|
f29876584e | ||
|
|
877b3e1252 | ||
|
|
a95ad3c8ea | ||
|
|
5edfb20937 | ||
|
|
9327b3e130 | ||
|
|
254ef0cf66 | ||
|
|
b7e09ecd8a
|
||
|
|
0b8b8c8979
|
||
|
|
a640fbc5b5
|
||
|
|
46b2761797
|
||
|
|
346e078ef3
|
||
|
|
b2df5dbb84
|
||
|
|
1a385556fd
|
||
|
|
7652dd8954 | ||
|
|
5473f4141f
|
||
|
|
40c142bfe2 | ||
|
|
2c30436a45 | ||
|
|
e07579864e | ||
|
|
7da43d0ace | ||
|
|
6456744d4c | ||
|
|
71d19a9b2d | ||
|
|
6a8e6ee16d | ||
|
|
953e9bcc85 | ||
|
|
3df438b2b6 | ||
|
|
d83b15222f | ||
|
|
a6d8a1a243 | ||
|
|
6d04132ffe | ||
|
|
00bac4797b | ||
|
|
5e6db95577 | ||
|
|
bcf789f3fa | ||
|
|
3610e7486b | ||
|
|
aea6d4a66c | ||
|
|
f435dc4f11 | ||
|
|
c8840127bc
|
||
|
|
95769ad988 | ||
|
|
934c6c499c | ||
|
|
dab1c4256d
|
||
|
|
66b5a4cb23
|
||
|
|
57cb4f2be9
|
||
|
|
7b1e8f6735
|
||
|
|
5f3fb2b391
|
||
|
|
f855a6b38a | ||
|
|
01fef44d65 | ||
|
|
3364360e92
|
||
|
|
b78e173c11
|
||
|
|
c0eec7d126
|
||
|
|
c4c8f468e0 | ||
|
|
ba41229f00
|
||
|
|
c22542a645 | ||
|
|
dbd741b606 | ||
|
|
4bb07d9898 | ||
|
|
2e5205e9e8 | ||
|
|
6ea10ca81d | ||
|
|
f1933768fc | ||
|
|
182dbf243a | ||
|
|
566f981a0c
|
||
|
|
0e079b4601 | ||
|
|
e0d5e106d3 | ||
|
|
18b756b166
|
||
|
|
828e075f91 | ||
|
|
d3bbe8b17c | ||
|
|
74a66f374a | ||
|
|
e1509e2133
|
||
|
|
a5677f20fa
|
||
|
|
b4afeb71c8 | ||
|
|
470a0b5edb | ||
|
|
a2e8e802e0 | ||
|
|
70199c0910 | ||
|
|
1e55d06d39
|
||
|
|
3c17b81e19 | ||
|
|
c7ce14bfd8 | ||
|
|
5e22c605e2
|
||
|
|
fbe50a3601 | ||
|
|
007d040000 | ||
|
|
a092f87292
|
||
|
|
ae720495a6 | ||
|
|
11059e9536 | ||
|
|
afb2024f36 | ||
|
|
ebfc096180 | ||
|
|
3c8d2e5fac | ||
|
|
cb7b382bb5
|
||
|
|
1d77ae2392
|
||
|
|
a71e3397f8 | ||
|
|
52beaec19f | ||
|
|
3b22787249 | ||
|
|
75e27958b2 | ||
|
|
a7254d6a4b | ||
|
|
678011956c | ||
|
|
23e3234a6a
|
||
|
|
b60bc22eab
|
||
|
|
f5a63a91c6
|
||
|
|
00039ef030
|
||
|
|
470b51fbce
|
||
|
|
33c76be8a3
|
||
|
|
3a92e57114
|
||
|
|
bfd6a48f69
|
||
|
|
d288f96b9b
|
||
|
|
9a62aaabae
|
||
|
|
4165d0493f
|
||
|
|
a5b6046b47
|
||
|
|
d13ab90e99
|
||
|
|
a00d148834 | ||
|
|
0f4d71874b | ||
|
|
9bf47ac4a9
|
||
|
|
5f95476725
|
||
|
|
0c211b3da9
|
||
|
|
212701adf2 | ||
|
|
62aea15ba1 | ||
|
|
8912d94a83 | ||
|
|
3ede3b294b | ||
|
|
16a94ff6ee | ||
|
|
8b94dca7d6
|
||
|
|
af3c82a13a | ||
|
|
1b31a89a86 | ||
|
|
c5692915b7 | ||
|
|
ca8585b67e | ||
|
|
80235d177d
|
||
|
|
f996f46fb2 | ||
|
|
4c44d9b708 | ||
|
|
af854f31e9
|
||
|
|
41f46a9d45 | ||
|
|
b2f2ad2788 | ||
|
|
9ec4116397 | ||
|
|
1ba826c2d0 | ||
|
|
53162fd127 | ||
|
|
588476a9e1 | ||
|
|
5cddc8587b | ||
|
|
9ea777de1b | ||
|
|
f0fcef3d18 | ||
|
|
765987d423 | ||
|
|
1fc89b1e08 | ||
|
|
f982361714 | ||
|
|
7be06f179e | ||
|
|
2beecbe62f | ||
|
|
b6d92dc1b8
|
||
|
|
adc06f27ae
|
||
|
|
aabd16daec | ||
|
|
f21effaa64 | ||
|
|
e630ebc035 | ||
|
|
18d1d6a108 | ||
|
|
ad31f2ad88 | ||
|
|
b81c7daba9 | ||
|
|
93bf10f6b5 | ||
|
|
8c69ca64eb | ||
|
|
f1ad8ce2a7 | ||
|
|
c1caedd4e5 | ||
|
|
19bc39f0af | ||
|
|
7c7a646853 | ||
|
|
d537190719
|
||
|
|
bfcb81a8ce
|
||
|
|
8849397d80 | ||
|
|
59411e6116 | ||
|
|
c13b471269 | ||
|
|
7c0c240ad8
|
||
|
|
4459348a31 | ||
|
|
a6bce41e0b | ||
|
|
684f3f2b11 | ||
|
|
34a69e3a3b | ||
|
|
e3b140ef8e | ||
|
|
394ec2ed1c | ||
|
|
65ded1af34 | ||
|
|
2951473633 | ||
|
|
8790f95c53 | ||
|
|
01ce8ef7d0 | ||
|
|
7af645da8d | ||
|
|
b7ab0cb229 | ||
|
|
bd246115de | ||
|
|
99bb9ed169 | ||
|
|
0b4b84d892
|
||
|
|
f525f45fbe | ||
|
|
07f2509e11 | ||
|
|
c8bbe8e1ab
|
||
|
|
fd4d0cda42 | ||
|
|
00320472be | ||
|
|
47fb92a475
|
||
|
|
02b2c417c6 | ||
|
|
c2d0833f71
|
||
|
|
5bf82c9793 | ||
|
|
1de2213807 | ||
|
|
549b3dfd83
|
||
|
|
5357c9a77e
|
||
|
|
a32b8897cc | ||
|
|
161c56430b | ||
|
|
9e6031da1c | ||
|
|
7ffe4f2f91
|
||
|
|
009657896d | ||
|
|
36445fb3e1 | ||
|
|
fc6b26398d
|
||
|
|
769a247645
|
||
|
|
207c4efc4a
|
||
|
|
a6ac799478 | ||
|
|
f8ca5910b6 | ||
|
|
62221f675e
|
||
|
|
1529506d82
|
||
|
|
8376721289
|
||
|
|
657eb11960 | ||
|
|
15c25ee958 | ||
|
|
8438dc3250
|
||
|
|
10b5b6b0c1
|
||
|
|
a90612a8bd | ||
|
|
5ce461356c | ||
|
|
c033d222f6
|
||
|
|
930909f165
|
||
|
|
59e64a2f05
|
||
|
|
d54fcdc9ca
|
||
|
|
965243fd12
|
||
|
|
63b56940db
|
||
|
|
2411e2ef68
|
||
|
|
809261ad25
|
||
|
|
0d47001c9d
|
||
|
|
4ade5ac092
|
||
|
|
011f31e1cc
|
||
|
|
c7fa8c7194 | ||
|
|
ce8e8d0b78 | ||
|
|
94fd2c388d | ||
|
|
91dd6bee3b
|
||
|
|
3661dc45ca
|
||
|
|
1fc302a44f
|
||
|
|
26561b758b
|
||
|
|
261a51707e | ||
|
|
7dbad92254 | ||
|
|
311d29f711 | ||
|
|
e1d3a9edea
|
||
|
|
19e422047d
|
||
|
|
f522355927
|
||
|
|
2752abd5ee
|
||
|
|
79ad16756e
|
||
|
|
d2d9b23784 | ||
|
|
b5067bf7e9
|
||
|
|
a5daab5ea2
|
||
|
|
9538f19837 | ||
|
|
0a24424d32 | ||
|
|
73c0d5b553 | ||
|
|
46b7dcf941 | ||
|
|
1b67b52784 | ||
|
|
d6b80bf061 | ||
|
|
4369e1eb66 | ||
|
|
8f56c0f4a6
|
||
|
|
4aa9baba9a
|
||
|
|
73caa3b62e
|
||
|
|
566656bec1
|
||
|
|
0602fd1b32
|
||
|
|
bbc450064b
|
||
|
|
ddabeb53ef
|
||
|
|
21e5c9d0f2
|
||
|
|
f8e63b2ab2
|
||
|
|
2270d69867
|
||
|
|
5706c8c3f5
|
||
|
|
de0ff5fa82
|
||
|
|
9d494be5b5
|
||
|
|
a4ba3133f8 | ||
|
|
6fca1eab47
|
||
|
|
ff7e0740d9 | ||
|
|
8503e55afc
|
||
|
|
165dc5b9cb
|
||
|
|
5312f4a81b
|
||
|
|
a03221872b
|
||
|
|
887cfa36e3 | ||
|
|
f32676c474 | ||
|
|
09a11853b9
|
||
|
|
0256b514c9 | ||
|
|
b43ec967a9 | ||
|
|
7c56906273 | ||
|
|
1040971177 | ||
|
|
ce860b9681
|
||
|
|
5d526ee724
|
||
|
|
d096357f2c | ||
|
|
a6c07289bb | ||
|
|
a7eb166556 |
+4
-2
@@ -1,4 +1,4 @@
|
||||
FROM squidfunk/mkdocs-material:8.1.10
|
||||
FROM squidfunk/mkdocs-material:9.1.19
|
||||
|
||||
EXPOSE 8000
|
||||
|
||||
@@ -8,4 +8,6 @@ WORKDIR /docs
|
||||
|
||||
RUN apk add --no-cache curl
|
||||
|
||||
RUN pip install mkdocs-awesome-pages-plugin mkdocs-material-extensions
|
||||
RUN pip install \
|
||||
mkdocs-awesome-pages-plugin==2.9.1 \
|
||||
mkdocs-material-extensions==1.1.1
|
||||
|
||||
@@ -1,674 +1,6 @@
|
||||
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>.
|
||||
Copyright (C) 2022 Co-op Cloud
|
||||
Permission is granted to copy, distribute and/or modify this document under the
|
||||
terms of the GNU Free Documentation License, Version 1.3 or any later version
|
||||
published by the Free Software Foundation; with no Invariant Sections, no
|
||||
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
|
||||
in the section entitled "GNU Free Documentation License".
|
||||
|
||||
@@ -0,0 +1,170 @@
|
||||
{#-
|
||||
This file was copied from the Material theme
|
||||
You can find the file in https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/src/partials/header.html
|
||||
-#}
|
||||
<!--
|
||||
Copyright (c) 2016-2023 Martin Donath <martin.donath@squidfunk.com>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to
|
||||
deal in the Software without restriction, including without limitation the
|
||||
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
||||
sell copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
||||
IN THE SOFTWARE.
|
||||
-->
|
||||
|
||||
<!-- Determine base classes -->
|
||||
{% set class = "md-header" %}
|
||||
{% if "navigation.tabs.sticky" in features %}
|
||||
{% set class = class ~ " md-header--shadow md-header--lifted" %}
|
||||
{% elif "navigation.tabs" not in features %}
|
||||
{% set class = class ~ " md-header--shadow" %}
|
||||
{% endif %}
|
||||
|
||||
<!-- Header -->
|
||||
<header class="{{ class }}" data-md-component="header">
|
||||
<nav
|
||||
class="md-header__inner md-grid"
|
||||
aria-label="{{ lang.t('header') }}"
|
||||
>
|
||||
|
||||
<!-- Link to home -->
|
||||
<a
|
||||
href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}"
|
||||
title="{{ config.site_name | e }}"
|
||||
class="md-header__button md-logo"
|
||||
aria-label="{{ config.site_name }}"
|
||||
data-md-component="logo"
|
||||
>
|
||||
{% include "partials/logo.html" %}
|
||||
</a>
|
||||
|
||||
<!-- Button to open drawer -->
|
||||
<label class="md-header__button md-icon" for="__drawer">
|
||||
{% include ".icons/material/menu" ~ ".svg" %}
|
||||
</label>
|
||||
|
||||
<!-- Header title -->
|
||||
<div class="md-header__title" data-md-component="header-title">
|
||||
<div class="md-header__ellipsis">
|
||||
<div class="md-header__topic">
|
||||
<span class="md-ellipsis">
|
||||
{{ config.site_name }}
|
||||
</span>
|
||||
</div>
|
||||
<div class="md-header__topic" data-md-component="header-topic">
|
||||
<span class="md-ellipsis">
|
||||
{% if page.meta and page.meta.title %}
|
||||
{{ page.meta.title }}
|
||||
{% else %}
|
||||
{{ page.title }}
|
||||
{% endif %}
|
||||
</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Color palette -->
|
||||
{% if config.theme.palette %}
|
||||
{% if not config.theme.palette is mapping %}
|
||||
<form class="md-header__option" data-md-component="palette">
|
||||
{% for option in config.theme.palette %}
|
||||
{% set scheme = option.scheme | d("default", true) %}
|
||||
{% set primary = option.primary | d("indigo", true) %}
|
||||
{% set accent = option.accent | d("indigo", true) %}
|
||||
<input
|
||||
class="md-option"
|
||||
data-md-color-media="{{ option.media }}"
|
||||
data-md-color-scheme="{{ scheme | replace(' ', '-') }}"
|
||||
data-md-color-primary="{{ primary | replace(' ', '-') }}"
|
||||
data-md-color-accent="{{ accent | replace(' ', '-') }}"
|
||||
{% if option.toggle %}
|
||||
aria-label="{{ option.toggle.name }}"
|
||||
{% else %}
|
||||
aria-hidden="true"
|
||||
{% endif %}
|
||||
type="radio"
|
||||
name="__palette"
|
||||
id="__palette_{{ loop.index }}"
|
||||
/>
|
||||
{% if option.toggle %}
|
||||
<label
|
||||
class="md-header__button md-icon"
|
||||
title="{{ option.toggle.name }}"
|
||||
for="__palette_{{ loop.index0 or loop.length }}"
|
||||
hidden
|
||||
>
|
||||
{% include ".icons/" ~ option.toggle.icon ~ ".svg" %}
|
||||
</label>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</form>
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
<!-- Site language selector -->
|
||||
{% if config.extra.alternate %}
|
||||
<div class="md-header__option">
|
||||
<div class="md-select">
|
||||
{% set icon = config.theme.icon.alternate or "material/translate" %}
|
||||
<button
|
||||
class="md-header__button md-icon"
|
||||
aria-label="{{ lang.t('select.language') }}"
|
||||
>
|
||||
{% include ".icons/" ~ icon ~ ".svg" %}
|
||||
</button>
|
||||
<div class="md-select__inner">
|
||||
<ul class="md-select__list">
|
||||
{% for alt in config.extra.alternate %}
|
||||
<li class="md-select__item">
|
||||
<a
|
||||
href="{{ alt.link | url }}"
|
||||
hreflang="{{ alt.lang }}"
|
||||
class="md-select__link"
|
||||
>
|
||||
{{ alt.name }}
|
||||
</a>
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
<!-- Button to open search modal -->
|
||||
{% if "material/search" in config.plugins %}
|
||||
<label class="md-header__button md-icon" for="__search">
|
||||
{% include ".icons/material/magnify.svg" %}
|
||||
</label>
|
||||
|
||||
<!-- Search interface -->
|
||||
{% include "partials/search.html" %}
|
||||
{% endif %}
|
||||
|
||||
<!-- Repository information -->
|
||||
{% if config.repo_url %}
|
||||
<div class="md-header__source">
|
||||
{% include "partials/source.html" %}
|
||||
</div>
|
||||
{% endif %}
|
||||
</nav>
|
||||
|
||||
<!-- Navigation tabs (sticky) -->
|
||||
{% if "navigation.tabs.sticky" in features %}
|
||||
{% if "navigation.tabs" in features %}
|
||||
{% include "partials/tabs.html" %}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
</header>
|
||||
@@ -0,0 +1,79 @@
|
||||
---
|
||||
title: Cheat sheet
|
||||
---
|
||||
|
||||
# Abra cheat sheet
|
||||
|
||||
!!! info
|
||||
not all flags are listed here.
|
||||
|
||||
!!! warning
|
||||
Definitely set up autocomplete or you'll be sad
|
||||
|
||||
`abra autocomplete bash/zsh/fizsh`
|
||||
|
||||
### create and deploy a new app:
|
||||
- `abra app new $RECIPE`
|
||||
flags: `-s/--server`, `-D/--domain`, `-S/--secrets`, `-p/--pass`
|
||||
- `abra app config $APPNAME`
|
||||
- `abra app secret generate $APPNAME -a`
|
||||
flags: `-p/--pass`, `-a/--all`
|
||||
- `abra app deploy $APPNAME`
|
||||
flags: `-f/--force`, `-C/--chaos`
|
||||
|
||||
### undeploy and remove an app
|
||||
- back up any data you don't want to lose
|
||||
- `abra app undeploy $APPNAME`
|
||||
- `abra app rm --volumes $APPNAME`
|
||||
flags: `-f/--force`, `-V/--volumes`
|
||||
|
||||
### add/remove server
|
||||
- `abra server add $SERVER`
|
||||
- `abra server remove $SERVER`
|
||||
flags: `-s/--server`
|
||||
|
||||
### upgrade abra
|
||||
- `abra upgrade`
|
||||
flags: `--rc`
|
||||
|
||||
### upgrade a recipe
|
||||
- `abra recipe upgrade $RECIPE`
|
||||
flags: `-x,y,z/--major,minor,patch`
|
||||
- `abra recipe sync $RECIPE`
|
||||
flags: `-x,y,z`
|
||||
- `abra recipe release $RECIPE [$VERSION]`
|
||||
flags: `-p/--publish`, `-r/--dry-run`, `-x,y,z`
|
||||
|
||||
### make a change to a recipe
|
||||
- edit the files in `~/.abra/recipe/$RECIPENAME`
|
||||
- deploy the changed version to your test instance
|
||||
- determine how serious your change is (semver.org for reference)
|
||||
- `abra recipe release $RECIPE [$VERSION]`
|
||||
|
||||
### Advanced Listing using `jq`
|
||||
|
||||
Several `abra` commands can output JSON formatted tables, and can thus be queried and filtered with the tool [jq](https://stedolan.github.io/jq/ "jq JSON Query tool"). We can also format these outputs with [tv](https://github.com/uzimaru0000/tv "tv Table Viewer") into a pretty table.
|
||||
|
||||
|
||||
Currently, `abra recipe ls`, `abra server ls`, and `abra app ls` support the `-m` machine readable output flag which outputs JSON.
|
||||
|
||||
#### Filter recipes by "category"
|
||||
|
||||
`abra recipe ls -m | jq '[.[] | select(.category == "Utilities") ]' | tv`
|
||||
|
||||
As you can see we, we're selecting all recipes where category is "Utilities".
|
||||
|
||||
#### Filter apps by state `deployed`
|
||||
|
||||
!!! info
|
||||
`abra app ls -S` queries each server in your added server list, where as without the `-S` it only lists from your local copy of the sever files (thus providing no information about actual state of the apps)
|
||||
|
||||
!!! info
|
||||
`abra app ls` lists apps grouped into a server object, with statistics about the server. In `jq` we can select the entire apps list with `.[].apps[]`.
|
||||
|
||||
`abra app ls -m -S |jq '[.[].apps[] | select(.status == "deployed") | del(.upgrade)]' |tv`
|
||||
|
||||
The `del(.upgrade)` filter filters out available versions for the recipe in question for that row. It could be useful to leave in if you want a list of deployed apps that need an upgrade.
|
||||
|
||||
|
||||
|
||||
+62
-7
@@ -16,21 +16,72 @@ Install [Go >= 1.16](https://golang.org/doc/install) and then:
|
||||
- `make install` will install it to `$GOPATH/bin`
|
||||
- `go get <package>` and `go mod tidy` to add a new dependency
|
||||
|
||||
Our [Drone CI configuration](.drone.yml) runs a number of sanity on each pushed commit. See the [Makefile](./Makefile) for more handy targets.
|
||||
Our [Drone CI configuration](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/.drone.yml) runs a number of checks on each pushed commit. See the [Makefile](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/Makefile) for more handy targets.
|
||||
|
||||
Please use the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/) for your commits so we can automate our change log.
|
||||
|
||||
### Using the `abra` public API
|
||||
|
||||
Warning, there is currently no stability promise for the `abra` public API! Most of the internals are exposed in order to allow a free hand for developers to try build stuff. If people start to build things then we can start the discussion on what is useful to have open/closed and keep stable etc. Please let us know if you depend on the APIs!
|
||||
|
||||
The `pkg.go.dev` documentation is [here](https://pkg.go.dev/coopcloud.tech/abra). Here's a brief example to get you going:
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"log"
|
||||
|
||||
abraClient "coopcloud.tech/abra/pkg/client"
|
||||
dockerClient "github.com/docker/docker/client"
|
||||
)
|
||||
|
||||
func getClient(serverName string) (*dockerClient.Client, error) {
|
||||
cl, err := abraClient.New(serverName)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("getClient: %s", err)
|
||||
}
|
||||
return cl, nil
|
||||
}
|
||||
|
||||
func main() {
|
||||
cl, err := getClient("foo.example.com")
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
// do stuff with the client...
|
||||
// https://pkg.go.dev/github.com/docker/docker/client
|
||||
}
|
||||
```
|
||||
|
||||
Some tools that are making use of the API so far are:
|
||||
|
||||
* [`kadabra`](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/cmd/kadabra/main.go)
|
||||
|
||||
### Cross-compiling
|
||||
|
||||
If there's no official release for the architecture you use, you can cross-compile `abra` very easily. Clone the source code from [here](https://git.coopcloud.tech/coop-cloud/abra) and then:
|
||||
|
||||
- enter the `abra` directory
|
||||
- run `git tag -l` to see the list of tags, choose the latest one
|
||||
- run `git checkout <tag>`, where `<tag>` is the latest version
|
||||
- run `GOOS=<os> GOARCH=<arch> [GOARM=<arm>] make build`. You only have to use `GOARM` if you're building for ARM, this specifies the ARM version (5,6,7 etc). See [this](https://go.dev/doc/install/source#environment) for a list of all supported OS'es and architectures.
|
||||
|
||||
|
||||
## Release management
|
||||
|
||||
We use [goreleaser](https://goreleaser.com) to help us automate releases. We use [semver](https://semver.org) for versioning all releases of the tool. While we are still in the public alpha release phase, we will maintain a `0.y.z-alpha` format. Change logs are generated from our commit logs. We are still working this out and aim to refine our release praxis as we go.
|
||||
We use [goreleaser](https://goreleaser.com) to help us automate releases. We use [semver](https://semver.org) for versioning all releases of the tool. While we are still in the public beta release phase, we will maintain a `0.y.z-beta` format. Change logs are generated from our commit logs. We are still working this out and aim to refine our release praxis as we go.
|
||||
|
||||
For developers, while using this `-alpha` format, the `y` part is the "major" version part. So, if you make breaking changes, you increment that and _not_ the `x` part. So, if you're on `0.1.0-alpha`, then you'd go to `0.1.1-alpha` for a backwards compatible change and `0.2.0-alpha` for a backwards incompatible change.
|
||||
For developers, while using this `-beta` format, the `y` part is the "major" version part. So, if you make breaking changes, you increment that and _not_ the `x` part. So, if you're on `0.1.0-beta`, then you'd go to `0.1.1-beta` for a backwards compatible change and `0.2.0-beta` for a backwards incompatible change.
|
||||
|
||||
### Making a new release
|
||||
|
||||
- Change `ABRA_VERSION` to match the new tag in [`scripts`](./scripts/installer/installer) (use [semver](https://semver.org))
|
||||
- Commit that change (e.g. `git commit -m 'chore: publish next tag x.y.z-alpha'`)
|
||||
- Make a new tag (e.g. `git tag -a x.y.z-alpha`)
|
||||
- Change `ABRA_VERSION` in [`scripts/installer/installer`](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/scripts/installer/installer) to match the new tag (use [semver](https://semver.org))
|
||||
- Commit that change (e.g. `git commit -m 'chore: publish next tag x.y.z-beta'`)
|
||||
- Make a new tag (e.g. `git tag -a x.y.z-beta`)
|
||||
- Push the new tag (e.g. `git push && git push --tags`)
|
||||
- Wait until the build finishes on [build.coopcloud.tech](https://build.coopcloud.tech/coop-cloud/abra)
|
||||
- Deploy the new installer script (e.g. `cd ./scripts/installer && make`)
|
||||
@@ -44,4 +95,8 @@ We maintain a fork of [godotenv](https://github.com/Autonomic-Cooperative/godote
|
||||
|
||||
### `docker/client`
|
||||
|
||||
A number of modules in [pkg/upstream](./pkg/upstream) are copy/pasta'd from the upstream [docker/docker/client](https://pkg.go.dev/github.com/docker/docker/client). We had to do this because upstream are not exposing their API as public.
|
||||
A number of modules in [pkg/upstream](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/pkg/upstream) are copy/pasta'd from the upstream [docker/docker/client](https://pkg.go.dev/github.com/docker/docker/client). We had to do this because upstream are not exposing their API as public.
|
||||
|
||||
### `github.com/schultz-is/passgen`
|
||||
|
||||
Due to [`coop-cloud/organising#358`](https://git.coopcloud.tech/coop-cloud/organising/issues/358).
|
||||
|
||||
+7
-1
@@ -2,7 +2,13 @@
|
||||
title: Abra
|
||||
---
|
||||
|
||||
`abra` is our flagship client & command-line tool which has been developed specifically in the context of the Co-op Cloud project for the purpose of making day-to-day operations for [operators](/operators/) and [maintainers](/maintainers/) as convenient as possible. It is libre software, written in [Go](https://go.dev/) and maintained and extended by the community :heart:
|
||||
<a href="https://github.com/egonelbre/gophers"><img align="right" width="250" src="https://github.com/egonelbre/gophers/raw/master/.thumb/sketch/adventure/poking-fire.png"/></a>
|
||||
|
||||
[](https://build.coopcloud.tech/coop-cloud/abra)
|
||||
[](https://goreportcard.com/report/git.coopcloud.tech/coop-cloud/abra)
|
||||
[](https://pkg.go.dev/coopcloud.tech/abra)
|
||||
|
||||
`abra` is the flagship client & command-line for Co-op Cloud. It has been developed specifically for the purpose of making the day-to-day operations of operators and maintainers pleasant & convenient. It is libre software, written in Go and maintained and extended by the community :heart:
|
||||
|
||||
Once you've got `abra` installed, you can start your own Co-op Cloud deployment. `abra` allows you to create, deploy and maintain libre software apps. It supports working with existing servers or can create new servers (supported providers: [Servers.coop](https://servers.coop/) & [Hetzner](https://hetzner.com)). It can also help you manage your DNS configuration (supported providers: [Gandi](https://gandi.net)).
|
||||
|
||||
|
||||
@@ -2,6 +2,10 @@
|
||||
title: Install
|
||||
---
|
||||
|
||||
!!! warning
|
||||
|
||||
We've seen reports that `abra` under [WSL](https://learn.microsoft.com/en-us/windows/wsl/about) doesn't work due to an underlying bug in Docker context handling. See [`coop-cloud/organising#406`](https://git.coopcloud.tech/coop-cloud/organising/issues/406) and [`docker/for-win#13180`](https://github.com/docker/for-win/issues/13180) for more.
|
||||
|
||||
## Stable release
|
||||
|
||||
```
|
||||
@@ -17,3 +21,17 @@ curl https://install.abra.coopcloud.tech | bash -s -- --rc
|
||||
## Installer script source
|
||||
|
||||
You can view that [here](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/scripts/installer/installer).
|
||||
|
||||
## Using Docker
|
||||
|
||||
```
|
||||
docker run \
|
||||
-v $HOME/.abra:/.abra \
|
||||
git.coopcloud.tech/coop-cloud/abra app ls
|
||||
```
|
||||
|
||||
!!! note
|
||||
If you're using symlinks, e.g. for [sharing
|
||||
`~/.abra`](/operators/handbook/#sharing-abra), add more `-v` options for each
|
||||
directory you're symlinking to, e.g. `-v
|
||||
$HOME/Projects/CoopCloud/apps:/home/user/Projects/CoopCloud/apps`
|
||||
|
||||
+50
-40
@@ -4,55 +4,25 @@ title: Troubleshoot
|
||||
|
||||
## Where do I report `abra` bugs / feature requests?
|
||||
|
||||
You can use [this issue tracker](https://git.coopcloud.tech/coop-cloud/abra/issues/new).
|
||||
You can use [this issue tracker](https://git.coopcloud.tech/coop-cloud/organising/issues/new/choose).
|
||||
|
||||
## SSH connection issues?
|
||||
|
||||
`abra` tries its best to learn from your system configuration or command-line input what the correct SSH connection details are for a given server. This doesn't always work out. Here are some things to try to fix it.
|
||||
When you run `abra server add <host>`, `abra` will read from your `~/.ssh/config` and try to match a `Host <host>` entry. If you can `ssh <host>` then you should be able to `abra server add <host>`.
|
||||
|
||||
First, ensure that you can `ssh <my-server>` and things work. If you can't SSH to your server then neither can `abra`. If you have a password protected SSH key, then you'll need to make sure your `ssh-agent` is running and you've added your SSH key part:
|
||||
For example, if you do `abra server add example.com`, you should have a matching entry that looks like this:
|
||||
|
||||
```
|
||||
eval $(ssh-agent -k)
|
||||
ssh-add ~/.ssh/<my-secret-key-part>
|
||||
ssh-add -L # validate loaded keys
|
||||
Host example.com
|
||||
Hostname example.com
|
||||
User exampleUser
|
||||
Port 12345
|
||||
IdentityFile ~/.ssh/example@somewhere
|
||||
```
|
||||
|
||||
The first thing `abra` will check for is the connection details listed in `abra server ls`. Check those details are correct. If you haven't managed to `abra server add` your server yet, then no details will appear in that list. You may need to take a look at [this entry](/abra/trouble/#abra-server-ls-shows-the-wrong-details) to clean up old values depending on your situation.
|
||||
|
||||
`abra` will then try to read your `~/.ssh/config` entries and match the server domain against a `Host` entry. So, if you do `ssh myserver.com` and you have:
|
||||
|
||||
```
|
||||
Host myserver.com
|
||||
Hostname myserver.com
|
||||
User myuser
|
||||
Port 222
|
||||
IdentityFile ~/.ssh/my@myserver.com
|
||||
```
|
||||
|
||||
Then `abra` should have all it needs to build a working SSH connection. You can validate this by passing `-d/--debug` to your commands.
|
||||
|
||||
However, sometimes, you use an alias in your SSH configuration, say:
|
||||
|
||||
```
|
||||
Host mys
|
||||
...
|
||||
```
|
||||
|
||||
So that you can simply type `ssh mys`. `abra` won't be able to match against those entries to discover connection details. You can use aliases to remedy this:
|
||||
|
||||
```
|
||||
Host mys, myserver.com
|
||||
...
|
||||
```
|
||||
|
||||
`abra` will try to read the relevant `IdentityFile` entry from your `~/.ssh/config` but if it can't make a match, it will rely on your key being added to the `ssh-agent`.
|
||||
|
||||
Due to a limitation in our implementation, `abra` uses 2 methods of making SSH connections, the main `abra` -> `remote docker` connection using `/usr/bin/ssh` which can seamlessly pick up loaded SSH keys. However, for SSH host key checking, `abra` uses an SSH library & Golang SSH internals. We're working on resolving this to a single implementation but it is tricky work.
|
||||
|
||||
## "abra server ls" shows the wrong details?
|
||||
|
||||
You can use `abra server rm` to remove the incorrect details. Make sure to take a backup of your `~/.abra/servers/<domain>` first. You can then try to re-create by using `abra server add ...` again, making sure to take care if you need to use `<user> <port>`, see `abra server add -h` for more help on this.
|
||||
You can use `abra server rm` to remove the incorrect details. Make sure to take a backup of your `~/.abra/servers/<domain>` first. You can then try to re-create by using `abra server add ...` again.
|
||||
|
||||
However, if you have Docker installed on the same machine you have `abra`, then there might be some confusion. If you run `docker context ls` you'll see that Docker uses context connection strings also. `abra` simply uses this approach. Sometimes, your Docker defined context details & your `abra` context details can get out of sync. You can use `docker context rm` to resolve this.
|
||||
|
||||
@@ -62,8 +32,48 @@ If you need to create a new context from Docker, you can do:
|
||||
docker context create <domain> --docker "host=ssh://<user>@<domain>:<port>"
|
||||
```
|
||||
|
||||
(This is what we used to before we wrote `abra` to make it more convenient.)
|
||||
This is what we used to before we wrote `abra` to make it more convenient.
|
||||
|
||||
## Command-line flag handling is weird?
|
||||
|
||||
Unfortunately, there is a limitation in our underlying command-line library implementation for `abra` ([ref](https://github.com/urfave/cli/issues/1113)) (and more fundamentally in the design of flags in the Go programming language itself ([ref](https://utcc.utoronto.ca/~cks/space/blog/programming/GoFlagUIImportance))). We're aiming to work with upstream to resolve the flag handling but this it is not yet clear when this will be resolved.
|
||||
|
||||
Currently, the following example of flexible flag usage is supported:
|
||||
|
||||
```
|
||||
abra app new gitea -S # generate secrets, after args
|
||||
abra app new -S gitea # generate secrets, before args
|
||||
```
|
||||
|
||||
But something like the following does not work as expected:
|
||||
|
||||
```
|
||||
abra app new -S gitea -p
|
||||
```
|
||||
|
||||
Where the position of flags is mixed before & after args. `-p` is ignored :cry:
|
||||
|
||||
We're still waiting for upstream patch which resovles this.
|
||||
|
||||
## Why can't `abra` support multiline in `.env` files?
|
||||
|
||||
We're sorry, it's an issue with an upstream dependency. See [`#291`](https://git.coopcloud.tech/coop-cloud/organising/issues/291) for more.
|
||||
|
||||
## I need some feature from the old deprecated bash abra?
|
||||
|
||||
There is an archive of the [old code here](https://git.coopcloud.tech/coop-cloud/abra-bash).
|
||||
|
||||
You can install it alongside the [supported version of Abra](https://git.coopcloud.tech/coop-cloud/abra) by using these commands:
|
||||
|
||||
```bash
|
||||
git clone https://git.coopcloud.tech/coop-cloud/abra-bash ~/.abra/bash-src
|
||||
ln -s ~/.abra/bash-src/abra ~/.local/bin/babra
|
||||
```
|
||||
|
||||
## "Network not found" when deploying?
|
||||
|
||||
This appears to be an upstream issue for which we can't do much in `abra` to solve. See [`coop-cloud/organising#420`](https://git.coopcloud.tech/coop-cloud/organising/issues/420) for more info. The work-around is to leave more time in between undeploy/deploy operations so the runtime can catch up.
|
||||
|
||||
## Caller path in debug stacktrace doesn't exist
|
||||
|
||||
Debug stacktrace currently begins with `/drone/` due to CI. Remove the initial `/drone/` and the path is relative to the abra project root.
|
||||
|
||||
+43
-2
@@ -18,11 +18,52 @@ abra upgrade --rc
|
||||
|
||||
## Migration guides
|
||||
|
||||
### `0.6.x-beta` -> `0.7.x-beta`
|
||||
|
||||
> General release notes are [here](https://git.coopcloud.tech/coop-cloud/abra/releases/tag/0.7.0-beta)
|
||||
|
||||
- **ALERTA, ALERTA**, security related issue: all `$domain.env` env vars are now exposed to the deployment via the `app` service container. Each `FOO=BAR` is exported within the context of the container. If you have any privately committed secrets in your `.env` files, please migrate them to the `secrets: ...` configuration in the recipe. This change was made to facilitate tooling which can support auto-upgrading of apps in a deployment.
|
||||
|
||||
- `abra` can no longer install Docker, initialise swarm mode and the proxy network. It will check if a Docker install exists and is in swarm mode or not and error out accordingly. We leave the provisioning to tools that are designed for that and reduce the command-line surface that we have to maintain going forward.
|
||||
|
||||
- `abra server add <host> <args>` 👉 `abra server add <host>`. We have finally removed the custom SSH handling code and now solely rely on invoking `/usr/bin/ssh` directly and reading from the `~/.ssh/config`. The `<host>` argument should correspond to a `Host <host>` entry in your `~/.ssh/config` or in an `Include <file>` statement (hosts are retrieved via `ssh -G <host>`). This means "how does `abra` interact with SSH is 1) do you have an `~/.ssh/config` entry for `<host>` 2) can you `ssh <host>` successfully? 3) there is no 3. It's an easier mental model and also the way `abra-bash` works, hence, less weird obscure errors. `<host>` being public a domain name is still required.
|
||||
|
||||
- `abra` no longer tries to do the TOFU host key verification prompt. We follow the praxis of the Docker CLI and just give up when host keys are not validated. We leave it to folks to SSH in and verify themselves.
|
||||
|
||||
- Digests have been removed from the catalogue generation. They are not being used elsewhere and were significantly slowing down generation.
|
||||
|
||||
### `0.5.x-beta` -> `0.6.x-beta`
|
||||
|
||||
- Using `{{ .Domain }}` in recipe `.envrc.sample` files went away because it
|
||||
was portable enough. We revert to replacing e.g `gitea.example.com` with the
|
||||
domain. See
|
||||
[`8fad34e`](https://git.coopcloud.tech/coop-cloud/abra/commit/8fad34e) for
|
||||
more.
|
||||
|
||||
- If your `abra.sh` scripts depend on `/bin/sh` and `/bin/bash` is available in
|
||||
the container then `/bin/bash` will be used from now on. `/bin/sh` is only
|
||||
now used if `/bin/bash` is not available. See
|
||||
[`7f745ff`](https://git.coopcloud.tech/coop-cloud/abra/commit/7f745ff) for
|
||||
more.
|
||||
|
||||
### `v0.4.x` -> `v0.5.x`
|
||||
|
||||
- The only breaking change was making `abra` understand that the JSON dump for the recipes listing lives on [recipes.coopcloud.tech/recipes.json](https://recipes.coopcloud.tech) instead of [recipes.coopcloud.tech](https://recipes.coopcloud.tech).
|
||||
|
||||
### `v0.3.x` -> `v0.4.x`
|
||||
|
||||
Make sure to back up your `~/.abra/servers` configurations first for safety.
|
||||
|
||||
- `mv ~/.abra/apps ~/.abra/recipes`
|
||||
- `find ~/.abra/servers/ -type f -exec sed -i "s/^TYPE=/RECIPE=/g" {} \;`
|
||||
- Please run `mv ~/.abra/apps ~/.abra/recipes`.
|
||||
|
||||
- "app name" as a concept went away, `abra` now uses the domain name of an app as the identifier. However, we don't expect to see breaking behaviour if you have `.env` files like `~/.abra/servers/foo.com/mycoolapp.env` and you still want to run `abra app ps mycoolapp`. `abra` still reads the filename to figure out the identifier. When running `abra app new <recipe>`, `abra` will now take the domain name as the name of the `.env` file.
|
||||
|
||||
- `abra` has a new SSH implementation which enforces SSH host key checking. You may run into connection issues as a result of this code churn, please see [this entry](/abra/trouble/#ssh-connection-issues) for help navigating a fix.
|
||||
|
||||
- CLI flag/args handling has been made more flexible. We're working within the constraints of an upstream library issue but have hopefully made it easier to mange passing flags to commands with `abra`. See [this troubleshooting entry](/abra/trouble/#command-line-flag-handling-is-weird) for the full review.
|
||||
|
||||
- A number of short style flags have been re-mapped and/or added. This is again related to an issue with the upstream CLI library which sometimes understands short style flags as long style flags. E.g. `--ch` instead of `-ch` for `--chaos`. As a concrete example, `--ch` is now `-C` on `abra app deploy`.
|
||||
|
||||
- `abra app backup` & `abra app restore` are ready for alpha-testing! See [this entry](https://docs.coopcloud.tech/maintainers/handbook/#how-do-i-configure-backuprestore) and [that entry](https://docs.coopcloud.tech/operators/handbook/#how-do-i-backuprestore-my-app) for more.
|
||||
|
||||
- `abra server add --traefik` went away, it was too unreliable & hard to maintain.
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: FAQ
|
||||
---
|
||||
|
||||
## What is the Co-op Cloud Federation?
|
||||
|
||||
> We're still working things out, here's what know so far!
|
||||
|
||||
* It's membership based
|
||||
* It's operates democratically
|
||||
* It's about mutualising resources and sharing
|
||||
* We want to do nice things together
|
||||
|
||||
## How many votes makes quorom for a Large Decision?
|
||||
|
||||
According to [Resolution 001](/federation/resolutions/passed/001), large decisions can pass when:
|
||||
|
||||
> more than 50% of total number of federation members :+1: votes
|
||||
|
||||
Please see [the membership docs](/federation/membership) to get the up-to-date membership listing and find the final count for quorom.
|
||||
|
||||
## How do I join the federation?
|
||||
|
||||
According to [Resolution 002](/federation/resolutions/passed/002):
|
||||
|
||||
> To join the federation an existing member must create a large decision to approve of the new member (paid or solidarity).
|
||||
|
||||
So, please [get in touch](/intro/contact) if you'd like to join!
|
||||
@@ -0,0 +1,75 @@
|
||||
---
|
||||
title: Finance
|
||||
---
|
||||
|
||||
> If you have any questions or run into problems, please chat with us on
|
||||
> `#coopcloud-finance:autonomic.zone`
|
||||
|
||||
## Agreeing to spend money (Budgets)
|
||||
|
||||
|
||||
|
||||
## Sending and receiving money
|
||||
|
||||
It's slightly complicated, because money is complicated, but here's how it works. There are two moving parts:
|
||||
|
||||
* The Co-op Cloud Open Collective
|
||||
* The Autonomic Wise account
|
||||
|
||||
Autonomic is [the fiscal host](https://docs.opencollective.com/help/fiscal-hosts/fiscal-hosts) for the Co-op Cloud Open Collective (OC).
|
||||
|
||||
OC helps us make all expenses and transfers transparent to the Federation. No actual money is handled via the OC interface. All payments are done via the Autonomic [Wise](https://wise.com) account. The total sum of the available funds shows on the OC page is the actual amount that is held in the Autonomic Wise account.
|
||||
|
||||
Autonomic Co-op members commit to support the federation by doing the financial adminstration work for the time being. Autonomic is publicy registered, has a bank account, files taxes etc. All financial comings/goings are kept on the books internally at Autonomic. This could be further mutualised or another collective could pick this up in the future.
|
||||
|
||||
Autonomic does not eat the transfer costs from the Wise account when paying out expense for members. That is charged to the Federation common fund.
|
||||
|
||||
### How to get paid via Open Collective
|
||||
|
||||
* [Create an account on Open Collective](https://opencollective.com/create-account)
|
||||
* Go to the [Co-op Cloud Open Collective](https://opencollective.com/coop-cloud)
|
||||
* Click [SUBMIT EXPENSE](https://opencollective.com/coop-cloud/expenses/new)
|
||||
|
||||
**Important** Please include bank details in your expense so that we can make a bank transfer. We do not currently support payments via Paypal and other platforms.
|
||||
|
||||
If you urgently need the money, please let us know on the Co-op Cloud Finance channel.
|
||||
|
||||
Finally, please let us know what your username/email is for your Open Collective account so we can add you to the team. This helps us build up the view of our community from the perspective of our Open Collective page.
|
||||
|
||||
### How to pay someone via Wise
|
||||
|
||||
> **Note**: only Autonomic Co-op members can do this
|
||||
|
||||
* First off, be wary of two things: 1) the currency conversion 2) the transaction fees of Wise. For 1) we have the complicating factor that the OC represents the common fund in GBP but our internal Wise jar is EUR. Then you're getting deeper into trouble if someone wants to get paid in e.g. USD.
|
||||
|
||||
* In order to cover the transaction fee, you need to fake do the transfer to see what you'll be charged and then add that to what you withdraw from the jar. This is because Autonomic does not eat the cost of the transfer from Wise, that is charged to the Federation.
|
||||
|
||||
* First step is to withdraw cash from the Co-op Cloud jar. It will automatically be transferred to the general EUR jar because the Co-op Cloud jar is also in EUR.
|
||||
|
||||
* To transfer to USD, you don't have to use USD, you can use GBP/EUR directly. It's easier to make the direct payment from the jar you transferred it to. This is purely because it is easier to follow it in the accounting bookkeeping later on.
|
||||
|
||||
* When making the payment, do the following:
|
||||
* Select international transfer, choose your requird `$currency`
|
||||
* Put correct amount in "recipient gets exactly" to get Wise to figure out the correct amount
|
||||
* Open the invoice in Open Collective and look for the expense number, e.g. "Expense #132373" and put this in the reference number of the payment
|
||||
* Note how long the transfer will take (Wise should tell you)
|
||||
|
||||
* Mark the expense as paid in Open Collective. Use the "manual" method.
|
||||
|
||||
* Let the member know the payment is on the way and how long it will take (if you have time).
|
||||
|
||||
#### FAQ
|
||||
|
||||
##### Where are the bank details of federation members?
|
||||
|
||||
Please see [`Finance.md` in the internal Federation Wiki](https://git.coopcloud.tech/Federation/organising/wiki/Finance)
|
||||
|
||||
##### What transfer type do we use for USD?
|
||||
|
||||
`ACH`. If you see `Abartn`, that is the `ACH routing number`.
|
||||
|
||||
### Tiers on Open Collective
|
||||
|
||||
* Infrastructure Sustainability: Folks who are making use of Co-op Cloud digital infrastructure (e.g. [git.coopcloud.tech](https://git.coopcloud.tech)) and want to help out with maintenance costs. All recurring donations are spent directly on running costs and system adminstration labour. Thanks for considering!
|
||||
|
||||
* Federation Membership: Dues paid by members of the Co-op Cloud Federation. Please see "Resolution 002: Membership/Dues 2023-03-22" for more information. There may be further decisions made around dues, please refer to the Federation documentation on [docs.coopcloud.tech/federation](https://docs.coopcloud.tech/federation).
|
||||
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Federation
|
||||
---
|
||||
|
||||
Welcome to the Co-op Cloud Federation documentation!
|
||||
|
||||
This is the public facing page where we publish all things federation in the open.
|
||||
|
||||
- [FAQ](/federation/faq): Take a look if you're curious about the Federation is about 🤓
|
||||
- [Resolutions](/federation/resolutions): All draft, in-progress and passed resolutions ✊
|
||||
- [Finance](/federation/finance): How we deal with money 💸
|
||||
- [Membership](/federation/membership): See who's already joined in 🥰
|
||||
- [Minutes](/federation/minutes): All minutes from our meetings 📒
|
||||
- [Digital tools](/federation/tools): Tools we use to organise online 🔌
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
title: Membership
|
||||
---
|
||||
|
||||
> Are you also interested in joining the federation? Please see [Resolution 002](/federation/resolutions/passed/002/) for our process on how to join. If you have any questions, [drop us a line](/intro/contact/) with us for a chat
|
||||
|
||||
| Name | Dues paid up? | Notes | Contact |
|
||||
| -------- | -------- | -------- |-------- |
|
||||
| Agaric | - | - | `@wolcen:matrix.org` |
|
||||
| Flancia | - | - | `@vera:fairydust.space` |
|
||||
| Autonomic | - | - | `@3wc` `@cas` `@decentral1se` `@knoflook` `@travvy` |
|
||||
| Bonfire | - | - | `@mayel:matrix.org` + Ivan (`@cambriale:matrix.org`) |
|
||||
| Doop.coop | - | - | `@yusf:gottsnack.net` |
|
||||
| Local IT | - | - | Philipp (`@yksflip:matrix.kaputt.cloud`) + `@moritz:matrix.local-it.org` |
|
||||
| ruangrupa | - | - | Henry `@babystepper:matrix.org` |
|
||||
| UTAW | - | - | `@javielico:matrix.org` |
|
||||
| ??? | - | - | `@mirsal:1312.media` |
|
||||
@@ -0,0 +1,319 @@
|
||||
---
|
||||
title: 2022-03-03
|
||||
---
|
||||
|
||||
## Co-op Cloud Federation Bootstrapping
|
||||
|
||||
_Please add any suggested agenda items here. We'll add meeting notes to this page after the meeting has happened_
|
||||
|
||||
## Metadata
|
||||
|
||||
* Time / date: March 3 @ 1500-1630 UTC https://time.is/0300PM_3_Mar_2023_in_UTC
|
||||
* Location: https://meet.jit.si/coop-cloud-federation-bootstrap-meeting
|
||||
* Real-time note taking will happen at: https://pad.autonomic.zone/XVhRKvAaRHmaEIR14KBxLA# (and be migrated here after the meeting)
|
||||
|
||||
## Agenda
|
||||
|
||||
(All times UTC, as sharp as possible)
|
||||
|
||||
| Start | End | Topic | Time |
|
||||
| -------- | -------- | -------- | -------- |
|
||||
| 1500 | - | Meeting opens | - |
|
||||
| 1500 | 1510 | introductions | 10m |
|
||||
| 1510 | 1520 | confirming the agenda | 10m |
|
||||
| 1520 | 1540 | decision-making process | 20m |
|
||||
| 1540 | 1450 | break | 10m |
|
||||
| 1450 | 1610 | small-group discussions | 20m |
|
||||
| 1610 | 1630 | report-back / next steps | 20m |
|
||||
|
||||
Suggested topics for small-group discussions:
|
||||
|
||||
1. What software tools do we want to use for our organising?
|
||||
2. How should the finances of the federation work?
|
||||
3. Where else can we promote Co-op Cloud?
|
||||
4. Development priorities
|
||||
|
||||
## Meeting notes
|
||||
|
||||
### Agenda
|
||||
|
||||
(All times UTC, as sharp as possible)
|
||||
|
||||
| Start | End | Topic | Time |
|
||||
| -------- | -------- | -------- | -------- |
|
||||
| 1500 | - | Meeting opens | - |
|
||||
| 1500 | 1510 | introductions | 10m |
|
||||
| 1510 | 1520 | confirming the agenda | 10m |
|
||||
| 1520 | 1540 | decision-making process | 20m |
|
||||
| 1540 | 1450 | break | 10m |
|
||||
| 1450 | 1610 | small-group discussions | 20m |
|
||||
| 1610 | 1630 | report-back / next steps | 20m |
|
||||
|
||||
Suggested topics for small-group discussions:
|
||||
|
||||
1. What software tools do we want to use for our organising?
|
||||
2. How should the finances of the federation work?
|
||||
3. Where else can we promote Co-op Cloud?
|
||||
4. Development priorities
|
||||
|
||||
### Introductions
|
||||
|
||||
- name
|
||||
- pronouns
|
||||
- co-op you're part of
|
||||
- favorite natural place
|
||||
|
||||
Attending:
|
||||
|
||||
* Trav (Autonomic) [facilitation]
|
||||
* dc1 (Autonomic)
|
||||
* Phillip (Local-IT)
|
||||
* kawaiipunk (Autonomic)
|
||||
* V (Flancia [coop] - https://anagora.org [software platform])
|
||||
* Cas (Autonomic) [main notes]
|
||||
* Josef (Doop-Coop)
|
||||
* Wolcen (Agaric)
|
||||
* Ivan (Bonfire)
|
||||
* Mayel (Bonfire)
|
||||
* Calix (Autonomic) [facilitation]
|
||||
* Jamie (FarmOS)
|
||||
* Mirsal
|
||||
|
||||
### Confirming Agenda
|
||||
|
||||
- V: Question about overall objective.
|
||||
- Calix: Any suggested answers?
|
||||
- dc1: To see who wants to come with on setting up the fed. Getting going making descisions together. Also how people see themselves participating on an ongoing basis.
|
||||
- Calix: Any other intentions?
|
||||
|
||||
[Mirsal joins]
|
||||
|
||||
Recap:
|
||||
- How to make Decisions
|
||||
|
||||
- Wolcen: Is there an existing org or is this the start?
|
||||
- Trav: This is the kick off. We start here.
|
||||
- dc1: Points to proposal. Mostly from Autonomic's viewpoint, which we hope to build on.
|
||||
|
||||
- V: Asking about transcription bots.
|
||||
- Calix: Suggests that we table for now for later discussion.
|
||||
|
||||
### decision-making process
|
||||
|
||||
proposal: https://git.coopcloud.tech/Federation/Federation/wiki/Proposals
|
||||
|
||||
- Trav: We adapted an old proposal for descision making process.
|
||||
- https://pad.autonomic.zone/s/MLafJE2jC#Overview
|
||||
- https://coopcloud.tech/blog/federation-proposal/
|
||||
|
||||
- Trav: We consider this an important step in group formation. Summary: Proposal is written up and posted on channel, voting occurs via emoji reactions and after a time period it is passed.
|
||||
- dc1: Context: Autonomic has been initiating the project heretofor and has made all descisions, but we want the community to have that power rather than Autonomic.
|
||||
|
||||
- Calix: We are in bootstraps as far as descision making so we have hope we can do it ad hoc this time.
|
||||
|
||||
- V: Question about using Loomio.
|
||||
|
||||
- kawaiipunk: Loomio while it is good seems to have a lot of bloat to it and the complexity of the forum functionality. Proposes we try to the most minimal mechanics possible. Autonomic uses this process.
|
||||
Calix: We don't have SSO for Coopcloud that we all have access. Gitea is a good platform for bootstrapping since it has its own accounts and almost everyone already has accounts on it for functional reasons.
|
||||
Wolcen: keeping things in as few places as possible seems better.
|
||||
- dc1: +1 for minimal. We are at the start, and all things are vague so we perhaps just do the minimal possible and keep going with what we have
|
||||
|
||||
- V: As a member of not autonomic lacking context. tnx to dc1 for clarifying.
|
||||
|
||||
- Wolcen: Asks about technology for automating the gitea+wiki->matrix crossover.
|
||||
- dc1: No automation current we can always change that later
|
||||
|
||||
- kawaiipunk: Would the voting proposal come into effect after this meeting. Propose that it should. - Explanation that we operate more on a consent basis than exactly a consensus and this proposal continues that.
|
||||
|
||||
- Wolcen: Asks about how to determine the magnitude of a descision and when the proposal can be acted on based on votes.
|
||||
- dc1: General descions are made as more than one person. This informs how to do the calculation for the magnitude.
|
||||
- kawaiipunk: Medium descisions can pass without everyone interacting with them. Good descisions are transparent and reversable. Controversial things generally have more than one blocker.
|
||||
|
||||
### break time
|
||||
|
||||
### Roundup about breakouts
|
||||
|
||||
### Checking on qualified yes answers on poll about descision making
|
||||
|
||||
1 qualified yes. Giving space for the qualifications. No takers.
|
||||
|
||||
- V: Suggests that Autonomic lead that choice.
|
||||
- kawaiipunk: Agrees. If we're following consensus, unless anyone blocks it passes.
|
||||
|
||||
**We pass the descision making process.**
|
||||
|
||||
### Breakouts
|
||||
|
||||
* Calix: Suggestions for other breakout topics?
|
||||
|
||||
* Wolcen: 1 & 4 seem closely tied and should be merged.
|
||||
|
||||
* dc1: Membership should be a topic.
|
||||
|
||||
* We vote on poll now.
|
||||
|
||||
#### Breakout 1 + 3 (technology and technology)
|
||||
|
||||
> (See notes below)
|
||||
|
||||
We summarized where we're at, what technologies are being used for organizing, what are the dependencies for coop cloud, and what is being developed.
|
||||
|
||||
A couple of little things that are interesting from the perspective of development priorities:
|
||||
|
||||
- debug / entrypoint tools
|
||||
- catalog normalization
|
||||
|
||||
#### Breakout 2 (finances)
|
||||
|
||||
> (See notes below)
|
||||
|
||||
Summary: Federation model has tried and failed several times. Priority should be getting some money in. Give what you can should be the main thing and we can see if we need to tweak that.
|
||||
|
||||
#### Breakout 4 (membership)
|
||||
|
||||
> (See notes below)
|
||||
|
||||
Broke down what membership means. Three classes of membership and what their powers are.
|
||||
|
||||
- Community member (individual level)
|
||||
- Recipe maintainer
|
||||
- Federation members - which is the main descion making member.
|
||||
|
||||
Discussed the processes involved in creating members, as in notes.
|
||||
|
||||
MVP is protection from capital interest. Existing members vote on new members? Minimal and lean.
|
||||
|
||||
### We vote on next meeting time
|
||||
|
||||
### Checkout process
|
||||
|
||||
> How do you feel? What about future?
|
||||
|
||||
* Calix: Feeling inspired. Topics would love to talk about: Working groups? What comms channels are needed?
|
||||
|
||||
* V: Feeling amazing. In one month?
|
||||
|
||||
* dc1: Feeling great, very productive. Looking forward to future.
|
||||
|
||||
* Trav: Great! THink this works well. Good that we can actually make descisions. Excited and optimistic for future.
|
||||
|
||||
* Mayel: Feel good about meeting. Really good to see energies. Great awesome keep going.
|
||||
|
||||
* Wolcen: Feels great. Good to see it making progress. Missed meeting pad - having official links for future meetings would be nice to have.
|
||||
|
||||
* Cas: Great. Looking forward to nitty gritty stuff.
|
||||
|
||||
* kawaiipunk: Tired, but good. Good discussions. Excited to have it open up to other people. Maybe we could hack on technical stuff. Interested in recipes and doing more formal organization.
|
||||
|
||||
* Phillipp: Excited this was really great. Language barrier made it a little challenging. Next meeting has a lot of questions and things to do.
|
||||
|
||||
### Poll
|
||||
|
||||
* 1 month wins for next meeting.
|
||||
|
||||
### Breakout room minutes
|
||||
|
||||
#### Breakout room #1
|
||||
|
||||
We have a rambling discussion about things related to software.
|
||||
|
||||
List of technologies currently in use:
|
||||
|
||||
- gitea [wiki, source repo, kanban?]
|
||||
- matrix [chat, community organization]
|
||||
|
||||
Technologies under development/coop cloud
|
||||
|
||||
- Abra
|
||||
- Recipes
|
||||
- Recipe catalog
|
||||
|
||||
Technology dependencies
|
||||
|
||||
- Docker + swarm
|
||||
|
||||
Technology decision considerations
|
||||
|
||||
- What about using other 'containers', 'virtual instances', etc?
|
||||
- Part of the value proposition is that it operates on current standards.
|
||||
|
||||
Development priorities
|
||||
|
||||
- Standardizing recipe catalog acquisition
|
||||
- Debug/other hooks/entrypoints
|
||||
|
||||
#### Breakout room #2
|
||||
|
||||
Breakout Room #2: How should the finances of the federation work?
|
||||
|
||||
* Present: Trav, Mayel, yksflip, d1, V
|
||||
* trav taking notes
|
||||
|
||||
* d1: want to map what we're already doing. At first unpaid then back-paid. Grant money is gone. Now asking clients to contribute 50% of fee towards Co-op Cloud development. Have not dumped money into OC yet.
|
||||
|
||||
* V: why tell clients? Transparency?
|
||||
|
||||
* d1: yeah transparency, helps get paid out and helps groups understand what they're contributing to.
|
||||
|
||||
* m: some part of revenue goes back to maintain commons. we know theres more than the config, we have admin, meetings, more services/tools/etc. besides membership dues, I would draft some suggestions/templates for how hosters can split revenue between infra/config/upstream project development...
|
||||
|
||||
* yksflip: contribute time to co-op cloud atm. but happy to shuffle money directly to open collective. main funding is public funding, funders need to see who is working on what, transparency/overview stuff. they also have money to give to freelancers. could we have ways to say we give % of the project to the open collective of the fedi. still trying to make local-it sustainable. funding until july and then open question how to go on sustainably.
|
||||
|
||||
* t: concern on finances is, having enough. paying for meetings is noble but we'll lose money fast. having a prioritisation of where money goes would be great. then as we have cash we put it where we want.
|
||||
|
||||
* d1: contribute comensurate to number of members in co-op? what would be a practical model? do we attach it to membership (dues?).
|
||||
|
||||
* v: dues and per-x contribution? are these two differen things?
|
||||
|
||||
* d1: 2 approaches, end goal is the same, have members contribute to the project
|
||||
|
||||
* V: we are amalgum, hard to quantify member #s
|
||||
|
||||
* yksflip: best to start with something easy. Co-ops of this size/# of instance, guidelines. Try it and then discuss again in a few months. Compensating meetings is great but maybe some things are more urgent.
|
||||
|
||||
* V: how does Autonomic do this currently?
|
||||
|
||||
* d1: simpler for us as 1 org vs fed. All funds into 1 pot. Tricky to get right. Did call with Co-op Cycle, bike delivery. Start with financial contribution from the start. Money makes things happen.
|
||||
|
||||
#### Breakout #3 did not happen
|
||||
|
||||
#### Breakout #4: Membership
|
||||
|
||||
* Jamie (facilitating)
|
||||
* Kawaiipunk
|
||||
* Calix (notes)
|
||||
|
||||
What are we hoping to learn / decide?
|
||||
|
||||
* kp: 3 levels of membership:
|
||||
* community member
|
||||
* maintainers of recipes
|
||||
* federation members
|
||||
|
||||
* question: boundaries around co-operativeness. open to organisations / individuals? what org. structures permitted for members. co-ops only? worker co-ops only? allied orgs? capitalist orgs? do we allow co-ops
|
||||
|
||||
* calix: Q: what is the process for deciding any of above questions? new members, dues, etc.
|
||||
|
||||
* j: is there a way for e.g. corporate members to be community members? any previous steps towards decision-making with co-op cloud?
|
||||
|
||||
* Calix: Cooperative Technologists [...] when someone wants to joing it's a network-wide process, case-by-case, open to anyone to in the group; then w/ Autonomic, it's a 2-step process where someone joins provisionally, then as full member after a period of time.
|
||||
|
||||
* j: B-Corp, somewhat controversial category at this point as to whether it means anything or not. Consideration to take network approach to avoid "legalistic" approach, strict "by the books".
|
||||
|
||||
* kp: might also be a problem of assessing what counts as a cooperative for international members, different legal formations around the world.
|
||||
|
||||
* c: Proposal: the 3 cats, fed-members should be cooperatively run, and aligned with values of the federation. Large decision among federation members to add a new one.
|
||||
|
||||
* J: Like it. Open it as a question.
|
||||
|
||||
* c: Could use our new decision making process? Ask for comments before it goes live.
|
||||
|
||||
* kp: Seems quite fundamental. Best to keep simple and iterate.
|
||||
|
||||
* calix: should there be a federation members only matrix channel to discuss federation decisions?
|
||||
|
||||
* kp: guess there'd have to be under current plans. or does it set up too much of an "in group"? proposals could be posted publicly, voting could be in secret, results public? emoji voting in a private channel. transparency = positive.
|
||||
|
||||
* jamie: public "who voted how"
|
||||
|
||||
* kp: maybe literally just collecting of voting
|
||||
@@ -0,0 +1,3 @@
|
||||
---
|
||||
title: Minutes
|
||||
---
|
||||
@@ -0,0 +1,3 @@
|
||||
---
|
||||
title: Drafts
|
||||
---
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
title: "Resolution 009: Federation common fund buffer - 2023-07-03"
|
||||
---
|
||||
|
||||
## Resolution 009: Federation common fund buffer - 2023-07-03
|
||||
|
||||
- Deadline: 2023-07-17
|
||||
- Size: Large
|
||||
|
||||
### Summary
|
||||
|
||||
The Co-op Cloud Federation has [a common fund](https://opencollective.com/coop-cloud#category-BUDGET) which can be used by federation members by proposing [budgets](https://docs.coopcloud.tech/federation/resolutions/passed/004/).
|
||||
|
||||
With Resolution 009, we want to introduce the idea of a common fund buffer.
|
||||
|
||||
This buffer is proposed to be set at 1,500 EUR. When the buffer is reached, no more budgets can be proposed. When the fund increases once more, budgets can resume.
|
||||
|
||||
The buffer is in place to reserve funds for critical collective spending when we have limited income.
|
||||
|
||||
### Details
|
||||
|
||||
1,500 EUR is fairly arbitrarily chosen but seems to be a reasonable amount of money to cover situations where, e.g. we need to pay for servers, domains, mail accounts or other common critical infrastructure.
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
title: "Resolution 010: Budget 004: Critical fixes - 2023-07-03"
|
||||
---
|
||||
|
||||
## Resolution 010: Budget 004: Critical fixes - 2023-07-03
|
||||
|
||||
- Deadline: 2023-07-17
|
||||
- Size: Large
|
||||
|
||||
### Summary
|
||||
|
||||
We propose to have a standing budget of 10 hrs / month available for fixes in Abra, Co-op Cloud recipes and other critical tools (e.g. recipes.coopcloud.tech) in the Co-op Cloud ecosystem.
|
||||
|
||||
A fix is deemed critial when it is listed on this coop-cloud/organising board:
|
||||
|
||||
> https://git.coopcloud.tech/coop-cloud/organising/projects/24
|
||||
|
||||
This board is collectively gardened by Co-op Cloud participants (both federation members and not). The process for adding a ticket to the board requires getting confirmation from at least one other member of the federation.
|
||||
|
||||
This budget can be claimed by any volunteer who would like to develop the fix. If the volunteer is not a Co-op Cloud federation member, they must first be "vouched for" by a federation member. This is an informal process which can be arranged via the Matrix chat. This aims to assure agreement on timing and what the fix should contain beforehand.
|
||||
|
||||
Fixes can be claimed by assiging yourself to the ticket. If within 1 week there is no updates on the ticket, another volunteer can propose to take over. This process is also informal: please @ the original volunteer and give some reasonable time for them to reply (suggested: 1 day).
|
||||
|
||||
If the fix is urgent and things need to move faster, please state so on the ticket. Please consult with at least one other member of the federation to confirm that there is indeed agreement on the urgency of the fix.
|
||||
|
||||
### Details (Budget 004)
|
||||
|
||||
**Budget amount**: Any amount, until the common fund buffer is reached.
|
||||
|
||||
**Who will implement this**: Self-organised volunteers.
|
||||
|
||||
**When will the money be spent**: Any time until the common fund buffer is
|
||||
reached.
|
||||
|
||||
**What is the money for**: Critical `abra` fixes.
|
||||
|
||||
This budget stands open and available for use until the common fund buffer is reached. Please see Resolution 009 for further details on the buffer.
|
||||
|
||||
Please see [Resolution 003](https://docs.coopcloud.tech/federation/resolutions/passed/003/) for details on the hourly rate for this work.
|
||||
|
||||
Invoices can be submitted via the Co-op Cloud Open Collective. Please see [these docs](https://docs.coopcloud.tech/federation/finance/#how-to-get-paid-via-open-collective) for how to do that.
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
title: "Resolution 008: Budget 005: Backup improvements - 2023-07-23"
|
||||
---
|
||||
|
||||
- Deadline: 2022-08-06
|
||||
- Size: Large
|
||||
|
||||
### Summary
|
||||
|
||||
Agree Budget 005, for up to 10 hours (€200) to implement changes to the Co-op Cloud backup system, including `abra`, and `backup-bot-two`.
|
||||
|
||||
More information, including background to the changes, and breakdown of the work, can be found here: https://pad.local-it.org/4chDYXkBQZywXKj0zs_Ymg#
|
||||
|
||||
### Details (Budget 005)
|
||||
|
||||
**Budget amount**: Up to EUR €200
|
||||
|
||||
**Who will implement this**: Calix/3wc, decentral1se, Philipp and Moritz
|
||||
|
||||
**When will the money be spent**: Before the end of August 2023.
|
||||
|
||||
**What is the money for**: Improvements to Co-op Cloud backup tools
|
||||
@@ -0,0 +1,3 @@
|
||||
---
|
||||
title: In progress
|
||||
---
|
||||
@@ -0,0 +1,18 @@
|
||||
---
|
||||
title: Resolutions
|
||||
---
|
||||
|
||||
### Resolution Template
|
||||
|
||||
```javascript
|
||||
## Resolution <number>: <title> - <date>
|
||||
|
||||
- Deadline: Date
|
||||
- Size: large or medium
|
||||
|
||||
### Summary
|
||||
Who this affects, and what it does
|
||||
|
||||
### Details
|
||||
A narrative with details
|
||||
```
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
title: "Proposal 001: Decision Making Process - 2023-03-03"
|
||||
---
|
||||
|
||||
- Deadline: 2023-03-03 (live voting)
|
||||
- Size: large
|
||||
|
||||
### Summary
|
||||
|
||||
Institute descision making process as per below. Special consensus voting in organization meeting rather than the below process.
|
||||
|
||||
### Decision Making Process
|
||||
|
||||
* Write up a proposal using the below template, and add to the [Proposals wiki page](https://git.coopcloud.tech/Federation/Federation/wiki/Proposals).
|
||||
* Specify if they are a large or medium proposal
|
||||
* Votes are done via emoji-reaction in the Community Organising Matrix channel (<https://matrix.to/#/#coopcloud-comm-org:autonomic.zone>)
|
||||
* List the decision on the [decisions page](https://docs.coopcloud.tech/federation/resolutions) on our documentation
|
||||
* Decisions can be split intro three categories: Small, Medium and Large.
|
||||
* Votes can be in favour :+1:, against :-1: (block), or abstain :shrug:
|
||||
* Announce the result in the [Federation chat (#coop-cloud-fedi:autonomic.zone)](https://docs.coopcloud.tech/intro/contact/#matrix) and record it on the [decisions page](https://docs.coopcloud.tech/federation/resolutions) of the documentation
|
||||
|
||||
### Types of Proposals
|
||||
|
||||
#### Small - “Get on and do a thing”
|
||||
|
||||
* Up to individual members to decide if they should just make the decision, or share it with the rest of the members to seek consensus.
|
||||
|
||||
#### Medium - “consensus pending objections”
|
||||
|
||||
* Potentially about shared tools, recipes, abra, etc.
|
||||
* Doesn’t have an effect on the direction or operation of Co-op Cloud as a whole.
|
||||
* If any member of Co-op Cloud thinks it’s a Large decision, achieve Maximum Consensus™ (see [below](https://pad.autonomic.zone/PtNbWo-7Tt-CKXvC6kxvZQ?view#Large---Maximum-Consensus-%E2%84%A2))
|
||||
* proposals must have a minimum deadline of 2 weeks from when they are proposed
|
||||
* Pass requirements:
|
||||
* at least one :+1: vote
|
||||
* no :-1: votes
|
||||
|
||||
#### Large - “Maximum Consensus ™”
|
||||
|
||||
* Important decisions affecting the operation, direction, working conditions and finances of Co-op Cloud.
|
||||
* proposals must have a minimum deadline of 2 weeks from when they are proposed
|
||||
* Pass requirements:
|
||||
* more than 50% of total number of federation members :+1: votes
|
||||
* no :-1: votes
|
||||
|
||||
### Proposal Template
|
||||
|
||||
```javascript
|
||||
## Resolution <number>: <title> - <date>
|
||||
|
||||
- Deadline: Date
|
||||
- Size: large or medium
|
||||
|
||||
### Summary
|
||||
Who this affects, and what it does
|
||||
|
||||
### Details
|
||||
A narritive with details
|
||||
```
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: "Resolution 002: Membership/Dues - 2023-03-22"
|
||||
---
|
||||
|
||||
* Deadline: 2023-04-11
|
||||
* Passed on 2023-04-13
|
||||
* Size: Large
|
||||
|
||||
### Summary
|
||||
|
||||
1. Set membership dues for the Co-op Cloud Federation at EUR 10/month, to be reviewed in 6 months’ time, in October 2023.
|
||||
2. Approval of new members requires a Large decision
|
||||
3. Groups who had a member attend the first federation meeting are all founding members (are already in the federation, do not require a decision to be added)
|
||||
|
||||
### Details
|
||||
|
||||
Obviously this plan is not long-term financially sustainable. The idea is to use Autonomic’s remaining funds for the federation to collectivise the process of working this out over the next few months.
|
||||
|
||||
#### Dues
|
||||
|
||||
Members are required to make a minimum monthly EUR 10 (or EUR 60/year) donation through Open Collective. Members who are able are encouraged to donate more. Individuals/groups wanting to join Co-op Cloud who aren’t able to make a financial contribution may request a solidarity free membership.
|
||||
|
||||
#### Membership
|
||||
|
||||
To join the federation an existing member must create a large decision to approve of the new member (paid or solidarity). All collectives who attended the first federation meeting are already granted membership and are asked to setup recurring donations as soon as possible.
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
title: "Resolution 003: Paid work - 2023-03-22"
|
||||
---
|
||||
|
||||
* Deadline: 2023-04-11
|
||||
* Passed on 2023-04-13
|
||||
* Size: Large
|
||||
|
||||
### Summary
|
||||
|
||||
1. Set the wage for Co-op Cloud Federation work at €20/h. Review these numbers in 6 months’ time, in October 2023.
|
||||
|
||||
### Details
|
||||
|
||||
Work is paid at EUR 20/hour. This may be increased via future decisions if so desired by the collective.
|
||||
|
||||
Members must do their own taxes for wages earned. To get paid, worker members must invoice via the Co-op Cloud Open Collective. Invoices need to include times and descriptions.
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
title: "Resolution 004: Budgeting - 2023-03-22"
|
||||
---
|
||||
|
||||
* Deadline: 2023-04-11
|
||||
* Passed on 2023-04-13
|
||||
* Size: Large
|
||||
|
||||
### Summary
|
||||
|
||||
1. All paid work must be within a Budget
|
||||
2. The first Budget as 8 hours / month, for member groups’ participation in organising meetings
|
||||
|
||||
### Details
|
||||
|
||||
All paid work must be within a Budget, agreed using a Large Decision. Budgets are ideally clumped as much as possible to reduce decision fatigue. Budgets include “who will do the work”. The agreed person can give the task to another Federation member.
|
||||
|
||||
Participation in organising meetings is paid for up to one person per member organisation. Additional people are welcome to attend; we encourage member organisations to pay for their additional attendees’ time themselves, if possible.
|
||||
|
||||
#### Budget: Monthly meetings
|
||||
|
||||
> **Budget amount:** EUR 960
|
||||
>
|
||||
> **Who will implement this:** Up to 1 person from each member organisation
|
||||
>
|
||||
> **When will the money be spent:** Over the next 6 months, until the meeting in October 2023.
|
||||
>
|
||||
> **What is the money for:** Paying attendees of monthly organising meetings
|
||||
|
||||
#### Budget template:
|
||||
|
||||
```
|
||||
**Budget name:** Buying ponies
|
||||
**Budget amount:** EUR 100,000
|
||||
**Who will implement this:** Ade from Ponies.coop
|
||||
**When will the work happen:** Tomorrow
|
||||
**What is the money for:: Buying one pony for each member organisation
|
||||
```
|
||||
@@ -0,0 +1,19 @@
|
||||
---
|
||||
title: "Resolution 005: Public federation membership, notes and decisions - 2023-04-14"
|
||||
---
|
||||
|
||||
* Deadline: 2023-04-17
|
||||
* Passed: 2023-04-18
|
||||
* Size: medium
|
||||
|
||||
### Summary
|
||||
|
||||
The following federation info will be made public on [`docs.coopcloud.tech/federation`](https://docs.coopcloud.tech/federation/):
|
||||
|
||||
- Federation membership
|
||||
- Meeting minutes
|
||||
- Decisions which have passed
|
||||
|
||||
### Details
|
||||
|
||||
This will make the process of documenting easier to mutualise and increase transparency for those interested in joining. The [`git.coopcloud.tech/Federation`](https://git.coopcloud.tech/Federation/Federation/wiki/) wiki can still be used for storing private details such as bank account information. If members do not want to be listed, they can do so even when this decision passes.
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: "Resolution 006: Budget 002: Resolution Writing-up - 2023-05-29"
|
||||
---
|
||||
|
||||
# Resolution 006: Budget 002: Resolution Writing-up - 2023-05-29
|
||||
|
||||
- Deadline: 2022-06-12
|
||||
- Size: Large
|
||||
|
||||
### Summary
|
||||
|
||||
Agree Budget 002, for €100 for @decentral1se to write up 2 resolutions.
|
||||
|
||||
### Details (Budget YYY)
|
||||
|
||||
**Budget amount**: EUR 100
|
||||
|
||||
**Who will implement this**: @decentral1se
|
||||
|
||||
**When will the money be spent**: By 2023-07-03
|
||||
|
||||
**What is the money for**: Writing up two Resolutions:
|
||||
|
||||
1. A buffer for federation common fund.
|
||||
2. To set up a standing critical fixes budget each month until the buffer in (1) is hit
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
title: "Resolution 007: 1 year dues waiver for Doop.coop - 2023-06-19"
|
||||
---
|
||||
|
||||
- Deadline: 2023-07-03
|
||||
- Size: Medium
|
||||
|
||||
### Summary
|
||||
|
||||
Waive membership dues for Doop.coop for the first year of their membership, from July 2023 to June 2024.
|
||||
|
||||
### Details
|
||||
|
||||
Yusf said:
|
||||
|
||||
> Hai! As our coop is a side gig, we've had a very low turnaround in the coop last fiscal. As such we've hadn't had the time to raise our revenue yet in this cycle so my question for the federation is:
|
||||
> Is it possible for us (already joined), Doop Coop, to apply for this solidarity free membership the first year after which we'll be able to put in the fee?
|
||||
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "Resolution 008: Budget 003: Paying invoices - 2023-06-19"
|
||||
---
|
||||
|
||||
- Deadline: 2022-07-03
|
||||
- Size: Large
|
||||
|
||||
### Summary
|
||||
|
||||
Agree Budget 003, for up to €20/month for an Autonomic member to pay invoices submitted for Co-op Cloud Federation work.
|
||||
|
||||
### Details (Budget 003)
|
||||
|
||||
**Budget amount**: EUR €20/month
|
||||
|
||||
**Who will implement this**: Autonomic
|
||||
|
||||
**When will the money be spent**: Monthly
|
||||
|
||||
**What is the money for**: Paying for the work involved in paying invoices submitted via OpenCollective.
|
||||
|
||||
## A note about decentralisation
|
||||
|
||||
Unfortunately, there doesn't seem to be a good way to open this task to other Co-op Cloud Federation members, until we get a dedicated bank account for the Federation, but if anyone has ideas about this, please let us know!
|
||||
@@ -0,0 +1,11 @@
|
||||
---
|
||||
title: Digital tools
|
||||
---
|
||||
|
||||
- [Public documentation](https://docs.coopcloud.tech/federation)
|
||||
- [Organising repository (private)](https://git.coopcloud.tech/Federation/organising)
|
||||
- [Wiki (private)](https://git.coopcloud.tech/Federation/organising/wiki)
|
||||
- [Git hosting](https://git.coopcloud.tech/)
|
||||
- [Matrix Space](https://matrix.to/#/#coop-cloud-space:autonomic.zone)
|
||||
- [Website](https://coopcloud.tech/)
|
||||
- [Drone CI/CD](https://build.coopcloud.tech)
|
||||
@@ -6,21 +6,17 @@ title: Get Involved
|
||||
|
||||
> :trumpet: **You don't have to be a programmer to contribute to this project!** :trumpet:
|
||||
|
||||
Firstly, come say hello in our [chat room](/intro/contact/) if you'd like to help out or re interested to learn how :wave:
|
||||
Firstly, come say hello in our [chat room](/intro/contact/) if you'd like to help out or are interested to learn how :wave:
|
||||
|
||||
We are happy to have designers, critical thinkers, artists, hackers, documenters, etc. involved in this project! There is a lot of work to do, if you find this project interesting, we want to have you working with us.
|
||||
|
||||
There are a number of "roles" such as "operator", "maintainer", "organiser" which we've tried to come up with to make it more clear how you can relate to the project and how you can find ways to be involved which suit your interests. If you don't fit one of these roles, that is fine.
|
||||
|
||||
We have [a weekly check-in](/get-involved/#kite-flying-hours) for contributors of this project to let each other know what we're working on, how much time we've spent on it and how to coordinate further work.
|
||||
We have [an irregular online check-in](/organisers/handbook/#kite-flying-hours) for contributors of this project to let each other know what we're working on, how much time we've spent on it and how to coordinate further work.
|
||||
|
||||
We have a [status page](/intro/bikemap) showing what we are aiming to achieve in the near future. That gives a good overview of where we're going together.
|
||||
|
||||
From this status page, we use an [issue tracker](https://git.coopcloud.tech/coop-cloud/organising/issues) where we hold discussions about what we want to do. We categorise these issues according to the bike map using these [milestones](https://git.coopcloud.tech/coop-cloud/organising/milestones). Finally, use this [board](https://git.coopcloud.tech/coop-cloud/organising/projects/8) to keep track of what we're working on right now. We collectively review these things on a weekly/monthly basis to keep track of our time spent vs. budget available.
|
||||
|
||||
Once you've found something to work on and are introduced, we'll give you an account on our [time tracking infrastructure](https://kimai.autonomic.zone) where you can log your times. This helps us reduce the burden of financial and time keeping admin falling on one person.
|
||||
|
||||
We have received funding via [the ECF](https://culturalfoundation.eu/initiatives/culture-of-solidarity-fund) and can offer £16 hourly rate for your work. We've written more on why we think it is important to compensate all contributions for this project below.
|
||||
We use [issue trackers](https://git.coopcloud.tech/coop-cloud/organising/issues) and [project boards](https://git.coopcloud.tech/coop-cloud/organising/projects) to keep track of what we're working on right now. We collectively review these, to keep track of our time spent vs. budget available.
|
||||
|
||||
## Compensation
|
||||
|
||||
|
||||
+11
-11
@@ -12,11 +12,11 @@ An app is a libre software that you use, e.g. Wordpress, Gitea, Jitsi, Nextcloud
|
||||
|
||||
## Container
|
||||
|
||||
A [Docker](/glossary#docker) term: a running instance of an [image](/glossary#image), running processes that are isolated from the host system.
|
||||
A [Docker](#docker) term: a running instance of an [image](#image), running processes that are isolated from the host system.
|
||||
|
||||
## Deployment
|
||||
|
||||
When you run `abra app deploy <domain>`, `abra` reads a [recipe](/glossary#recipe) configuration and creates an [app](/glossary#app).
|
||||
When you run `abra app deploy <domain>`, `abra` reads a [recipe](#recipe) configuration and creates an [app](#app).
|
||||
|
||||
## Docker
|
||||
|
||||
@@ -24,36 +24,36 @@ When you run `abra app deploy <domain>`, `abra` reads a [recipe](/glossary#recip
|
||||
|
||||
## Environment variables
|
||||
|
||||
Variables passed from the shell to processes invoked by it. They are used for configuring [services](/glossary#service).
|
||||
Variables passed from the shell to processes invoked by it. They are used for configuring [services](#service).
|
||||
|
||||
## Environment file
|
||||
|
||||
A file contained in a [recipe](/glossary#recipe) describing the contents of [environmental variables](/glossary#environment-variables).
|
||||
A file contained in a [recipe](#recipe) describing the contents of [environment variables](#environment-variables).
|
||||
|
||||
## Image
|
||||
|
||||
A [Docker](/glossary#docker) term: a template for creating [containers](/glossary#container), describing their file structure and installed binaries.
|
||||
A [Docker](#docker) term: a template for creating [containers](#container), describing their file structure and installed binaries.
|
||||
|
||||
## Proxy network
|
||||
|
||||
A [Docker](glossary#docker) related concept: a virtual network created on the server machine used for communicating between [services](/glossary#service). Any [service](/glossary#service) can be plugged into more than one [network](/glossary#network), allowing for control over data sharing between them.
|
||||
A [Docker](#docker) related concept: a virtual network created on the server machine used for communicating between [services](#service). Any [service](#service) can be plugged into more than one [network](#network), allowing for control over data sharing between them.
|
||||
|
||||
## Recipe
|
||||
|
||||
A recipe is what we call the configuration files that are used to deploy an [app](/glossary#app). When you run `abra app deploy <domain>`, `abra` is reading a recipe configuration, such as [the gitea recipe](https://git.coopcloud.tech/coop-cloud/gitea), in order to know how to deploy a new Gitea instance. When we speak of a "digital configuraiton commons", we're primarily referring to the [growing collection of recipes](https://git.coopcloud.tech/coop-cloud).
|
||||
A recipe is what we call the configuration files that are used to deploy an [app](#app). When you run `abra app deploy <domain>`, `abra` is reading a recipe configuration, such as [the gitea recipe](https://git.coopcloud.tech/coop-cloud/gitea), in order to know how to deploy a new Gitea instance. When we speak of a "digital configuration commons", we're primarily referring to the [growing collection of recipes](https://recipes.coopcloud.tech).
|
||||
|
||||
## Secret
|
||||
|
||||
A [Docker](/glossary#docker) related concept: A way to store passwords encrypted on disk and mounted inside the [containers](/glossary#container) as files that can be read that contain the secret. See the [Docker secrets documentation for more](https://docs.docker.com/engine/swarm/secrets/). `abra` makes use of this approach to store secrets for deployed [apps](/glossary#app).
|
||||
A [Docker](#docker) related concept: A way to store passwords encrypted on disk and mounted inside the [containers](#container) as files that can be read that contain the secret. See the [Docker secrets documentation for more](https://docs.docker.com/engine/swarm/secrets/). `abra` makes use of this approach to store secrets for deployed [apps](#app).
|
||||
|
||||
## Service
|
||||
|
||||
A [Docker](glossary#docker) term: a single [container](/glossary#container) that is a part of a [stack](glossary#stack).
|
||||
A [Docker](#docker) term: a single [container](#container) that is a part of a [stack](#stack).
|
||||
|
||||
## Stack
|
||||
|
||||
A [Docker](glossary#docker) term: one or more [services](/glossary#service) running together to provide a functionality.
|
||||
A [Docker](#docker) term: one or more [services](#service) running together to provide a functionality.
|
||||
|
||||
## Volume
|
||||
|
||||
A [Docker](/glossary#docker) term: a directory that can be mounted inside a [container](/glossary#container) to store data. Because [containers](/glossary#container) are meant to be non-changeable and disposable, any data that is supposed to not be lost between updates or restarts is stored in volumes.
|
||||
A [Docker](#docker) term: a directory that can be mounted inside a [container](#container) to store data. Because [containers](#container) are meant to be non-changeable and disposable, any data that is supposed to not be lost between updates or restarts is stored in volumes.
|
||||
|
||||
+2
-2
@@ -16,9 +16,9 @@ We'd be happy to hear feedback about our documentation, if it was helpful, what
|
||||
|
||||
!!! danger "Here be dragons"
|
||||
|
||||
This project is still [alpha quality software](https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha) :bomb: Please take that into consideration if you are thinking about using this system in production. We're working hard to make Co-op Cloud stable. In the meantime, this is a good time to help us out with initial testing, feedback, ideas or [join in with development](/get-involved/).
|
||||
This project is still [beta quality software](https://en.wikipedia.org/wiki/Software_release_life_cycle#Beta) :bomb: Please take that into consideration if you are thinking about using this system in production. We're working hard to make Co-op Cloud stable. In the meantime, this is a good time to help us out with initial testing, feedback, ideas or [join in with development](/get-involved/).
|
||||
|
||||
- [Operators guide](/operators/): You run a Co-op Cloud deployment or want to do so :computer:
|
||||
- [Operators guide](/operators/): You run a Co-op Cloud based deployment or want to do so :computer:
|
||||
|
||||
- [Maintainers guide](/maintainers/): You maintain recipes and ensure things run smoothly for operators :tools:
|
||||
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
title: Bike map
|
||||
---
|
||||
|
||||
- The project is currently in an [alpha quality](https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha) release state.
|
||||
- The project is currently in a [beta quality](https://en.wikipedia.org/wiki/Software_release_life_cycle#Beta) release state.
|
||||
|
||||
- We are working towards a [beta release](https://en.wikipedia.org/wiki/Software_release_life_cycle#Beta). Our public Beta goals are listed in the following pad: [Beta Bike Map](https://pad.autonomic.zone/s/C3uuqfSCk).
|
||||
- We are working towards a stable `1.0.0` release.
|
||||
|
||||
- What we're currently working on is listed on this issue tracker: [`coop-cloud/organising`](https://git.autonomic.zone/coop-cloud/organising/issues).
|
||||
- What we're currently working on is listed on this issue tracker: [`coop-cloud/organising`](https://git.coopcloud.tech/coop-cloud/organising/issues).
|
||||
|
||||
@@ -12,14 +12,6 @@ title: Get in touch
|
||||
|
||||
Here is a link to the [Matrix space](https://matrix.to/#/!xSMwGbdVehScXcIFwS:autonomic.zone?via=autonomic.zone&via=matrix.org&via=1312.media) to see all channels.
|
||||
|
||||
- [`#coopcloud:autonomic.zone`](https://matrix.to/#/!JSVYWCRXSVMrAzgeKB:autonomic.zone?via=autonomic.zone) General chat and announcements (low traffic)
|
||||
- [`#coopcloud-tech:autonomic.zone`](https://matrix.to/#/!IFazIpLtxiScqbHqoa:autonomic.zone?via=autonomic.zone) Technical discussions (some techno babble)
|
||||
- [`#coopcloud-dev:autonomic.zone`](https://matrix.to/#/!IFazIpLtxiScqbHqoa:autonomic.zone?via=autonomic.zone) Intense developer chat (a lot of techno babble)
|
||||
|
||||
### XMPP
|
||||
|
||||
> Coming Soon :tm:
|
||||
|
||||
## Forum
|
||||
|
||||
[`community.coops.tech`](https://community.coops.tech/)
|
||||
|
||||
@@ -6,7 +6,8 @@ title: Credits & thanks
|
||||
|
||||
Special thanks to:
|
||||
|
||||
- [Doop Coop](mailto:cluck@doop.coop), for making a transparent version of the Co-op Cloud logo, and helping with OSX alpha testing.
|
||||
- [Doop Coop](mailto:cluck@doop.coop), for making a transparent version of the Co-op Cloud logo, Matrix room avatars and helping with OSX alpha testing.
|
||||
- [Social.coop](https://social.coop), for warmly welcoming us onto [`social.coop/@coopcloud`](https://social.coop/@coopcloud).
|
||||
- [Servers.coop](https://servers.coop), for hosting our digital infrastructure (website, builds, git hosting, etc.).
|
||||
- Every single last one of you heroic & patient alpha/beta testers, you are all comrades of the highest order of kropotkin :heart:
|
||||
- Every single last one of you heroic & patient beta testers, you are all comrades of the highest order of kropotkin :heart:
|
||||
- [`egonelbre/gophers`](https://github.com/egonelbre/gophers) for the rad gopher logos
|
||||
|
||||
+24
-10
@@ -34,11 +34,11 @@ The project was started by workers at [Autonomic](https://autonomic.zone/) which
|
||||
|
||||
Please read our [initial project announcement post](https://autonomic.zone/blog/co-op-cloud/) for more on this.
|
||||
|
||||
Also see our [strategy page](/strategy/).
|
||||
Also see our [strategy page](../strategy/).
|
||||
|
||||
## How do I package an app?
|
||||
## How do I make a recipe for (package) an app?
|
||||
|
||||
See [the packager guide documentation](/packager-guide/#package-your-first-application) for more.
|
||||
See ["Package your first recipe"](/maintainers/tutorial/#package-your-first-recipe) for more.
|
||||
|
||||
## What about `$alternative`?
|
||||
|
||||
@@ -176,13 +176,13 @@ This means that we can patch our app containers directly in conversation with up
|
||||
|
||||
We definitely recommend using best-in-class security auditing tools like [docker-bench-security](https://github.com/docker/docker-bench-security), IDS systems like [OSSEC](https://www.ossec.net/), security profiles like [Apparmor](https://docs.docker.com/engine/security/apparmor/) and hooking these into your existing monitoring, alert and update maintenance flows.
|
||||
|
||||
It's up to how you want to arrange your system. For example, Co-op Cloud also allows you to compartmentalise different apps onto different servers. You could stack a bunch of apps on one big server or you could deploy one app per server.
|
||||
It's up to you how you want to arrange your system. For example, Co-op Cloud also allows you to compartmentalise different apps onto different servers. You could stack a bunch of apps on one big server or you could deploy one app per server.
|
||||
|
||||
These are organisational concerns that Co-op Cloud can't solve for you which any software system will require. See this [additional question](/faq/#what-is-important-to-consider-when-running-containers-in-production) for further information.
|
||||
These are organisational concerns that Co-op Cloud can't solve for you which any software system will require. See this [additional question](/intro/faq/#what-is-important-to-consider-when-running-containers-in-production) for further information.
|
||||
|
||||
## What is important to consider when running containers in production?
|
||||
|
||||
The Co-op Cloud uses [containers](/faq/#why-containers) as a fundamental building block. Therefore it is important to be aware of some general principles for container management in production environments. These are typically things that you will want to discuss within your co-op or democratic collective about how to prioritise and build up process for.
|
||||
The Co-op Cloud uses [containers](#why-containers) as a fundamental building block. Therefore it is important to be aware of some general principles for container management in production environments. These are typically things that you will want to discuss within your co-op or democratic collective about how to prioritise and build up process for.
|
||||
|
||||
However, as the Co-op Cloud project is still very young, we're also still thinking about how we can make the platform itself mitigate problematic issues and make the maintenance of containers a more stable experience.
|
||||
|
||||
@@ -210,13 +210,13 @@ We are happy to see the compose specification emerging as a new open standard be
|
||||
|
||||
## Why Docker Swarm?
|
||||
|
||||
While many have noted that "swarm is dead" it is in fact [not dead](https://www.mirantis.com/blog/mirantis-will-continue-to-support-and-develop-docker-swarm/). As detailed in the [architecture overview page](/overview/#container-orchestrator), swarm offers an appropriate feature set which allows us to support zero-down time upgrades, seamless app rollbacks, automatic deploy failure handling, scaling, hybrid cloud setups and maintain a decentralised design.
|
||||
While many have noted that "swarm is dead" it is in fact [not dead](https://www.mirantis.com/blog/mirantis-will-continue-to-support-and-develop-docker-swarm/). As detailed in the [architecture overview](/operators/tutorial/#container-orchestrator), swarm offers an appropriate feature set which allows us to support zero-down time upgrades, seamless app rollbacks, automatic deploy failure handling, scaling, hybrid cloud setups and maintain a decentralised design.
|
||||
|
||||
While the industry is bordering on a [k8s](https://kubernetes.io/) obsession and the need to [scale down](https://microk8s.io/) a tool that was fundamentally built for massive scale, we are going with swarm because it is the tool most suitable for [small technology](https://small-tech.org/).
|
||||
|
||||
We hope to see a container orchestrator tool that is not directly linked to a for-profit company emerge soon but for now, this is what we have.
|
||||
|
||||
If you want to learn more, see [dockerswarm.rocks](https://dockerswarm.rocks/) for a nice guide.
|
||||
If you want to learn more, see [dockerswarm.rocks](https://dockerswarm.rocks/) for a nice guide. See also [`BretFisher/awesome-swarm`](https://github.com/BretFisher/awesome-swarm).
|
||||
|
||||
## What licensing model do you use?
|
||||
|
||||
@@ -226,7 +226,7 @@ The Co-op Cloud is and will always be available under [copyleft licenses](https:
|
||||
|
||||
It is true that if you install 3 apps and each one requires a MySQL database, then you will have 3 installations of MySQL on your system, running in containers.
|
||||
|
||||
Systems like [YunoHost](/faq/#yunohost) mutualise every part of the system for maximum resource efficiency - if there is a MySQL instance available on the system, then just make a new database there and share the MySQL instance instead of creating more.
|
||||
Systems like [YunoHost](#yunohost) mutualise every part of the system for maximum resource efficiency - if there is a MySQL instance available on the system, then just make a new database there and share the MySQL instance instead of creating more.
|
||||
|
||||
However, as we see it, this creates a tight coupling between apps on the database level - running a migration on one app where you need to turn the database off takes down the other apps.
|
||||
|
||||
@@ -248,4 +248,18 @@ Yes! Horizontal scaling is one of the ways Co-op Cloud can really shine. `abra`
|
||||
|
||||
## Why only x86 support?
|
||||
|
||||
We would love to do ARM support and hope to get there! We've been testing this and [ran into some issues](https://git.autonomic.zone/coop-cloud/organising/issues/25). The TLDR; is that a lot of upstream libre app developer communities are not publishing container builds that support ARM. If they are, there are typically subtle differences in the conventions used to build the image as they are mostly done by community members and not directly taken on by the upstream project themselves. Since one of the core goals is to coordinate and reuse upstream packaging work, we see that ARM support requires a lot of organising and community engagement. Perhaps projects themselves will not want to take on this burden? It is not the role of the Co-op Cloud to set up an entire ARM publishing work flow at this moment in time. We see the benefits of supporting ARM and if you've got ideas / thoughts / approaches for how to make progress here, [please get in touch](/intro/contact/).
|
||||
We would love to do ARM support and hope to get there! We've been testing this and [ran into some issues](https://git.coopcloud.tech/coop-cloud/organising/issues/25). The TLDR; is that a lot of upstream libre app developer communities are not publishing container builds that support ARM. If they are, there are typically subtle differences in the conventions used to build the image as they are mostly done by community members and not directly taken on by the upstream project themselves. Since one of the core goals is to coordinate and reuse upstream packaging work, we see that ARM support requires a lot of organising and community engagement. Perhaps projects themselves will not want to take on this burden? It is not the role of the Co-op Cloud to set up an entire ARM publishing work flow at this moment in time. We see the benefits of supporting ARM and if you've got ideas / thoughts / approaches for how to make progress here, [please get in touch](/intro/contact/).
|
||||
|
||||
Update: [Can I run Co-op Cloud on ARM?](/operators/handbook/#can-i-run-co-op-cloud-on-arm)
|
||||
|
||||
## Why would an activist group use Co-op Cloud infrastructure over private cloud infrastructure (e.g. AWS, Azure, GCP)?
|
||||
|
||||
If your group is powerful enough to have generated opposition, it's not implausible that some law enforcement body may be trying to stymie your group's advances. To do this, law enforcement bodies may and probably will collaborate with big tech. Indeed, Big Tech has consistently shown a quick willingness to cooperate with Law Enforcement agencies (a la Snowden-revealed NSA subpoenas, [disallowing Signal to domain front](https://techcrunch.com/2018/05/02/signal-could-get-kicked-out-of-amazon-web-services/) and other such incidents where [Big Tech aided governments in hunting activists](http://discourse.leagueofconcernedusers.org/t/activist-infrastructures/69?u=themoonisblue)).
|
||||
|
||||
If your group has ambitions that generate enough fury in your opposition, you should think twice about where you store your data and whose services you rely on to store your data.
|
||||
|
||||
By using Co-op Cloud infrastructure over private cloud infrastructure, you create a few possibilities:
|
||||
|
||||
- You may interact with a server provider that is more ethical than Big Tech. Although the server provider may still succumb to law enforcement, you might place more trust in some providers than in private cloud providers (e.g. AWS).
|
||||
|
||||
- You may be able to situate your servers in locations that are relatively more impervious to law enforcement attempts to dismantle your infrastructure. Indeed, if you deployed your infrastructure in a relatively secure setting such as Switzerland, then you would weather a greater chance of keeping your infrastructure alive than if you deployed it in, say, the United States. Protonmail and [Extinction Rebellion (XR)](https://www.youtube.com/watch?v=I_O3zj3p52A) choose Switzerland for their servers, for reasons along these lines.
|
||||
|
||||
@@ -6,6 +6,8 @@ title: Managed hosting
|
||||
|
||||
If you're a co-operative or a tech collective who wants to appear on this list, please [get in touch](/intro/contact/)! We want to expand the number of service providers using the Co-op Cloud so that project is more widely available to end-users and organisations who can influence the direction and co-fund the development.
|
||||
|
||||
The Co-op Cloud is still [alpha quality software](https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha) :bomb: but you can still work with a tech co-op or collective to host some part or all of your online digital services with it. Organisations who want to support the project can get in touch with Co-op Cloud service providers via the following list for a quote on what they're looking for and how much it will cost. Service providers can then factor in some percentage of the cost to co-fund the development of this project.
|
||||
The Co-op Cloud is still [beta quality software](https://en.wikipedia.org/wiki/Software_release_life_cycle#Beta) :bomb: but you can still work with a tech co-op or collective to host some part or all of your online digital services with it. Organisations who want to support the project can get in touch with Co-op Cloud service providers via the following list for a quote on what they're looking for and how much it will cost. Service providers can then factor in some percentage of the cost to co-fund the development of this project.
|
||||
|
||||
- [Autonomic Co-op](https://autonomic.zone) (contact: [`helo@autonomic.zone`](mailto:helo@autonomic.zone))
|
||||
- [Local-IT](https://local-it.org/) (contact [`info@local-it.org`](mailto:info@local-it.org))
|
||||
- [Solisoft](https://solisoft.top) (contact [`contact@solisoft.top`](mailto:contact@solisoft.top))
|
||||
|
||||
@@ -6,6 +6,19 @@ title: Packaging handbook
|
||||
|
||||
You can run `abra recipe new <recipe>` to generate a new `~/.abra/recipes/<recipe>` repository. The generated repository is a copy of [`coop-cloud/example`](https://git.coopcloud.tech/coop-cloud/example).
|
||||
|
||||
## Hacking on an existing recipe
|
||||
|
||||
!!! warning
|
||||
|
||||
It is *very advisable* to disable any `healthcheck: ...` configuration
|
||||
while hacking on new recipes. This is because it is very easy to mess up
|
||||
and it will stop Traefik or other web proxies routing the app. You can
|
||||
enable a specific healthcheck later when your recipe is stable. The default
|
||||
"unconfigured" healthcheck behaviour is much less strict and it's faster to
|
||||
get something up and running.
|
||||
|
||||
If you want to make changes to an existing recipe then you can simply edit the files in `~/.abra/recipes/<recipe-name>` and run pass `--chaos` to the `deploy` command when deploying those changes. `abra` will not deploy unstaged changes to avoid instability but you can tell it to do so with `--chaos`. This means ou can simple hack away on the existing recipe files on your local file system and then when something is working, submit a change request to the recipe upstream.
|
||||
|
||||
## How is a recipe structured?
|
||||
|
||||
### `compose.yml`
|
||||
@@ -26,7 +39,7 @@ After docker creates the filesystem and copies files into a new container it run
|
||||
|
||||
For a simple example check the [entrypoint.sh for `croc`](https://git.coopcloud.tech/coop-cloud/croc/src/commit/2f06e8aac52a3850d527434a26de0a242bea0c79/entrypoint.sh). In this case, `croc` needs the password to be exported as an environmental variable called `CROC_PASS`, and that is exactly what the entrypoint does before running vendor entrypoint.
|
||||
|
||||
If you write your own entrypoint, it needs to be specified in the `config` section of compose.yml. See [this handbook entry](http://localhost:8000/maintainers/handbook/#entrypoints) for more.
|
||||
If you write your own entrypoint, it needs to be specified in the `config` section of compose.yml. See [this handbook entry](/maintainers/handbook/#how-do-i-set-a-custom-entrypoint) for more.
|
||||
|
||||
### `releases/` directory
|
||||
|
||||
@@ -98,6 +111,16 @@ You can also access it in your configs using the following syntax:
|
||||
{{ env "FOO" }}
|
||||
```
|
||||
|
||||
### Global environment variables
|
||||
|
||||
- `TYPE`: specifies the recipe name
|
||||
- `DOMAIN`: specifies the app domain
|
||||
- `LETS_ENCRYPT_ENV`: TODO
|
||||
- `TIMEOUT`: specifies the time in seconds to wait until all services have started and passed the health checks
|
||||
- `ENABLE_AUTO_UPDATE`: if set to `true`, the auto-updater `kadabra` can update this app (see [this auto updater entry](/operators/tutorial/#automatic-upgrades) for more)
|
||||
- `POST_DEPLOY_CMDS="<container> <command> <arguments>|<container> <command> <arguments>|... "` specifies commands that should be executed after each `abra app deploy`
|
||||
- `POST_UPGRADE_CMDS="<container> <command> <arguments>|<container> <command> <arguments>|... "` specifies commands that should be executed after each `abra app upgrade`
|
||||
|
||||
## Manage secret data
|
||||
|
||||
Adding a secret to your recipe is done:
|
||||
@@ -220,11 +243,11 @@ file_env "DB_PASSWORD"
|
||||
Sometimes the containers don't even have Bash installed on them. You had better just use `/bin/sh` or, in your entrypoint script, install Bash :upside_down: The entrypoint secrets hack listed above doesn't work in this case (as it requires Bash), so instead you can just do `export FOO=$(cat /run/secrets/<secret-name>)`.
|
||||
|
||||
|
||||
## Reference services in configs?
|
||||
## How do I reference services in configs?
|
||||
|
||||
When referencing an `app` service in a config file, you should prefix with the `STACK_NAME` to avoid namespace conflicts (because all these containers sit on the traefik overlay network). You might want to do something like this `{{ env "STACK_NAME" }}_app` (using the often obscure dark magic of the Golang templating language). You can find examples of this approach used in the [Peertube recipe](https://git.coopcloud.tech/coop-cloud/peertube/src/commit/d1b297c5a6a23a06bf97bb954104ddfd7f736568/nginx.conf.tmpl#L9).
|
||||
|
||||
## How are recipes are versioned?
|
||||
## How are recipes versioned?
|
||||
|
||||
We'll use an example to work through this. Let's use [Gitea](https://hub.docker.com/r/gitea/gitea).
|
||||
|
||||
@@ -360,7 +383,7 @@ mkdir -p releases
|
||||
|
||||
And then create a text file which corresponds to the version release, e.g. `1.1.0+5.9.0` and write some notes. `abra` will show these when another operator runs `abra app deploy` / `abra app upgrade`.
|
||||
|
||||
## Generate the recipe catalogue
|
||||
## How do I generate the recipe catalogue
|
||||
|
||||
To generate an entire new copy of the catalogue:
|
||||
|
||||
@@ -389,7 +412,7 @@ You can pass `--publish` to have `abra` automatically publish those changes.
|
||||
|
||||
In order to have `abra` publish changes for you automatically, you'll have to have write permissons to the git.coopcloud.tech repository and your account must have a working SSH key configuration. `abra` will use the SSH based URL connection details for Git by automagically creating an `origin-ssh` remote in the repository and pushing to it.
|
||||
|
||||
## Enable healthchecks
|
||||
## How do I enable healthchecks
|
||||
|
||||
A healthcheck is an important and often overlooked part of the recipe configuration. It is part of the configuration that the runtime uses to figure out if a container is really up-and-running. You can tweak what command to run, how often and how many times to try until you assume the container is not up.
|
||||
|
||||
@@ -406,7 +429,7 @@ If you're just starting off with packaging a recipe, you can use `healthcheck: d
|
||||
|
||||
`abra app errors -w <domain>` will show what errors are being reported from a failing healtcheck setup.
|
||||
|
||||
## Tuning deploy configs
|
||||
## How do I tune deploy configs?
|
||||
|
||||
A bit like healtchecks, there is no universal setup. A good default seems to be the following configuration:
|
||||
|
||||
@@ -427,13 +450,13 @@ Setting a restart policy is also good so that the runtime doesn't try to restart
|
||||
|
||||
Best to [read](https://docs.docker.com/engine/reference/builder/#healthcheck) [the docs](https://docs.docker.com/compose/compose-file/compose-file-v3/#healthcheck) on this one.
|
||||
|
||||
## Tuning resource limits
|
||||
## How do I tune resource limits?
|
||||
|
||||
If you don't place resource limits on your app it will assume it can use the entire capacity of the server it is on. This can cause issues such as OOM eerors for your entire swarm.
|
||||
If you don't place resource limits on your app it will assume it can use the entire capacity of the server it is on. This can cause issues such as Out-Of Memory errors for your entire swarm.
|
||||
|
||||
See the [Docker documentation](https://docs.docker.com/config/containers/resource_constraints/) to get into this topic and check the other recipes to see what other maintainers are doing.
|
||||
|
||||
## Enable A+ SSL ratings
|
||||
## How do I enable A+ SSL ratings?
|
||||
|
||||
If you want to get the highest rating on SSL certs, you can use the following traefik labels which use a tweaked Traefik configuration.
|
||||
|
||||
@@ -443,3 +466,183 @@ If you want to get the highest rating on SSL certs, you can use the following tr
|
||||
```
|
||||
|
||||
See [this PR](https://git.coopcloud.tech/coop-cloud/traefik/pulls/8/files) for the technical details
|
||||
|
||||
## How do I change secret generation length?
|
||||
|
||||
It is possible to tell `abra` which length it should generate secrets with from your recipe config.
|
||||
|
||||
You do this by adding a inline comment to the secret definition in the `.env.sample` / `.env` file.
|
||||
|
||||
Here are examples from the gitea recipe:
|
||||
|
||||
```
|
||||
SECRET_INTERNAL_TOKEN_VERSION=v1 # length=105
|
||||
SECRET_JWT_SECRET_VERSION=v1 # length=43
|
||||
SECRET_SECRET_KEY_VERSION=v1 # length=64
|
||||
```
|
||||
|
||||
When using this length specifier, `abra` will not use the "easy to remember
|
||||
word" style generator but instead a string of characters to match the exact
|
||||
length. This can be useful if you have to generate "key" style values instead
|
||||
of passwords which admins have to type out in database shells.
|
||||
|
||||
## How are recipes added to the catalogue?
|
||||
|
||||
> This is so far a manual process which requires someone who's been added to the
|
||||
> `coop-cloud` "Organisation" on https://git.coopcloud.tech. This is a temporary
|
||||
> situation, we want to open out this process & also introduce some automation
|
||||
> to support making thie process more convenient. Please nag us to move things
|
||||
> along.
|
||||
|
||||
- Publish your new recipe on the [git.coopcloud.tech](https://git.coopcloud.tech/coop-cloud) "Organisation"
|
||||
- Run `abra catalogue generate <recipe> -p`
|
||||
- Run `cd ~/.abra/catalogue && make`
|
||||
|
||||
These minimal steps will publish a new recipe with no versions. You can also do
|
||||
the [recipe release publishing dance](https://docs.coopcloud.tech/maintainers/handbook/#how-do-i-release-a-new-recipe-version)
|
||||
which will then extend the `versions: [...]` section of the published JSON in the catalogue.
|
||||
|
||||
Recipes that are not included in the catalogue can still be deployed. It is not
|
||||
required to add your recipes to the catalogue, but this will improve the
|
||||
visibility for other co-op hosters & end-users.
|
||||
|
||||
For now, it is best to [get in touch](https://docs.coopcloud.tech/intro/contact/) if you want to add your recipe to the catalogue.
|
||||
|
||||
In the future, we'd like to support [multiple catalogues](https://git.coopcloud.tech/coop-cloud/organising/issues/139).
|
||||
|
||||
## How do I configure backup/restore?
|
||||
|
||||
From the perspective of the recipe maintainer, backup/restore is just more
|
||||
`deploy: ...` labels. Tools can read these labels and then perform the
|
||||
backup/restore logic.
|
||||
|
||||
### Tools
|
||||
|
||||
Two of the current "blessed" options are
|
||||
[`backup-bot-two`](https://git.coopcloud.tech/coop-cloud/backup-bot-two) &
|
||||
[`abra`](https://git.coopcloud.tech/coop-cloud/abra).
|
||||
|
||||
#### `backup-bot-two`
|
||||
|
||||
Please see the [`README.md`](https://git.coopcloud.tech/coop-cloud/backup-bot-two#backupbot-ii) for the full docs.
|
||||
|
||||
#### `abra`
|
||||
|
||||
`abra` will read labels and store backups in `~/.abra/backups/...`.
|
||||
|
||||
### Backup
|
||||
|
||||
For backup, here are the labels & some examples:
|
||||
|
||||
- `backupbot.backup=true`: turn on backup logic
|
||||
- `backupbot.backup.pre-hook=mysqldump -u root -pghost ghost --tab /var/lib/foo`: command to run before backing up
|
||||
- `backupbot.backup.post-hook=rm -rf /var/lib/mysql-files/*`: command to run after backing up
|
||||
- `backupbot.backup.path=/var/lib/foo,/var/lib/bar`: paths to back up
|
||||
|
||||
You place these on your recipe configuration and then tools can run backups.
|
||||
|
||||
### Restore
|
||||
|
||||
Restore, in this context means, "moving a compressed archive back to the
|
||||
container backup paths". So, if you set
|
||||
`backupbot.backup.path=/var/lib/foo,/var/lib/bar` and you have a backed up
|
||||
archive, tooling will unzip files in the archive back to those paths.
|
||||
|
||||
In the case of restoring database tables, you can use the `pre-hook` &
|
||||
`post-hook` commands to run the insertion logic.
|
||||
|
||||
## Can I override a service within a recipe?
|
||||
|
||||
You can use [this `docker-compose` trick](https://docs.docker.com/compose/extends/#understanding-multiple-compose-files) to do this.
|
||||
|
||||
If you have a recipe that is using a `mysql` service and you'd like to use `postgresql` instead, you can create a `compose.psql.yml`!
|
||||
|
||||
An example of this is the [`selfoss`](https://git.coopcloud.tech/coop-cloud/selfoss) recipe. The default is `sqlite` but there is a `postgresql` compose configuration there too.
|
||||
|
||||
## How do I set a custom entrypoint?
|
||||
|
||||
For more context, see the [`entrypoint.sh`](/maintainers/handbook/#entrypointsh) section. The following configuration example is ripped from the [`coop-cloud/peertube`](https://git.coopcloud.tech/coop-cloud/peertube) recipe but shortened down. Here are more or less the steps you need to take:
|
||||
|
||||
Define a config:
|
||||
|
||||
```yaml
|
||||
app:
|
||||
...
|
||||
configs:
|
||||
- source: app_entrypoint
|
||||
target: /docker-entrypoint.sh
|
||||
mode: 0555
|
||||
...
|
||||
|
||||
configs:
|
||||
app_entrypoint:
|
||||
name: ${STACK_NAME}_app_entrypoint_${APP_ENTRYPOINT_VERSION}
|
||||
file: entrypoint.sh.tmpl
|
||||
template_driver: golang
|
||||
```
|
||||
|
||||
Define a `entrypoint.sh.tmpl`:
|
||||
|
||||
```
|
||||
#!/bin/bash
|
||||
|
||||
set -e
|
||||
|
||||
file_env() {
|
||||
local var="$1"
|
||||
local fileVar="${var}_FILE"
|
||||
local def="${2:-}"
|
||||
|
||||
if [ "${!var:-}" ] && [ "${!fileVar:-}" ]; then
|
||||
echo >&2 "error: both $var and $fileVar are set (but are exclusive)"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
local val="$def"
|
||||
|
||||
if [ "${!var:-}" ]; then
|
||||
val="${!var}"
|
||||
elif [ "${!fileVar:-}" ]; then
|
||||
val="$(< "${!fileVar}")"
|
||||
fi
|
||||
|
||||
export "$var"="$val"
|
||||
unset "$fileVar"
|
||||
}
|
||||
|
||||
file_env "PEERTUBE_DB_PASSWORD"
|
||||
|
||||
{{ if eq (env "PEERTUBE_SMTP_ENABLED") "1" }}
|
||||
file_env "PEERTUBE_SMTP_PASSWORD"
|
||||
{{ end }}
|
||||
|
||||
{{ if eq (env "PEERTUBE_LIVE_CHAT_ENABLED") "1" }}
|
||||
apt -y update && apt install -y prosody && apt -y clean
|
||||
mkdir -p /run/prosody && chown prosody:prosody /run/prosody
|
||||
{{ end }}
|
||||
|
||||
# Copy the client files over to a named volume
|
||||
# so that they may be served by nginx directly
|
||||
cp -ar /app/client/dist /srv/client
|
||||
|
||||
# upstream entrypoint
|
||||
# https://github.com/Chocobozzz/PeerTube/blob/66f77f63437c6774acbd72584a9839a7636ea167/support/docker/production/entrypoint.sh
|
||||
/usr/local/bin/entrypoint.sh "$@"
|
||||
```
|
||||
|
||||
Please note:
|
||||
|
||||
1. The `file_env` / `_FILE` hack is to pass secrets into the container runtime without exposing them in plaintext in the configuration. See [this entry](/maintainers/handbook/#exposing-secrets) for more.
|
||||
|
||||
1. In order to pass execution back to the original entrypoint, it's a good idea to find the original entrypoint script and run it from your own entrypoint script. If there is none, you may want to reference the `CMD` definition or if that isn't working, try to actually specify `cmd: ...` in the `compose.yml` definition (there are other recipes which do this).
|
||||
|
||||
1. If you're feeling reckless, you can also use the Golang templating engine to do things conditionally.
|
||||
|
||||
Then, wire up the vendored config version:
|
||||
|
||||
```
|
||||
# abra.sh
|
||||
export APP_ENTRYPOINT_VERSION=v5
|
||||
```
|
||||
|
||||
You should be able to deploy this overriden configuration now.
|
||||
|
||||
@@ -8,7 +8,9 @@ title: New maintainers tutorial
|
||||
|
||||
Packaging a recipe is basically knowing a bag of about 20 tricks. Once you learn them, there is nothing more to learn. It can seem daunting at first but it's simple and easy to do once you know the tricks.
|
||||
|
||||
The nice thing about packaging is that only one person has to do it and then we all benefit. We've seen that over time, the core of the configuration doesn't really change. New options and versions might come but the config remains quite stable. This is good since it meand that your packaging work stays relevant and useful for other maintainers & operators as time goes on.
|
||||
The nice thing about packaging is that only one person has to do it and then we all benefit. We've seen that over time, the core of the configuration doesn't really change. New options and versions might come but the config remains quite stable. This is good since it means that your packaging work stays relevant and useful for other maintainers & operators as time goes on.
|
||||
|
||||
Depending on your familiarity with recipes, it might be worth reading [how a recipe is structured](/maintainers/handbook/#how-is-a-recipe-structured) and making clear you understand [what a recipe is](/glossary/#recipe) before continuing.
|
||||
|
||||
### Making a plan
|
||||
|
||||
@@ -19,7 +21,7 @@ The idea scenario is when the upstream project provides both the packaged image
|
||||
- **Inspired**: Upstream image, someone else's compose file
|
||||
- **On fire**: Upstream image, upstream compose file
|
||||
|
||||
### Writing the `compose.yml`
|
||||
### Writing / adapting the `compose.yml`
|
||||
|
||||
Let's take a practical example, [Matomo web analytics](https://matomo.org/). We'll be making a Docker "swarm-mode" `compose.yml` file.
|
||||
|
||||
@@ -64,8 +66,8 @@ abra app new matomo --secrets \
|
||||
--server swarm.example.com
|
||||
```
|
||||
|
||||
Depending on whether you defined any extra environment variables, we didn't so
|
||||
far, in this example, you might want to run `abra app config swarm.example.com`
|
||||
Depending on whether you defined any extra environment variables -- we didn't so
|
||||
far, in this example -- you might want to run `abra app config swarm.example.com`
|
||||
to check the configuration.
|
||||
|
||||
Otherwise, or once you've done that, go ahead and deploy the app:
|
||||
@@ -78,4 +80,4 @@ Then, open the `DOMAIN` you configured (you might need to wait a while for Traef
|
||||
|
||||
### Finishing up
|
||||
|
||||
You've probably got more questions, check out the [maintainers handbook](/maintainers/handbook)!
|
||||
You've probably got more questions, check out the [packaging handbook](/maintainers/handbook)!
|
||||
|
||||
+248
-2
@@ -82,11 +82,23 @@ Then, tell your collaborators (e.g. in the repository's `README.md`), to run `ma
|
||||
|
||||
We don't currently recommend this, because it might set inaccurate expectations about the security model – remember that, by default, **any user who can deploy apps to a Docker Swarm can manage _any_ app in that swarm**.
|
||||
|
||||
### Migrating a server into a repository
|
||||
|
||||
Even if you've got your existing server configs in version control, by default, `abra server add` will define the server locally. To move it -- taking the example of `newserver.example.com`:
|
||||
|
||||
```
|
||||
mv ~/.abra/servers/newserver.example.com ~/coop-cloud-apps/
|
||||
cd ~/coop-cloud-apps
|
||||
git add newserver.example.com
|
||||
git commit
|
||||
make link
|
||||
```
|
||||
|
||||
## Running abra server side
|
||||
|
||||
If you're on an environment where it's hard to run Docker, or command-line programs in general, you might want to install `abra` on a server instead of your local work station.
|
||||
|
||||
To install `abra` on a different server than you'll be hosting your apps, just follow [getting started guide](/operators/tutorial#deploy-your-first-app) as normal except for one difference. Instead of providing your SSH connection details when you run `abra server add ...`, just pass `--local`.
|
||||
To install `abra` on the same server where you'll be hosting your apps, just follow [getting started guide](/operators/tutorial#deploy-your-first-app) as normal except for one difference. Instead of providing your SSH connection details when you run `abra server add ...`, just pass `--local`.
|
||||
|
||||
```
|
||||
abra server add --local
|
||||
@@ -104,7 +116,7 @@ Co-op Cloud uses [Docker Secrets](https://docs.docker.com/engine/swarm/secrets/)
|
||||
|
||||
`abra` includes several commands to make it easier to manage secrets:
|
||||
|
||||
- `abra app secret generate <domain>`: to auto-generate a app secrets
|
||||
- `abra app secret generate <domain>`: to auto-generate app secrets
|
||||
- `abra app secret insert <domain>`: to insert a single secret
|
||||
- `abra app secret rm <domain>`: to remove secrets
|
||||
|
||||
@@ -217,6 +229,31 @@ Otherwise, you have downloaded a corrupted file.
|
||||
|
||||
If you want to teach `abra` how to support your favourite server hosting provider, we'd glady accept patches.
|
||||
|
||||
## How do I bootstrap a server for running Co-op Cloud apps?
|
||||
|
||||
The requirements are:
|
||||
|
||||
1. Docker installed
|
||||
1. User in Docker user group
|
||||
1. Swarm mode initialised
|
||||
1. Proxy network created
|
||||
|
||||
```
|
||||
# docker install convenience script
|
||||
wget -O- https://get.docker.com | bash
|
||||
|
||||
# add user to docker group
|
||||
usermod -aG docker $USER
|
||||
|
||||
# setup swarm
|
||||
docker swarm init
|
||||
docker network create -d overlay proxy
|
||||
|
||||
# on debian machines as of 2023-02-17
|
||||
apt install apparmor
|
||||
systemctl restart docker containerd
|
||||
```
|
||||
|
||||
## Managing DNS entries
|
||||
|
||||
`abra record ...` can help you manage your DNS entries if you have an account with a supported 3rd party provider. We currently support [Gandi](https://gandi.net). The process of managing DNS with `abra` usually goes like this:
|
||||
@@ -228,3 +265,212 @@ If you want to teach `abra` how to support your favourite server hosting provide
|
||||
`abra` supports creating, listing and removing DNS entries if the 3rd party integration supports it.
|
||||
|
||||
If you want to teach `abra` how to support your favourite server hosting provider, we'd glady accept patches.
|
||||
|
||||
## How do I persist container logs after they go away?
|
||||
|
||||
This is a big topic but in general, if you're looking for something quick & easy, you can use the [journald logging driver](https://docs.docker.com/config/containers/logging/journald/). This will hook the container logs into systemd which can handle persistent log collection & managing log file size.
|
||||
|
||||
You need to add the following to your `/etc/docker/daemon.json` file on the server:
|
||||
|
||||
```json
|
||||
{
|
||||
"log-driver": "journald",
|
||||
"log-opts": {
|
||||
"labels":"com.docker.swarm.service.name"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
And for log size management, edit `/etc/systemd/journald.conf`:
|
||||
|
||||
```
|
||||
[Journal]
|
||||
Storage=persistent
|
||||
SystemMaxUse=5G
|
||||
MaxFileSec=1month
|
||||
```
|
||||
|
||||
Tne restart `docker` & `journald`:
|
||||
|
||||
```
|
||||
systemctl restart docker
|
||||
systemctl restart systemd-journald
|
||||
```
|
||||
|
||||
Now when you use `docker service logs` or `abra app logs`, it will read from the systemd journald logger seamlessly! Some useful `journalctl` commands are as follows, if you're doing some more fine grained logs investigation:
|
||||
|
||||
- `journalctl -f`
|
||||
- `journalctl CONTAINER_NAME=my_git_com_app.1.jxn9r85el63pdz42ykjnmh792 -f`
|
||||
- `journalctl COM_DOCKER_SWARM_SERVICE_NAME=my_git_com_app --since="2020-09-18 13:00:00" --until="2020-09-18 13:01:00"`
|
||||
- `journalctl CONTAINER_ID=$(docker ps -qf name=my_git_com_app) -f`
|
||||
|
||||
Also, for more system wide analysis stuff:
|
||||
|
||||
- `journalctl --disk-usage`
|
||||
- `du -sh /var/log/journal/*`
|
||||
- `man journalctl` / `man systemd-journald` / `man journald.conf`
|
||||
|
||||
## How do I specify a custom user/port for SSH connections with `abra`?
|
||||
|
||||
`abra` uses plain 'ol SSH under the hood and aims to make use of your existing SSH configurations in `~/.ssh/config` and interfaces with your running `ssh-agent` for password protected secret key files.
|
||||
|
||||
The `server add` command listed above assumes that that you make SSH connections on port 22 using your current username. If that is not he case, pass the new values as positional arguments. See `abra server add -h` for more on this.
|
||||
|
||||
```bash
|
||||
abra server add <domain> <user> <port> -p
|
||||
```
|
||||
|
||||
Running `server add` with `-d/--debug` should help you debug what is going on under the hood. It's best to take a moment to read [this troubleshooting entry](/abra/trouble/#ssh-connection-issues) if you're running into SSH connection issues with `abra`.
|
||||
|
||||
## How do I attach to a running container?
|
||||
|
||||
If you need to run a command within a running container you can use `abra app run <domain> <service> <command>`. For example, you could run `abra app run cloud.lumbung.space app bash` to open a new bash terminal session inside your remote container.
|
||||
|
||||
## How do I attach on a non-running container?
|
||||
|
||||
If you need to run a command on a container that won't start (eg. the container is stuck in a restart loop) you can temporarily disable its default entrypoint by setting it in `compose.yml` to something like ['tail', '-f', '/dev/null'], then redeploy the stack (with `--force --chaos` so you don't need to commit), then [get into the now running container](#how-do-i-attach-to-a-running-container), do your business, and when done revert the compose.yml change and redeploy again.
|
||||
|
||||
## Can I run Co-op Cloud on ARM?
|
||||
|
||||
`@Mayel`:
|
||||
|
||||
> FYI I've been running on ARM for a while with no troubles (as long as images
|
||||
> used support it of course, `abra` doesn't work yet!) 😀 ... in cases where I
|
||||
> couldn't find a multiarch image I simply have eg. image: ${DB_DOCKER_IMAGE}
|
||||
> in the docker-compose and set that to a compatible image in the env config
|
||||
> ... there was really nothing to it, apart from making sure to use multiarch
|
||||
> or arm images
|
||||
|
||||
See [`#312`](https://git.coopcloud.tech/coop-cloud/organising/issues/312) for more.
|
||||
|
||||
## How do I backup/restore my app?
|
||||
|
||||
If you're app [supports backup/restore](/maintainers/handbook/#how-do-i-configure-backuprestore) then you have two options: [`backup-bot-two`](https://git.coopcloud.tech/coop-cloud/backup-bot-two) & [`abra`](https://git.coopcloud.tech/coop-cloud/abra).
|
||||
|
||||
With `abra`, you can simply run `abra app backup ...` & `abra app restore ...`.
|
||||
Pass `-h` for more information on the specific flags & arguments.
|
||||
|
||||
## How do I take a manual database backup?
|
||||
|
||||
MySQL / MariaDB:
|
||||
|
||||
```
|
||||
abra app run foo.bar.com db mysqldump -u root <database> | gzip > ~/.abra/backups/foo.bar.com_db_`date +%F`.sql.gz
|
||||
```
|
||||
|
||||
Postgres:
|
||||
|
||||
```
|
||||
abra app run foo.bar.com db pg_dump -u root <database> | gzip > ~/.abra/backups/foo.bar.com_db_`date +%F`.sql.gz
|
||||
```
|
||||
|
||||
If you get errors about database access:
|
||||
- Make sure you've specified the right database user (`root` above) and db name
|
||||
- If you have a database password set, you might need to load it from a secret,
|
||||
something like this:
|
||||
|
||||
```
|
||||
abra app run foo.bar.com db bash -c 'mysqldump -u root -p"$(cat /run/secrets/db_oot_password)" <database>' | gzip > ~/.abra/backups/foo.bar.com_db_`date +%F`.sql.gz
|
||||
```
|
||||
|
||||
## Can I deploy a recipe without `abra`?
|
||||
|
||||
Yes! It's a design goal to keep the recipes not dependent on `abra` or any
|
||||
single tool that we develop. This means that the configuration commons can
|
||||
still be useful beyond this project. You can deploy a recipe with standard
|
||||
commands like so:
|
||||
|
||||
```
|
||||
set -a
|
||||
source example.com.env
|
||||
cd ~/.abra/recipes/myrecipe
|
||||
docker stack deploy -c compose.yml example_com
|
||||
```
|
||||
|
||||
`abra` makes all of this more convenient.
|
||||
|
||||
## Proxying apps outside of Co-op Cloud with Traefik?
|
||||
|
||||
It's possible! It's actually always been possible but we just didn't have
|
||||
spoons to investigate. Co-op Cloud can co-exist on the same server as bare
|
||||
metal apps, non-swarm containers (plain `docker-compose up` deployments!),
|
||||
Nginx installs etc. It's a bit gnarly with the networking but doable.
|
||||
|
||||
Enable the following in your Traefik `$domain.env` configuration:
|
||||
|
||||
```
|
||||
FILE_PROVIDER_DIRECTORY_ENABLED=1
|
||||
```
|
||||
|
||||
You must also have host mode networking enabled for Traefik:
|
||||
|
||||
```
|
||||
COMPOSE_FILE="$COMPOSE_FILE:compose.host.yml"
|
||||
```
|
||||
|
||||
And re-deploy your `traefik` app. You now have full control over the [file
|
||||
provider](https://doc.traefik.io/traefik/providers/file/#directory)
|
||||
configuration of Traefik. This also means you lost the defaults of the
|
||||
`file-provider.yml.tmpl`, so this is a more involved approach.
|
||||
|
||||
The main change is that there is now a `/etc/traefik/file-providers` volume
|
||||
being watched by Traefik for provider configurations. You can re-enable the
|
||||
recipe defaults by copying the original over to the volume (this assumes you've
|
||||
deployed `traefik` already without `FILE_PROVIDER_DIRECTORY_ENABLED`, which is
|
||||
required for the following command):
|
||||
|
||||
```
|
||||
abra app run $your-traefik app \
|
||||
cp /etc/traefik/file-provider.yml /etc/traefik/file-providers/
|
||||
```
|
||||
|
||||
You don't need to re-deploy Traefik, it should automatically pick this up.
|
||||
|
||||
You can route requests to a bare metal / non-docker service by making a
|
||||
`/etc/traefik/file-providers/$YOUR-SERVICE.yml` and putting something like this in
|
||||
it:
|
||||
|
||||
```yaml
|
||||
http:
|
||||
routers:
|
||||
myservice:
|
||||
rule: "Host(`my-service.example.com`)"
|
||||
service: "myservice"
|
||||
entryPoints:
|
||||
- web-secure
|
||||
tls:
|
||||
certResolver: production
|
||||
|
||||
services:
|
||||
myservice:
|
||||
loadBalancer:
|
||||
servers:
|
||||
- url: "http://$YOUR-HOST-IP:8080/"
|
||||
```
|
||||
|
||||
Where you should replace all instances of `myservice`.
|
||||
|
||||
You must use your host level IP address (replace `$YOUR-HOST-IP` in the
|
||||
example). With host mode networking, your deployment can route out of the swarm
|
||||
to the host.
|
||||
|
||||
If you're running a firewall (e.g. UFW) then it will likely block traffic from
|
||||
the swarm to the host. You can typically add a specific UFW to route from the
|
||||
swarm (typically, your `docker_gwbridge`) to the specific port of your bare
|
||||
metal / non-docker app:
|
||||
|
||||
```
|
||||
docker network inspect docker_gwbridge --format='{{( index .IPAM.Config 0).Gateway}}'
|
||||
172.18.0.1
|
||||
ufw allow from 172.18.0.0/16 proto tcp to any port $YOUR-APP-PORT
|
||||
```
|
||||
|
||||
Notice that we turn `172.18.0.1` into `172.18.0.0/16`. It's advised to open the
|
||||
firewall on a port by port case to avoid expanding your attack surface.
|
||||
|
||||
Traefik should handle the usual automagic HTTPS certificate generation and
|
||||
route requests after. You're free to make as many `$whatever.yml` files in your
|
||||
`/etc/traefik/file-providers` directory. It should Just Work ™
|
||||
|
||||
Please note that we have to hardcode `production` and `web-secure` which are
|
||||
typically configurable when not using `FILE_PROVIDER_DIRECTORY_ENABLED`.
|
||||
|
||||
+65
-19
@@ -75,7 +75,7 @@ Finally, we need a tool to read the recipe package format and actually deploy th
|
||||
|
||||
`abra` aims at providing a simple command-line interface for managing your own Co-op Cloud. You can bootstrap machines with the required tools, create new apps and deploy them. `abra` is written in [Go](https://go.dev/) and uses a lot of the libraries that the `docker` and `docker-compose` CLIs use but does not rely on those interfaces directly.
|
||||
|
||||
`abra` is our flagship command-line client but it does not need to be the only client. `abra` was designed in such a way that is complements a workflow which can still be done completely manually. If Co-op Cloud goes away tomorrow, our configuration commons would still be useful and usable.
|
||||
`abra` is our flagship command-line client but it does not need to be the only client. `abra` was designed in such a way that it complements a workflow which can still be done completely manually. If Co-op Cloud goes away tomorrow, our configuration commons would still be useful and usable.
|
||||
|
||||
[abra]: /abra/
|
||||
|
||||
@@ -94,14 +94,28 @@ The tutorial tries to help you make choices about which server and which DNS set
|
||||
|
||||
### Server setup
|
||||
|
||||
Co-op Cloud has itself near zero system requirements. You only need to worry about the system resource usage of your apps and the overhead of running containers with the docker runtime (often negligible. If you want to know more, see [this FAQ entry](/faq/#isnt-running-everything-in-containers-inefficient)).
|
||||
Co-op Cloud has itself near zero system requirements. You only need to worry about the system resource usage of your apps and the overhead of running containers with the docker runtime (often negligible. If you want to know more, see [this FAQ entry](/intro/faq/#isnt-running-everything-in-containers-inefficient)).
|
||||
|
||||
We will deploy a new Nextcloud instance in this guide, so you will only need 1GB of RAM according to [their documentation](https://docs.nextcloud.com/server/latest/admin_manual/installation/system_requirements.html). You may also be interested in this [FAQ entry](/faq/#arent-containers-horrible-from-a-security-perspective) if you are curious about security in the context of containers.
|
||||
We will deploy a new Nextcloud instance in this guide, so you will only need 1GB of RAM according to [their documentation](https://docs.nextcloud.com/server/latest/admin_manual/installation/system_requirements.html). You may also be interested in this [FAQ entry](/intro/faq/#arent-containers-horrible-from-a-security-perspective) if you are curious about security in the context of containers.
|
||||
|
||||
Most Co-op Cloud deployments have been run on Debian machines so far. Some experiments have been done on single board computers & servers with low resource capacities.
|
||||
|
||||
You need to keep port `:80` and `:443` free on your server for web proxying to your apps. Typically, you don't need to keep any other ports free as the core web proxy ([Traefik](https://traefik.io)) keeps all app ports internal to its network. Sometimes however, you need to expose an app port when you need to use a transport which would perform better or more reliably without proxying.
|
||||
|
||||
`abra` has support for creating servers (`abra server new`) but that is a more advanced automation feature which is covered in the [handbook](/operators/handbook). For this tutorial, we'll focus on the basics. Assuming you've managed to create a testing VPS with some `$hosting_provider`, you'll need to install Docker, add your user to the Docker group & setup swarm mode:
|
||||
|
||||
```
|
||||
# docker install convenience script
|
||||
wget -O- https://get.docker.com | bash
|
||||
|
||||
# add user to docker group
|
||||
sudo usermod -aG docker $USER
|
||||
|
||||
# setup swarm
|
||||
docker swarm init
|
||||
docker network create -d overlay proxy
|
||||
```
|
||||
|
||||
!!! question "Do you support multiple web proxies?"
|
||||
|
||||
We do not know if it is feasible and convenient to set things up on an existing server with another web proxy which uses ports `:80` & `:443`. We'd happily receive reports and documentation on how to do this if you manage to set it up!
|
||||
@@ -148,24 +162,13 @@ If you run into issues during installation, [please report a ticket](https://git
|
||||
|
||||
#### Add your server
|
||||
|
||||
Now you can connect `abra` with your server. You need to have a working SSH configuration before you can do this. That means you can run `ssh <server-domain>` on your command-line and everything Works :tm:.
|
||||
Now you can connect `abra` with your server. You should have a working SSH configuration before you can do this (e.g. a matching `Host <server-domain>` entry in `~/.ssh/config` with the correct SSH connection details). That means you can run `ssh <server-domain>` on your command-line and everything Works :tm:.
|
||||
|
||||
```bash
|
||||
abra server add <server-domain> -p
|
||||
ssh <server-domain> # make sure it works
|
||||
abra server add <server-domain>
|
||||
```
|
||||
|
||||
!!! warning "Beware of SSH dragons"
|
||||
|
||||
`abra` uses plain 'ol SSH under the hood and aims to make use of your existing SSH configurations in `~/.ssh/config` and interfaces with your running `ssh-agent` for password protected secret key files.
|
||||
|
||||
The `server add` command listed above assumes that that you make SSH connections on port 22 using your current username. If that is not he case, pass the new values as positional arguments. See `abra server add -h` for more on this.
|
||||
|
||||
abra server add <domain> <user> <port> -p
|
||||
|
||||
Running `server add` with `-d/--debug` should help you debug what is going on under the hood. It's best to take a moment to read [this troubleshooting entry](/abra/trouble/#ssh-connection-issues) if you're running into SSH connection issues with `abra`.
|
||||
|
||||
The `-p` or `--provision` flag means that `abra` will install Docker and initialise the [new single-host swarm](https://docs.docker.com/engine/swarm/key-concepts/) on your server.
|
||||
|
||||
It is important to note that `<domain>` here is a publicy accessible domain name which points to your server IP address. `abra` does make sure this is the case and this is done to avoid issues with HTTPS certificate rate limiting.
|
||||
|
||||
You will now have a new `~/.abra/` folder on your local file system which stores all the configuration of your Co-op Cloud instance.
|
||||
@@ -176,6 +179,12 @@ You will now have a new `~/.abra/` folder on your local file system which stores
|
||||
abra server ls
|
||||
```
|
||||
|
||||
!!! warning "Beware of SSH dragons"
|
||||
|
||||
`abra` uses plain 'ol SSH under the hood and aims to make use of your existing SSH configurations in `~/.ssh/config` and interfaces with your running `ssh-agent` for password protected secret key files.
|
||||
|
||||
Running `server add` with `-d/--debug` should help you debug what is going on under the hood. It's best to take a moment to read [this troubleshooting entry](/abra/trouble/#ssh-connection-issues) if you're running into SSH connection issues with `abra`.
|
||||
|
||||
!!! question "How do I share my configs in `~/.abra`?"
|
||||
|
||||
It's possible and quite easy, see [this handbook entry](/operators/handbook/#understanding-app-and-server-configuration) for more.
|
||||
@@ -197,7 +206,7 @@ Choose your newly registered server and specify a domain name.
|
||||
You will want to take a look at your generated configuration and tweak the `LETS_ENCRYPT_EMAIL` value. You can do that by running `abra app config`:
|
||||
|
||||
```bash
|
||||
abra app config traefik
|
||||
abra app config <traefik-domain>
|
||||
```
|
||||
|
||||
Every app you deploy will have one of these `.env` files, which contains variables which will be injected into app configurations when deployed. Variables starting with `#` are optional, others are required.
|
||||
@@ -238,8 +247,45 @@ abra app errors -w <nextcloud-domain> # error catcher
|
||||
|
||||
Your new `traefik` instance will detect that a new app is coming up and generate SSL certificates for it. You can see what `traefik` is up to using the same commands above but replacing `<netcloud-domain>` with the `<traefik-domain>` you chose earlier (`abra app ls` will remind you what domains you chose :grinning:).
|
||||
|
||||
### Upgrade Nextcloud
|
||||
|
||||
To upgrade an app manually to the newest available version run:
|
||||
|
||||
```bash
|
||||
abra app upgrade <nextcloud-domain>
|
||||
```
|
||||
|
||||
### Automatic Upgrades
|
||||
|
||||
`kadabra` the auto-updater is still under development, use it with care and don't use it in production environments. To setup the auto-updater copy the `kadabra` binary to the server and configure a cronjob for regular app upgrades. The following script will configure ssmtp for email notifications and setup a cronjob. This cronjob checks daily for new app versions, notifies if any kind of update is available and upgrades all apps to the latest patch/minor version.
|
||||
|
||||
|
||||
```bash
|
||||
apt install ssmtp
|
||||
|
||||
cat > /etc/ssmtp/ssmtp.conf << EOF
|
||||
mailhub=$MAIL_SERVER:587
|
||||
hostname=$MAIL_DOMAIN
|
||||
AuthUser=$USER
|
||||
AuthPass=$PASSWORD
|
||||
FromLineOverride=yes
|
||||
UseSTARTTLS=yes
|
||||
EOF
|
||||
|
||||
cat > /etc/cron.d/abra_updater << EOF
|
||||
MAILTO=admin@example.com
|
||||
MAILFROM=noreply@example.com
|
||||
|
||||
0 6 * * * root ~/kadabra notify --major
|
||||
30 4 * * * root ~/kadabra upgrade --all
|
||||
EOF
|
||||
|
||||
```
|
||||
|
||||
Add `ENABLE_AUTO_UPDATE=true` to the env config (`abra app config <app name>`) to enable the auto-updater for a specific app.
|
||||
|
||||
## Finishing up
|
||||
|
||||
Hopefully you got something running! Well done! The [operators handbook](/operators/handbook) would probably be the next place to go check out if you're looking for more help. Especially on topics of ongoing maintenance.
|
||||
|
||||
If not, please [get in touch](/intro/contact) or [raise a ticket](https://git.coopcloud.tech/coop-cloud/abra/issues/new) and we'll try to help out. We want our operator onboarding to be as smooth as possible, so we do appreciate any feedback we receive.
|
||||
If not, please [get in touch](/intro/contact) or [raise a ticket](https://git.coopcloud.tech/coop-cloud/organising/issues/new/choose) and we'll try to help out. We want our operator onboarding to be as smooth as possible, so we do appreciate any feedback we receive.
|
||||
|
||||
@@ -4,7 +4,7 @@ title: Organising handbook
|
||||
|
||||
## Where do I find "the community"?
|
||||
|
||||
The main place is the [Matrix community chat channels](/intro/contact/#matrix). You'll find a number of folks who are actively interested in the project and/or using `abra` and some of our recipes. Furthermore, Matrix has an excellent network of folks and in practice we've e-met a lot of groups who are interested in Co-op Cloud.
|
||||
The main place is the [Matrix community chat channels](/intro/contact/#matrix). You'll find a number of folks who are actively interested in the project and/or using `abra` and some of our recipes. Furthermore, Matrix has an excellent network of Cool People :tm: and in practice we've e-met a lot of groups who are interested in Co-op Cloud.
|
||||
|
||||
## Onboarding new project members
|
||||
|
||||
@@ -12,7 +12,7 @@ We still haven't worked this out. We're working on it.
|
||||
|
||||
## Gathering new case studies
|
||||
|
||||
We try to gather as many "case studies" as possible, stories & concrete examples of Co-op Cloud being used For God :tm: See [coopcloud.tech](https://coopcloud.tech) for our existing examples. These studies help people identify what the purpose of the project is for.
|
||||
We try to gather as many "case studies" as possible, stories & concrete examples of Co-op Cloud being used For Good :tm: See [coopcloud.tech](https://coopcloud.tech) for our existing examples. These studies help people identify what the purpose of the project is for.
|
||||
|
||||
## Monthly updates
|
||||
|
||||
|
||||
@@ -15,6 +15,65 @@ It aims to be a helpful place to understand the status of apps, who is taking ca
|
||||
|
||||
The recipe catalogue is available on [recipes.coopcloud.tech](https://recipes.coopcloud.tech/).
|
||||
|
||||
## Status / features / scoring
|
||||
|
||||
Each recipe README has a "metadata" section, to help communicate the overall status of the recipe, and which features are supported. Here's an example, from [the Wordpress recipe](https://git.coopcloud.tech/coop-cloud/wordpress/):
|
||||
|
||||
```
|
||||
<!-- metadata -->
|
||||
|
||||
* **Category**: Apps
|
||||
* **Status**: 3, stable
|
||||
* **Image**: [`wordpress`](https://hub.docker.com/_/wordpress), 4, upstream
|
||||
* **Healthcheck**: Yes
|
||||
* **Backups**: Yes
|
||||
* **Email**: 3
|
||||
* **Tests**: 2
|
||||
* **SSO**: No
|
||||
|
||||
<!-- endmetadata -->
|
||||
```
|
||||
|
||||
Currently, recipe maintainers need to update the scores in this section manually. The specific meanings of the scores are:
|
||||
|
||||
### Status (overall score)
|
||||
|
||||
- 5: everything in 4 + Single-Sign-On
|
||||
- 4: upstream image, backups, email, healthcheck, integration testing
|
||||
- 3: upstream image, missing 1-2 items from 4
|
||||
- 2: missing 3-4 items from 4 or no upstream image
|
||||
- 1: alpha
|
||||
|
||||
### Image
|
||||
|
||||
- 4: official upstream image
|
||||
- 3: semi-official / actively-maintained image
|
||||
- 2: 3rd-party image
|
||||
- 1: our own custom image
|
||||
|
||||
### Email
|
||||
|
||||
- 3: automatic (using environment variables)
|
||||
- 2: mostly automatic
|
||||
- 1: manual
|
||||
- 0: none
|
||||
- N/A: app doesn't send email
|
||||
|
||||
### CI
|
||||
|
||||
- 3: as 2, plus healthcheck
|
||||
- 2: auto secrets + networks
|
||||
- 1: basic deployment using `stack-ssh-deploy`, manual secrets + networks
|
||||
- 0: none
|
||||
|
||||
### Single-Sign-On
|
||||
|
||||
- 3: automatic (using environment variables)
|
||||
- 2: mostly automatic
|
||||
- 1: manual
|
||||
- 0: none
|
||||
- N/A: app doesn't support SSO
|
||||
|
||||
## Wishlist
|
||||
|
||||
If you'd like to see a new recipe packaged, make a request on the [recipes-wishlist](https://git.coopcloud.tech/coop-cloud/recipes-wishlist) repository issue tracker.
|
||||
|
||||
@@ -3,3 +3,38 @@
|
||||
--md-primary-fg-color--light: #202674;
|
||||
--md-primary-fg-color--dark: #ee4a33;
|
||||
}
|
||||
|
||||
/* Navbar styling tweaks */
|
||||
|
||||
.md-search__form {
|
||||
background-color: rgba(0, 0, 255, 0.20);
|
||||
}
|
||||
|
||||
.md-tabs {
|
||||
background-color: #6A9CFF;
|
||||
}
|
||||
|
||||
.md-tabs__item {
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
/* Footer styling tweaks */
|
||||
|
||||
.md-footer {
|
||||
background-color: #485FC7;
|
||||
}
|
||||
|
||||
.md-footer-meta {
|
||||
background-color: rgba(0, 0, 0, 0.45);
|
||||
}
|
||||
|
||||
/* Mobile sidebar styling tweaks */
|
||||
|
||||
.md-nav__source {
|
||||
background-color: #A7C5FF !important;
|
||||
}
|
||||
|
||||
.md-nav--primary .md-nav__title {
|
||||
background-color: #6A9CFF !important;
|
||||
color: var(--md-primary-bg-color) !important;
|
||||
}
|
||||
|
||||
+32
-3
@@ -2,6 +2,7 @@
|
||||
site_author: Co-op Cloud
|
||||
site_name: "Co-op Cloud: Public Interest Infrastructure"
|
||||
site_url: https://docs.coopcloud.tech
|
||||
use_directory_urls: true
|
||||
|
||||
theme:
|
||||
name: material
|
||||
@@ -12,13 +13,15 @@ theme:
|
||||
- navigation.tabs
|
||||
- navigation.tabs.sticky
|
||||
- navigation.indexes
|
||||
- content.action.edit
|
||||
palette:
|
||||
primary: light pink
|
||||
accent: purple
|
||||
logo: img/favicon.ico
|
||||
favicon: img/favicon.ico
|
||||
custom_dir: custom_theme/
|
||||
|
||||
copyright: Copyleft 🄯 2022 Co-op Cloud
|
||||
copyright: Copyleft 2023 Co-op Cloud
|
||||
|
||||
markdown_extensions:
|
||||
- meta
|
||||
@@ -65,17 +68,43 @@ nav:
|
||||
- "Upgrade": abra/upgrade.md
|
||||
- "Hack": abra/hack.md
|
||||
- "Troubleshoot": abra/trouble.md
|
||||
- "Cheat Sheet": abra/cheat-sheet.md
|
||||
- "Get Involved":
|
||||
- get-involved/index.md
|
||||
- "Federation":
|
||||
- federation/index.md
|
||||
- "FAQ": federation/faq.md
|
||||
- "Resolutions":
|
||||
- federation/resolutions/index.md
|
||||
- "Passed":
|
||||
- federation/resolutions/passed/001.md
|
||||
- federation/resolutions/passed/002.md
|
||||
- federation/resolutions/passed/003.md
|
||||
- federation/resolutions/passed/004.md
|
||||
- federation/resolutions/passed/005.md
|
||||
- federation/resolutions/passed/006.md
|
||||
- "In progress":
|
||||
- federation/resolutions/in-progress/index.md
|
||||
- federation/resolutions/in-progress/009.md
|
||||
- federation/resolutions/in-progress/010.md
|
||||
- "Draft":
|
||||
- federation/resolutions/drafts/index.md
|
||||
- "Finance": federation/finance.md
|
||||
- "Membership": federation/membership.md
|
||||
- "Minutes":
|
||||
- federation/minutes/index.md
|
||||
- "2022":
|
||||
- federation/minutes/2022-03-03.md
|
||||
- "Digital tools": federation/tools.md
|
||||
- "Glossary":
|
||||
- glossary/index.md
|
||||
|
||||
plugins:
|
||||
- search
|
||||
- awesome-pages
|
||||
- search
|
||||
|
||||
repo_name: coop-cloud/docs.coopcloud.tech
|
||||
repo_url: https://git.coopcloud.tech/coop-cloud/docs.coopcloud.tech
|
||||
repo_url: https://git.coopcloud.tech/coop-cloud/docs.coopcloud.tech/
|
||||
edit_uri: _edit/main/docs/
|
||||
|
||||
extra_css:
|
||||
|
||||
+5
-1
@@ -1,3 +1,7 @@
|
||||
{
|
||||
"$schema": "https://docs.renovatebot.com/renovate-schema.json"
|
||||
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
||||
"packageRules": [{
|
||||
"matchUpdateTypes": ["minor", "patch"],
|
||||
"automerge": true
|
||||
}]
|
||||
}
|
||||
|
||||
+4
-4
@@ -1,4 +1,4 @@
|
||||
mkdocs-awesome-pages-plugin==2.6.1
|
||||
mkdocs-material-extensions==1.0.3
|
||||
mkdocs-material==8.1.10
|
||||
mkdocs==1.2.3
|
||||
mkdocs-awesome-pages-plugin==2.9.1
|
||||
mkdocs-material-extensions==1.1.1
|
||||
mkdocs-material==9.1.19
|
||||
mkdocs==1.4.3
|
||||
|
||||
Reference in New Issue
Block a user