Compare commits

..

86 Commits

Author SHA1 Message Date
Comrade Renovate Bot 2568322fbd chore(deps): update squidfunk/mkdocs-material docker tag to v9.4.10 2023-11-20 08:02:15 +00:00
Comrade Renovate Bot 1eda82c490 chore(deps): update dependency mkdocs-material to v9.4.10 2023-11-20 08:01:55 +00:00
decentral1se b05b577695
docs: remove 013 for now 2023-11-17 09:46:39 +01:00
Comrade Renovate Bot 05a949d5cd chore(deps): update squidfunk/mkdocs-material docker tag to v9.4.8 2023-11-06 08:02:22 +00:00
Comrade Renovate Bot eb21b7844c chore(deps): update dependency mkdocs-material to v9.4.8 2023-11-06 08:02:02 +00:00
Wiktor W. e986eb48da fix: point formatting in faq
- capitalize first letter for each point
- finish all the points with a dot
- add one point to 'Pros' for Docker-compose
- move 'Cons' for Docker-compose into appropriate section
2023-11-04 09:49:37 +00:00
Wiktor W. 7523339384 fix: typos 2023-11-04 10:42:29 +01:00
Comrade Renovate Bot eb24873db3 chore(deps): update squidfunk/mkdocs-material docker tag to v9.4.7 2023-10-30 08:02:37 +00:00
Comrade Renovate Bot b38d2328c9 chore(deps): update dependency mkdocs-material to v9.4.7 2023-10-30 08:02:17 +00:00
Comrade Renovate Bot 5ae08f5b45 chore(deps): update dependency mkdocs-material-extensions to v1.3 2023-10-17 07:01:54 +00:00
Comrade Renovate Bot dc84e990af chore(deps): update squidfunk/mkdocs-material docker tag to v9.4.6 2023-10-16 07:02:15 +00:00
Comrade Renovate Bot 5106fe390f chore(deps): update dependency mkdocs-material to v9.4.6 2023-10-16 07:01:55 +00:00
decentral1se 460eb75e55
fix: more list indentation 2023-10-14 10:29:31 +02:00
decentral1se d595a74099
fix: list indentation 2023-10-14 10:27:28 +02:00
decentral1se 3f2ab68ada
fix: quotes 2023-10-14 10:26:22 +02:00
decentral1se 17bce5a4f3
fix: use correct budget number 2023-10-14 10:23:13 +02:00
decentral1se bb47eb0200
docs: R013 draft 2023-10-14 10:21:13 +02:00
Comrade Renovate Bot b45862394d chore(deps): update squidfunk/mkdocs-material docker tag to v9.4.5 2023-10-11 07:02:15 +00:00
Comrade Renovate Bot 98c58512ba chore(deps): update dependency mkdocs-material to v9.4.5 2023-10-11 07:01:55 +00:00
decentral1se c82437da8f
refactor: more warnings for default env vars
See coop-cloud/organising#359
2023-10-06 11:12:24 +02:00
Comrade Renovate Bot fa75f96f43 chore(deps): update squidfunk/mkdocs-material docker tag to v9.4.4 2023-10-06 07:02:25 +00:00
Comrade Renovate Bot b3b46136e6 chore(deps): update dependency mkdocs-material to v9.4.4 2023-10-06 07:02:05 +00:00
Comrade Renovate Bot 675779f598 chore(deps): update squidfunk/mkdocs-material docker tag to v9.4.3 2023-10-03 07:02:34 +00:00
Comrade Renovate Bot 686f57e94a chore(deps): update dependency mkdocs-material to v9.4.3 2023-10-03 07:02:14 +00:00
decentral1se 76bfe2d057
docs: add funding applications & proposals 2023-09-30 23:24:47 +02:00
Comrade Renovate Bot 42c2bcb46b chore(deps): update squidfunk/mkdocs-material docker tag to v9.4.2 2023-09-26 07:04:21 +00:00
Comrade Renovate Bot 94ae9f265d chore(deps): update dependency mkdocs-material to v9.4.2 2023-09-26 07:03:40 +00:00
decentral1se 5f460553f8
docs: it's out now 2023-09-25 18:45:13 +02:00
decentral1se ea6e6be5c3
docs: more migration guide 2023-09-25 11:11:02 +02:00
decentral1se b904b08b5c
docs: show this is budget 001 in title 2023-09-25 10:40:48 +02:00
decentral1se 052c951157
docs: 012 passed 2023-09-25 10:40:37 +02:00
Comrade Renovate Bot f064693668 chore(deps): update squidfunk/mkdocs-material docker tag to v9.4.1 2023-09-25 07:05:11 +00:00
Comrade Renovate Bot d7cdf1b1a9 chore(deps): update dependency mkdocs-material to v9.4.1 2023-09-25 07:04:37 +00:00
Comrade Renovate Bot 6b8ebb6459 chore(deps): update squidfunk/mkdocs-material docker tag to v9.4.0 2023-09-22 07:04:58 +00:00
Comrade Renovate Bot ffed6b426a chore(deps): update dependency mkdocs-material to v9.4.0 2023-09-22 07:04:29 +00:00
decentral1se 7a2145a0d3
docs: unit tests 2023-09-21 11:33:19 +02:00
decentral1se 8b74678c7d
docs: tip to run recipe related tests 2023-09-21 10:32:58 +02:00
Comrade Renovate Bot 58fefdd1d3 chore(deps): update dependency mkdocs-material-extensions to v1.2 2023-09-21 07:04:47 +00:00
decentral1se 7f0c8abceb
docs: more getting started help 2023-09-20 14:44:33 +02:00
decentral1se 87b7d403fb
docs: notes about tagging tests 2023-09-20 14:30:34 +02:00
decentral1se db63234da9
docs: note about tests for release 2023-09-20 13:59:32 +02:00
decentral1se d903d14da5
docs: moar integration docs 2023-09-20 13:58:15 +02:00
Comrade Renovate Bot 4cab1901eb chore(deps): update squidfunk/mkdocs-material docker tag to v9.3.2 2023-09-20 07:04:19 +00:00
Comrade Renovate Bot 2d8f72d179 chore(deps): update dependency mkdocs-material to v9.3.2 2023-09-19 07:06:44 +00:00
Comrade Renovate Bot 781817b03a chore(deps): update dependency mkdocs to v1.5.3 2023-09-19 07:06:16 +00:00
decentral1se dab4bfa0b5
docs: bats from source & tags 2023-09-17 10:41:13 +02:00
decentral1se 14e9da8d82
docs: note about removal of record/server new 2023-09-14 16:52:19 +02:00
Comrade Renovate Bot f2f335d4da chore(deps): update squidfunk/mkdocs-material docker tag to v9.3.1 2023-09-12 07:04:30 +00:00
Comrade Renovate Bot 054eebd019 chore(deps): update dependency mkdocs-material to v9.3.1 2023-09-12 07:03:58 +00:00
decentral1se a253294196
docs: update date/deadline for 012 2023-09-09 10:46:09 +02:00
decentral1se 0bb5541084
docs: Resolution 012 Budget 006 2023-09-08 11:00:26 +02:00
decentral1se 12186f8158
docs: move 011 to passed 2023-09-08 10:41:43 +02:00
decentral1se 8f8ce11bfd
docs: note on server, remove unsupported feature 2023-09-07 19:40:19 +02:00
decentral1se d324d050cd
docs: moar moar integration suite docs 2023-09-07 17:09:41 +02:00
decentral1se 9eb32ce6f2
docs: more integration test suite tweaks 2023-09-07 15:42:39 +02:00
decentral1se aece8d4118
fix: make top-level headings 2023-09-05 17:44:21 +02:00
decentral1se 4c54311a3a
fix: and expose ABRA_DIR 2023-09-05 13:55:32 +02:00
decentral1se f6ab950ce3
docs: int test suite 2023-09-05 13:17:53 +02:00
Comrade Renovate Bot 91867ab5e3 chore(deps): update squidfunk/mkdocs-material docker tag to v9.2.8 2023-09-05 07:08:08 +00:00
Comrade Renovate Bot 92289f5254 chore(deps): update dependency mkdocs-material to v9.2.8 2023-09-05 07:07:40 +00:00
Comrade Renovate Bot 8acb1ac2aa chore(deps): update squidfunk/mkdocs-material docker tag to v9.2.7 2023-09-04 07:07:02 +00:00
Comrade Renovate Bot 83da32770d chore(deps): update dependency mkdocs-material to v9.2.7 2023-09-04 07:06:19 +00:00
Comrade Renovate Bot 9d373b3cca chore(deps): update squidfunk/mkdocs-material docker tag to v9.2.6 2023-09-01 07:04:38 +00:00
Comrade Renovate Bot 1e4ab4202b chore(deps): update dependency mkdocs-material to v9.2.6 2023-09-01 07:04:02 +00:00
Comrade Renovate Bot 3b8b8e5c6d chore(deps): update squidfunk/mkdocs-material docker tag to v9.2.5 2023-08-28 07:09:23 +00:00
Comrade Renovate Bot 4473ddac1e chore(deps): update dependency mkdocs-material to v9.2.5 2023-08-28 07:08:40 +00:00
Comrade Renovate Bot 0fb91f7a17 chore(deps): update squidfunk/mkdocs-material docker tag to v9.2.3 2023-08-23 07:04:41 +00:00
Comrade Renovate Bot d87d88e531 chore(deps): update dependency mkdocs-material to v9.2.3 2023-08-23 07:04:08 +00:00
Comrade Renovate Bot 5211c0a113 chore(deps): update squidfunk/mkdocs-material docker tag to v9.2.1 2023-08-22 07:04:27 +00:00
Comrade Renovate Bot 304c39d998 chore(deps): update dependency mkdocs-material to v9.2.1 2023-08-22 07:04:00 +00:00
Comrade Renovate Bot cf43774fa1 chore(deps): update dependency mkdocs-awesome-pages-plugin to v2.9.2 2023-08-21 07:05:32 +00:00
3wc f0a15b079f Add disco build-abra-in-docker advice
Thanks @V
2023-08-04 14:53:46 +02:00
Comrade Renovate Bot d37838535e chore(deps): update dependency mkdocs to v1.5.2 2023-08-03 07:08:37 +00:00
Comrade Renovate Bot e06db4b5e0 chore(deps): update squidfunk/mkdocs-material docker tag to v9.1.21 2023-08-01 07:04:35 +00:00
decentral1se 56858053f6
docs: sort & add tracking 2023-07-29 01:16:00 +02:00
Comrade Renovate Bot 1557ae057e chore(deps): update dependency mkdocs-material to v9.1.21 2023-07-28 07:14:31 +00:00
Comrade Renovate Bot b2692984f6 chore(deps): update dependency mkdocs to v1.5.1 2023-07-28 07:13:37 +00:00
Comrade Renovate Bot 9b6f1938e8 chore(deps): update dependency mkdocs to v1.5.0 2023-07-27 07:14:09 +00:00
decentral1se 7eefba2410
fix: add missing "cd" 2023-07-26 12:33:21 +02:00
decentral1se 3d9e63be5d
docs: typo & wording 2023-07-26 09:55:14 +02:00
decentral1se d90b13eb1e
doc: new v8 rc guide 2023-07-26 08:50:39 +02:00
decentral1se 6a8ddfdb6b
docs: how to unbork lightweight tag
See coop-cloud/organising#433
2023-07-25 20:39:01 +02:00
decentral1se cd6520b083
docs: add link to 009 2023-07-24 18:30:58 +02:00
decentral1se f5f33f0b5b
fix: wrong no. 2023-07-24 18:21:03 +02:00
decentral1se c22cd36b9c
docs: shuffling passed resolutions 2023-07-24 18:09:21 +02:00
3wc ddfc5da254 Add 011 to menu 2023-07-23 15:49:11 +01:00
24 changed files with 1415 additions and 60 deletions

View File

@ -1,4 +1,4 @@
FROM squidfunk/mkdocs-material:9.1.19
FROM squidfunk/mkdocs-material:9.4.10
EXPOSE 8000

View File

@ -20,7 +20,127 @@ Our [Drone CI configuration](https://git.coopcloud.tech/coop-cloud/abra/src/bran
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
## Unit tests
### Run tests
Run the entire suite.
```
make test
```
### Filter tests
Run a specific test.
```
go test ./pkg/recipe -v -run TestGetVersionLabelLocalDoesNotUseTimeoutLabel
```
## Integration tests
### Install dependencies
We use [`bats`](https://bats-core.readthedocs.io/en/stable/), you can install
the required dependencies with the following. You also need a working
installation of Docker and Go (not covered in this section).
```
apt install bats-file bats-assert bats-support jq make git
```
Unfortunately, the latest `bats` version in Debian stable does not have the
"filter tests by tags" feature, which is very handy for running a subset of the
tests. For this, we need to install `bats` from source. It's easy.
```
apt purge -y bats
git clone https://github.com/bats-core/bats-core.git
cd bats-core
sudo ./install.sh /usr/local
```
### Run tests
Then you can run the integration test suite with the following.
```
export ABRA_TEST_DOMAIN="test.example.com"
export ABRA_DIR="$HOME/.abra_test"
bats -Tp tests/integration # DO NOT run this just yet, read below...
```
`ABRA_TEST_DOMAIN` should also have a DNS A record for `*.test.example.com`
which points to the same server so that the test suite can deploy apps freely.
It's advised that you re-use the same server and therefore the same Traefik
deployment for running your integration tests. The test suite does not deploy
Traefik for you. Then you'll have more stable results.
You probably don't want to run the entire test suite though, it takes a while.
Try the following for starters.
```
bats -Tp tests/integration/autocomplete.bats
```
### Tagging tests
When a test actually deploys something to a server, we tag it with the following:
```
# bats test_tags=slow
@test "..." {
...
}
```
Then we can use [filters](#filter-tests) (see below) to pick out a subset of
tests which do/do not use a live server. Feel free to come up with your own
tags. See the `bats-core`
[docs](https://bats-core.readthedocs.io/en/stable/writing-tests.html#tagging-tests)
for more.
### Filter tests
You can run a specific file.
```
bats -Tp tests/integration/autocomplete.bats
```
For example, if you want to check that all `abra recipe ...` tests remain working.
```
bats -Tp tests/integration/recipe_*
```
You can filter on test names to run specific kinds of tests.
```
bats -Tp tests/integration --filter "validate app argument"
```
You can filter on tags.
```
bats -Tp tests/integration --filter-tags "\!slow" # only fast tests
bats -Tp tests/integration --filter-tags "slow" # only slow tests
```
You can also only run the previously failed tests.
```
bats -TP tests/integration --filter-status failed
```
### Debug tests
If you're running into issues and want to debug stuff, you can pass `-x` to
`bats` to trace all commands run in the test. You can add `echo '...' >&3`
debug statements to your test to output stuff also.
## 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!
@ -61,7 +181,7 @@ 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
## 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:
@ -70,6 +190,18 @@ If there's no official release for the architecture you use, you can cross-compi
- 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.
## Building in Docker
If you are living under a curse of constant Go environment problems, it might be easier to build `abra` using Docker:
```
sudo setenforce 0 # SELinux probably won't allow Docker to access files
docker run -it -v $PWD:/abra golang:1.19.6 bash
cd /abra
. .envrc
git config --global --add safe.directory /abra # work around funky file permissions
make build
```
## Release management
@ -79,6 +211,7 @@ For developers, while using this `-beta` format, the `y` part is the "major" ver
### Making a new release
- Run the [integration test suite](#integration-tests) and the unit tests (`make test`) (takes a while!)
- 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`)

View File

@ -18,9 +18,40 @@ 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/)
> General release notes are [here](https://git.coopcloud.tech/coop-cloud/abra/releases/tag/0.7.0-beta)
### `0.7.x-beta` -> `0.8.x-beta`
- We now have an `--offline` flag instead of relying on internal logic to try
to decide when offline/online works best. It's up to you! A lot of `abra`
operations require network access, so it is not really truly "offline". The
logic prefers local filesystem access when this flag is passed. E.g. if there
is a local copy of the catalogue, then don't `git pull`.
- There is more `--chaos`! There is more consistent flag handling for manually
overriding when to update the local recipe or leave it alone when hacking on
changes.
- Secrets are now only generated by reading the recipe config, not the env
vars. This should hopefully not affect you. If you're seeing weird behaviour,
please see [`#464`](https://git.coopcloud.tech/coop-cloud/organising/issues/464).
- There is a new linting rule for catching invalid tags in recipe versions.
This is an seemingly unavoidable issue that requires some maintenance work.
If you run into the error, here's some
[docs](https://docs.coopcloud.tech/maintainers/handbook/#r014-invalid-lightweight-tag)
to help work through it.
- `~/.abra/catalogue` is now *only* updated via `git pull`. You may need to
`cd ~/.abra/catalogue && git checkout .` to get `abra` to stop complaining about
unstaged changes.
- `abra record ...` & `abra server new` have been removed! Following a usage poll, these
features were not being relied on. They were also alpha prototypes which we
feel can be reconsidered once other more critical parts of Abra are more
stable.
### `0.6.x-beta` -> `0.7.x-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.

View File

@ -1,5 +1,5 @@
---
title: "Resolution 004: Budgeting - 2023-03-22"
title: "Resolution 004: Budget 001: Budgeting - 2023-03-22"
---
* Deadline: 2023-04-11

View File

@ -25,16 +25,7 @@ If the fix is urgent and things need to move faster, please state so on the tick
### 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.
This budget stands open and available for use until the common fund buffer is reached. Please see [Resolution 009](https://docs.coopcloud.tech/federation/resolutions/passed/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.

View File

@ -1,5 +1,5 @@
---
title: "Resolution 008: Budget 005: Backup improvements - 2023-07-23"
title: "Resolution 011: Budget 005: Backup improvements - 2023-07-23"
---
- Deadline: 2022-08-06
@ -7,7 +7,7 @@ title: "Resolution 008: Budget 005: Backup improvements - 2023-07-23"
### 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`.
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#

View File

@ -0,0 +1,31 @@
---
title: "Resolution 012: Budget 006: Abra integration test suite - 2023-09-09"
---
- Deadline: 2023-09-23
- Size: Large
### Summary
Recent attempts to continue developing features and fixes have lead to several regressions in Abra. It's more difficult to make progress and it's unclear if changes will create more bugs. Abra has always had bugs and we've relied on user testing to smoke those out.
However, we're reaching a scale where it's very difficult to test all changes with just user testing. Also, there is only so far you can go with user testing before bug fatigue and frustration is the norm.
It's time to build a robust Abra integration test suite which can help us stop regressions from happening and rely less on user testing. This will help us move forward with larger changes in Abra which we can then test and have confidence that the base functionality is not broken.
### Details (Budget 006)
References so far:
- [3wc & myself (d1) have had a planning meeting](https://pad.autonomic.zone/kdLrPXMSSb2TZezCBhdYtw?edit)
- [The first PR and proof of concept has landed in Abra](https://git.coopcloud.tech/coop-cloud/abra/pulls/347)
- [Initial documentation has been written](https://docs.coopcloud.tech/abra/hack/#integration-tests)
With some further experimentation, I'm relatively confident that this approach will allow us to implement an integration test suite which covers the majority of the Abra functionality. It's *a lot* of work. I'm estimating this to come in at 30 hours of work.
**Budget amount**: 600 EUR (30 hrs * 20 EUR/hr)
**Who will implement this**: decentral1se
**When will the money be spent**: Before the end of October 2023.
**What is the money for**: Implementing an Abra integration test suite.

View File

@ -14,21 +14,21 @@ The project was started by workers at [Autonomic](https://autonomic.zone/) which
#### Pros
- 👍 Thin "ease of use" layer on top of already standardised tooling
- 👍 Extremely modular
- 👍 Collective commons based configuration via public git repos
- 👍 Focussed on hosting providers
- 👍 Uses upstream published containers (no duplication on packaging)
- 👍 Now and always libre software
- 👍 Command line focussed
- 👍 Horizontal and vertical scaling
- 👍 Thin "ease of use" layer on top of already standardised tooling.
- 👍 Extremely modular.
- 👍 Collective commons based configuration via public git repos.
- 👍 Focussed on hosting providers.
- 👍 Uses upstream published containers (no duplication on packaging).
- 👍 Now and always libre software.
- 👍 Command line focussed.
- 👍 Horizontal and vertical scaling.
#### Cons
- 👎 Still a very young project
- 👎 Limited availability of well tested apps
- 👎 Requires command line knowledge to use
- 👎 Currently x86 only (see [this FAQ question](#why-only-x86-support) for more)
- 👎 Still a very young project.
- 👎 Limited availability of well tested apps.
- 👎 Requires command line knowledge to use.
- 👎 Currently x86 only (see [this FAQ question](#why-only-x86-support) for more).
## Why start another project?
@ -53,16 +53,16 @@ Here is a short overview of the pros/cons we see, in relation to our goals and n
- 👍 Decent web interface for app, domain & user management.
- 👍 Large library of apps.
- 👍 Built-in SSO using LDAP, which is compatible with more apps and often has a better user interface than OAuth.
- 👍 apps are actively maintained by the Cloudron team.
- 👍 Apps are actively maintained by the Cloudron team.
#### Cons
- 👎 Moving away from open source. The core is now proprietary software.
- 👎 libre tier has a single app limit.
- 👎 Libre tier has a single app limit.
- 👎 Based on Docker images, not stacks, so multi-process apps (e.g. parsoid visual editor for Mediawiki) are a non-starter.
- 👎 Difficult to extend apps.
- 👎 Only supported on Ubuntu LTS.
- 👎 Upstreams libre software communities aren't involved in packaging.
- 👎 Upstream libre software communities aren't involved in packaging.
- 👎 Limited to vertical scaling.
- 👎 Tension between needs of hosting provider and non-technical user.
- 👎 LDAP introduces security problems - one vulnerable app can expose a user's password for all apps.
@ -113,8 +113,8 @@ Here is a short overview of the pros/cons we see, in relation to our goals and n
#### Cons
- 👎 Upstream libre software communities aren't publishing Ansible roles
- 👎 Lots of manual work involved in things like app isolation, backups, updates
- 👎 Upstream libre software communities aren't publishing Ansible roles.
- 👎 Lots of manual work involved in things like app isolation, backups, updates.
### Kubernetes
@ -132,6 +132,10 @@ Here is a short overview of the pros/cons we see, in relation to our goals and n
#### Pros
- 👍 Quick to set up and familiar for many developers.
#### Cons
- 👎 Manual work required for process monitoring.
- 👎 Secret storage not available yet.
- 👎 [Swarm is the new best practice](https://github.com/BretFisher/ama/issues/8#issuecomment-367575011).

View File

@ -17,7 +17,7 @@ You can run `abra recipe new <recipe>` to generate a new `~/.abra/recipes/<recip
"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.
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 you can simply 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?
@ -88,13 +88,26 @@ export NGINX_CONFIG_VERSION=v1
## Manage environment variables
When you define an environment variable in a `.env.sample` for a recipe, such as:
!!! warning
Please read this section carefully to avoid deployment footguns for the
operators who deploy your recipe configuration. It's important to
understand how to add new env vars into the recipe configuration in a
non-breaking manner. Thanks for reading!
When you define an environment variable in an `.env.sample` for a recipe, such as:
```bash
FOO=123
```
And you pass this via the `environment` stanza of a service config in the recipe like so:
This defines an env var which then needs to be added by an operator to their app env file. If you would like to add an env var which is optional, you can do:
```bash
#FOO=123
```
In order to expose this env var to recipe configuration, you pass this via the `environment` stanza of a service config in the recipe like so:
```yaml
service:
@ -646,3 +659,74 @@ export APP_ENTRYPOINT_VERSION=v5
```
You should be able to deploy this overriden configuration now.
## Linting rules
### R014: "invalid lightweight tag"
This is an issue related to the way Git/`go-git` handle Git tags internally. We
need to use "annotated tags" and not "lightweight tags" for our recipe versions
tags. Otherwise, `abra` has a hard time parsing what is going on.
The `R01O4` linting error happens because the recipe in question has a
lightweight tag. This needs to be replaced. This is a manual process. Here's a
practical example with the Gitea recipe when we had this issue.
You can validate what kind of tag is which by running the following:
```
git for-each-ref refs/tags
734045872a57d795cd54b1992a1753893a4934f1 tag refs/tags/1.0.0+1.14.5-rootless
b2cefa5ccf2f2f77dae54cf6c304cccecb3547ca tag refs/tags/1.1.0+1.15.0-rootless
6d669112d8caafcdcf4eb1485f2d6afdb54a8e30 tag refs/tags/1.1.1+1.15.3-rootless
64761ad187cc7a3984a37dd9abd4fa16979f97b9 tag refs/tags/1.1.2+1.15.6-rootless
1ccb1cb6a63a08eebf6ba5508b676eaaccba7ed8 tag refs/tags/1.1.3+1.15.10-rootless
b86e1f6dfef3c464b16736274b3cd95f8978f66b tag refs/tags/1.2.0+1.16.3-rootless
b1d22f3c39ca768a4efa1a0b9b9f780268c924b3 tag refs/tags/1.2.1+1.16.8-rootless
85a45aa749427822a73ef62b6362d57bae1a61af tag refs/tags/1.3.0+1.17.2-rootless
f35689989c0b57575b8362e1252476d8133dc961 commit refs/tags/1.3.1+1.17.3-rootless
df015fae592fca7728a3f0835217e110da4dbafc tag refs/tags/2.0.0+1.18.0-rootless
71920adb0c25a59f7678894e39f1a705f0ad08dd tag refs/tags/2.0.1+1.18.2-rootless
1ab9a96922341c8e54bdb6d60850630cce4b9587 tag refs/tags/2.1.0+1.18.5-rootless
1e612d84a2ad7c9beb7aa064701a520c7e91eecc commit refs/tags/2.1.2+1.19.3-rootless
0bee99615a8bbd534a66a315ee088af3124e054b tag refs/tags/2.2.0+1.19.3-rootless
699378f53501b2d5079fa62cc7f8e79930da7540 tag refs/tags/2.3.0+1.20.1-rootless
c0dc5f82930d875c0a6e29abc016b4f6a53b83dd tag refs/tags/2.3.1+1.20.1-rootless
```
Where `f35689989c0b57575b8362e1252476d8133dc961` &
`1e612d84a2ad7c9beb7aa064701a520c7e91eecc` need to be removed ("commit"). We
will deal with `refs/tags/1.3.1+1.17.3-rootless` in this example.
```
# find the tag hash
git show 1.3.1+1.17.3-rootless
commit f35689989c0b57575b8362e1252476d8133dc961 (tag: 1.3.1+1.17.3-rootless)
Merge: af97db8 1d4dc8e
Author: decentral1se <decentral1se@noreply.git.coopcloud.tech>
Date: Sun Nov 13 21:54:01 2022 +0000
Merge pull request 'Adding Oauth2 options and up on versions' (#29) from javielico/gitea:master into master
Reviewed-on: https://git.coopcloud.tech/coop-cloud/gitea/pulls/29
# delete the tag locally / remotely
git tag -d 1.3.1+1.17.3-rootless
git push origin 1.3.1+1.17.3-rootless --delete
# re-tag, this time with `-a` (annotated)
git checkout f35689989c0b57575b8362e1252476d8133dc961
git tag -a 1.3.1+1.17.3-rootless
# push new tag
git checkout master # might be main on other recipes!
git push origin master --tags
# check everything works
git for-each-ref refs/tags | grep 1.3.1+1.17.3-rootless
964f1680000fbba6daa520aa8d533a53ad151ab8 tag refs/tags/1.3.1+1.17.3-rootless
```
That's it! Spread the word, use `-a` when tagging recipe versions manually! Or
just use `abra` which should handle this issue automagically for you in all
cases 🎉

View File

@ -14,7 +14,7 @@ Depending on your familiarity with recipes, it might be worth reading [how a rec
### Making a plan
The idea scenario is when the upstream project provides both the packaged image and a compose configuration which we can build from. If you're in luck, you'll typically find a `Dockerfile` and a `docker-compose.yml` file in the root of the upstream Git repository for the app.
The ideal scenario is when the upstream project provides both the packaged image and a compose configuration which we can build from. If you're in luck, you'll typically find a `Dockerfile` and a `docker-compose.yml` file in the root of the upstream Git repository for the app.
- **Tired**: Write your own image and compose file from scratch
- **Wired**: Use someone else's image (& maybe compose file)
@ -43,9 +43,9 @@ wget https://raw.githubusercontent.com/matomo-org/docker/master/.examples/apache
Open the `compose.yml` in your favourite editor and have a gander &#129442;. There are a few things we're looking for, but some immediate changes could be:
1. Let's bump the version to `3.8`, to make sure we can use all the latest swarm coolness
2. We load environment variables separately via [`abra`](/abra/), so we'll strip out `env_file`
3. The `/var/www/html` volume definition on L21 is a bit overzealous; it means a copy of Matomo will be stored separately per app instance, which is a waste of space in most cases. We'll narrow it down according to the documentation. The developers have been nice enough to suggest `logs` and `config` volumes instead, which is a decent start
1. Let's bump the version to `3.8`, to make sure we can use all the latest swarm coolness.
2. We load environment variables separately via [`abra`](/abra/), so we'll strip out `env_file`.
3. The `/var/www/html` volume definition on L21 is a bit overzealous; it means a copy of Matomo will be stored separately per app instance, which is a waste of space in most cases. We'll narrow it down according to the documentation. The developers have been nice enough to suggest `logs` and `config` volumes instead, which is a decent start.
4. The MySQL passwords are sent as variables which is fine for basic use, but if we replace them with Docker secrets we can keep them out of our env files if we want to publish those more widely.
5. The MariaDB service doesn't need to be exposed to the internet, so we can define an `internal` network for it to communicate with Matomo.
6. Lastly, we want to use `deploy.labels` and remove the `ports:` definition, to tell Traefik to forward requests to Matomo based on hostname and generate an SSL certificate.

View File

@ -163,11 +163,11 @@ So, given how [secret versions](/operators/handbook/#secret-versions) work, here
1. Find out the current version number of the secret, e.g. by running `abra app config <domain>`, and choose a new one. Let's assume it's currently `v1`, so by convention the new secret will be `v2`
2. Generate or insert the new secret: `abra app secret generate <domain> db_password v2` or `abra app secret insert <domain> db_password v2 "foobar"`
3. Edit the app configuration to change which secret version the app will use: `abra app config <domain>`
4. Re-reploy the app with the new secret version: `abra app deploy <domain>`
4. Re-deploy the app with the new secret version: `abra app deploy <domain>`
### Storing secrets in `pass`
The Co-op Cloud authors use the [UNIX `pass` tool][pass] to share sensitive data, including Co-op Cloud secrets, and `abra app secret ...` commands include a `--pass` option to automatically manage generated / inserted secrets:
The Co-op Cloud authors use the [UNIX `pass` tool](https://www.passwordstore.org) to share sensitive data, including Co-op Cloud secrets, and `abra app secret ...` commands include a `--pass` option to automatically manage generated / inserted secrets:
```
# Store generated secrets in `pass`:
@ -191,19 +191,19 @@ This functionality currently relies on our specific `pass` storage conventions;
### Traefik networking
[Traefik](https://doc.traefik.io/traefik/) is our core web proxy, all traffic on a Co-op Cloud deployment goes through a running Traefik container. When setting up a new Co-op Cloud delpyment, `abra` creates a "global" [overlay network](https://docs.docker.com/network/overlay/) which traefik is hooked up to. This is the network that other apps use to speak to traefik and get traffic routed to them. Not every service in every app is also included in this network and hence not internet-facing (by convention, we name this network `internal`, see more below).
[Traefik](https://doc.traefik.io/traefik/) is our core web proxy, all traffic on a Co-op Cloud deployment goes through a running Traefik container. When setting up a new Co-op Cloud deployment, `abra` creates a "global" [overlay network](https://docs.docker.com/network/overlay/) which traefik is hooked up to. This is the network that other apps use to speak to traefik and get traffic routed to them. Not every service in every app is also included in this network and hence not internet-facing (by convention, we name this network `internal`, see more below).
### App networking
By convention, the main `app` service is wired up to the "global" traefik overlay network. This container is the one that should be publicy reachable on the internet. The other services in the app such as the database and caches should be not be publicly reachable or visible to other apps on the same instance.
By convention, the main `app` service is wired up to the "global" traefik overlay network. This container is the one that should be publicy reachable on the internet. The other services in the app such as the database and caches should not be publicly reachable or visible to other apps on the same instance.
To deal with this, we make an additional "internal" network for each app which is namespaced to that app. So, if you deploy a Wordpress instance called `my_wordpress_blog` then there will be a network called `my_wordpress_blog_internal` created. This allows all the services in an app to speak to each other but not be reachable on the public internet.
## Multiple apps on the same domain?
At time of writing (Jan 2022), we think there is a limitation in our design which doesn't support multiple apps sharing the same domain (e.g. `example.com/app1/` & `example.com/app2/`). `abra` treats each domain as unique and as the singler reference for a single app.
At time of writing (Jan 2022), we think there is a limitation in our design which doesn't support multiple apps sharing the same domain (e.g. `example.com/app1/` & `example.com/app2/`). `abra` treats each domain as unique and as the single reference for a single app.
This may be possible to overcome if someone really needs it, we encourage people to investigate. We've found that often, there are limitations in the actual software which don't support this anyway and several of the current operators simply use a new domain per app.
This may be possible to overcome if someone really needs it, we encourage people to investigate. We've found that often there are limitations in the actual software which don't support this anyway and several of the current operators simply use a new domain per app.
## Validating `abra` binary checksums
@ -264,7 +264,7 @@ systemctl restart docker containerd
`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.
If you want to teach `abra` how to support your favourite DNS service provider, we'd glady accept patches.
## How do I persist container logs after they go away?
@ -314,7 +314,7 @@ Also, for more system wide analysis stuff:
`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.
The `server add` command listed above assumes that that you make SSH connections on port 22 using your current username. If that is not the 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

View File

@ -0,0 +1,5 @@
---
title: Culture of Solidarity (ECF)
---
> **TODO**

View File

@ -0,0 +1,535 @@
---
title: Ford foundation
---
# Ford foundation
> Status: **pending**
* [Previous material](https://notes.bonfire.cafe/nlnet-bonfire-coopcloud-hosting)
* [Application](https://fordfoundation.forms.fm/2023-digital-infrastructure-insights-fund-rfp/forms/9724)
## Is this concept note primarily focused on research or implementation?
- Implementation
## What is your research question? (30 words)
How can an open co-operative ecosystem foster a sustainable, resilient
infrastructure for FLOSS (Free/Libre Open Source software) development,
hosting, and tech support, while enhancing data ownnership, transparency and
co-operation?
## Why is this question important to answer and how does it relate to our fund? (500 words)
This is a challenge of paramount importance as it aims to design and test a
model for a sustainable, resilient open co-operative ecosystem amidst a digital
landscape overshadowed by large centralized profit-driven entities.
The hegemony of a few colossal platforms has led to myriad challenges
including, but not limited to, data privacy infringements, misinformation
dissemination, and a significant digital divide. Such challenges thwart the
internet's potential to act as a public commons and hinder the growth of a
democratic, open, and inclusive digital infrastructure.
The envisioned open co-operative ecosystem is a step towards remedying the
prevalent issues of centralization and lack of inclusivity in the digital
domain. It proposes a holistic approach encompassing technical innovation,
co-operative economics, and community-centric governance - where software,
infrastructure and communities are not isolated entities, but are part of a
common ecosystem.
This aligns profoundly with this fund's objective of exploring and remedying
the issues of under-maintenance and occasional undermining of FLOSS. The
proposed self-sustaining economic model is aimed at ensuring the longevity and
resilience of both the open co-operative ecosystem and all the actors involved:
FLOSS developers and designers, sysadmins and hosting providers, and all the
other figures that struggle to reach sustainability by working in and for the
FLOSS sector.
Furthermore, the proposed project is not merely a technical endeavor but a
multi-dimensional initiative aimed at fostering a digital infrastructure that
is equitable, sustainable, secure, and entrenched in the public interest.
Our proposed integration aims to simplify the setup, hosting and operating of
FLOSS software, through an open dashboard that automates the whole software
life cycle. This dashboard will act as a gateway to an ecosystem of developers
and hosting providers, which will work together to provide users and
communities with:
- Openness: Designers, developers, and sysadmins can join the ecosystem to
provide services and receive compensation;
- Mutualism: Projects and communities that meet specific criteria may exchange
services in-kind, or benefit from special rates;
- Flexibility: From a personal instance to a large community, the open
ecosystem will guide the user based on their specific needs and budget;
- Inclusivity: Users and communities can collectively shape the ecosystem's
roadmaps, by co-designing and funding desired features.
From the other side, the dashboard will also operate as an economic network to
track each contribution and distribute the available funds according to value
equation formulas as democratically defined by the ecosystem stakeholders.
## What research methods will you use to answer this question? (Please describe the methodologies and scope of your proposed research (500 words))
To comprehensively address the research question, a blend of interdisciplinary
methods will be employed to ensure a thorough analysis, development, and
evaluation of the proposed integrated Bonfire and Co-op Cloud ecosystem. The
methodologies are outlined as follows:
- Literature Review:
An extensive literature review will be conducted to gather insights on existing
models of open co-operative ecosystems, challenges and best practices in FLOSS
development, hosting, and funding, and the impact of decentralized digital
infrastructures on promoting inclusivity and co-operation.
- Surveys & Interviews:
By using mixed methods we aim to gather insights from relevant parties such as
instance administrators, app maintainers, and FOSS contributors.
- User-Centered Design (UCD):
Utilizing UCD principles, we will engage potential users and stakeholders in
the design and development process. This will include conducting surveys,
interviews, and usability testing to gather user requirements, preferences, and
feedback on prototype iterations.
- Technical Development and Prototyping:
The core of the research involves the technical development and prototyping of
the integrated dashboard that facilitates the setup, hosting, and operation of
custom Bonfire instances (the first FOSS application to be integrated in the
open dashboard). Agile development methodologies, including iterative design
and development cycles, will be employed to ensure a user-centric approach and
to allow for continuous feedback and improvement.
- Case Studies:
Detailed case studies of relevant initiatives will be conducted to glean
insights into best practices, challenges, and success factors. Comparative
analysis will help in understanding the potential impact and sustainability of
the proposed ecosystem. We already have communities willing to participate in
these case studies, that span from citizen science projects
(https://niboe.info), hacker spaces (https://www.facebook.com/Zer081),
bioregional communities (driftless area), and more...
- Economic Modeling:
Economic modeling will be employed to devise a transparent value equation for
revenue distribution among stakeholders. This will also involve exploring
sustainable funding models that ensure the longevity and resilience of the
proposed ecosystem. We will make use of the ValueFlows protocol to test several
value equations: https://www.valueflo.ws/algorithms/equations/
- Policy and Legal Analysis:
An examination of the policy and legal frameworks that could impact, or be
impacted by, the proposed ecosystem will be conducted. This includes analyzing
data privacy laws, open-source licensing, and cooperative economic regulations.
- Dissemination and Feedback:
Sharing the findings and prototypes with the broader community through various
channels including conferences, blog posts, social media, and project websites
for feedback and further refinement.
## What data or other resources will you use to answer the question? (500 words)
- Domain Experts and Stakeholder Interviews:
Insights from domain experts in FLOSS development, digital co-operatives,
hosting solutions, and decentralized digital infrastructures. Interviews with
stakeholders including developers, hosting providers, and potential users of
the proposed ecosystem.
- Economic Models and Financial Data:
Economic models pertinent to revenue distribution, funding, and sustainability
of open cooperative ecosystems. Financial data of similar initiatives to
understand their economic sustainability and impact.
- Legal and Policy Documents:
Legal documents, open-source licenses, and policy frameworks relevant to data
privacy, digital rights, and co-operative economic structures.
- Technical Documentation:
Technical documentation of Bonfire, Co-op Cloud, and other open-source projects
pertinent to the research. Documentation on protocols, standards, and best
practices in FLOSS development, hosting, and support.
- Open Source Software Repositories:
Access to open-source software repositories to study existing solutions,
libraries, and frameworks that could be leveraged for the technical development
of the proposed ecosystem.
- Prototyping Tools and Development Platforms:
Utilization of prototyping tools and development platforms for designing,
developing, and testing the integrated dashboard and associated features.
## If applicable: What is the research finding that you are moving into practice? (500 words)
The findings we are acting upon highlight the pressing necessity for a digital
ecosystem that prioritizes sustainability, decentralization, and cooperation
while advancing open-source software development, hosting, support, and
funding.
Existing research and case studies have highlighted the challenges posed by the
large centralized and profit-driven digital platforms, which often compromise
data privacy, inclusivity, and the democratic ethos of the digital realm.
Noteworthy findings from prior researches that underpin our project include:
- Co-operative Ecosystems:
Research on co-operative models -- notably "Proposal for a Cooperative Model
for Digital Infrastructure and Recommendations to Adopt It" by Tierra Comun in
2022 -- has revealed the potential for fostering sustainable and equitable
digital ecosystems. Co-operative structures, grounded in principles of
mutualism and collective governance, have shown promise in promoting economic
sustainability and community-centric development.
- Need for Decentralization:
Studies have underscored the benefits of decentralized digital infrastructures
in promoting data sovereignty, reducing censorship, and fostering innovation
through open standards and interoperability as well as ("Accounting and Billing
for Federated Cloud Infrastructures", Elmroth et al., 2009 Eighth International
Conference on Grid and Cooperative Computing) the specific challenges in
tracking and distributing financial costs across these decentralized networks.
- Open Source as a Public Good:
The literature has extensively documented the value of FLOSS as a public good,
which can drive down costs, promote technical innovation, and foster a shared
digital commons.
- Challenges in FLOSS Sustainability:
Several reports (e.g. "Roads and Bridges: The Unseen Labor Behind Our Digital
Infrastructure", Nadia Eghbal, "The labor of maintaining and scaling free and
open-source software projects", Geiger et al, Proceedings of the ACM on
human-computer interaction 5.CSCW1, and "The coproduction of open source
software by volunteers and big tech firms", O'Neil et al., News and Media
Research Centre, 2021) have highlighted the challenges in sustaining open
source projects, often due to lack of funding, technical support, and a viable
economic model.
- User-Centric Design:
The importance of user-centric design in the development of digital platforms
to ensure accessibility, usability, and adoption has been well-documented.
- Community Engagement:
Engaging communities in design, development, and governance of platforms has
been found to promote inclusivity, trust, and long-term sustainability.
Moving these findings into practice, our proposal outlines a collaborative
endeavor between Bonfire and Co-op Cloud to develop an integrated open
dashboard that automates the setup, hosting, and operation of custom Bonfire
instances.
Practical implementations include:
- Developing a technical infrastructure that facilitates decentralized hosting
and operation of digital platforms, reducing reliance on centralized
entities.
- Establishing a co-operative economic model to ensure the financial
sustainability of the ecosystem, based on a transparent value equation for
revenue distribution among stakeholders.
- Engaging the community and potential users in the design and development
process to ensure the ecosystem meets their needs and preferences.
- Fostering a collaborative environment where developers, hosting providers,
and users can mutually benefit from the shared digital infrastructure.
- Implementing user-centric design principles to ensure the accessibility and
usability of the open dashboard, thus promoting broader adoption.
- Disseminating the developed prototypes and findings to the broader community
for feedback, further refinement, and adoption.
## What is the specific context / project / community that will be targeted with your research or its implementation - and why is it needed? (600 words)
RESEARCH (Phase 1):
A study on "Understanding the Open Infrastructure Ecosystem, with a Focus on
Federation," will set about comprehensively exploring practices and challenges
within the Federated ("Fediverse") and FOSS communities, It will investigate
co-design and development, documentation and onboarding, hosting,
configuration, maintenance, tech support, continuous integration, deployment
and upgrades, backups, community feedback and bug reporting, and governance.
This vital research addresses the centralization and monopolization of
platforms, barriers to entry, sustainability challenges, community empowerment,
knowledge sharing, and resilience and longevity of FOSS projects, to provide a
holistic understanding of the open infrastructure ecosystem.
We hope to identify common challenges faced by these communities, exploring
motivations for contributing or maintaining infrastructure, uncovering best
practices and potential solutions.
IMPLEMENTATION (Phase 2):
This above study will inform the development of a federated and cooperative
hosting ecosystem, helping to better align with the specific needs of instance
administrators, app maintainers and FOSS contributors. By initially focusing on
federated platforms and progresstively expanding to the broader ecosystem of
open infrastructure, the ecosystem can foster collaboration, enhance community
support, and contribute to the overall growth and sustainability of the
Fediverse and FOSS communities.
The implementation will start with Co-op Cloud, a software stack that
simplifies the hosting of FOSS applications, and Bonfire, a federated social
networking toolkit. These projects represent a microcosm of the broader open
source and cooperative ecosystem, and can serve as the initial building blocks
for user-friendly solutions and transparent, cooperative economic models,
ensuring accessibility and autonomy for all users.
This phase serves as a pragmatic step towards addressing identified needs, like
reducing technical barriers, fostering sustainability, and empowering
communities. It embodies a proactive shift towards a more decentralized,
cooperative, and equitable digital landscape, in response to the pressing
challenges and unmet needs within the FLOSS community and the broader digital
realm, and actively combats the issues of centralization, data control, and
sustainable revenue models, benefiting open source projects and communities
alike.
The integration of Bonfire and Co-op Cloud via a user-friendly dashboard will
significantly lower the technical barrier to entry, allowing a broader spectrum
of users to set up, host, and operate their own instances. Engaging their
communities, as well as the broader FLOSS community, in the design,
development, and governance of the proposed ecosystem to ensure it meets the
diverse needs and preferences of its stakeholders.
We'll also craft transparent value equations and economic models to foster a
sustainable, co-operative economic ecosystem where revenues are fairly
distributed among developers, hosting providers, and others.
DISSEMINATION (Phase 3):
Research findings will be compiled into a comprehensive report, offering
valuable insights to guide the evolution of the hosting ecosystem and
contribute to the knowledge base of open infrastructure practices and
challenges. This knowledge will be shared with the FOSS community and beyond,
promoting wider dialogue, feedback, and collaboration. This approach aligns
with the need for alternative economic models, transparency, and equitable
value distribution, and addresses the challenges of the current digital
landscape by advocating for decentralized, cooperative, and equitable
alternatives.
## Please summarize your proposed work and the key activities that you will undertake (500 words)
- Resarch study:
A study "Understanding the Open Infrastructure Ecosystem, with a Focus on
Federation" will be conducted as detailed above.
- Federation design & development:
We'll write an ecosystem federation proposal and resources to help others build
their own. A "start your federation cookbook" with analysis from a technical,
economic, legal, and governance perspective.
- Pilots:
We will work with several pilot users and organisations to provide feedback and
test our designs and solutions at every stage of the process. The various
pilots will help co-designing and test the open dashboard, by setupping custom
bonfire instances
- Capacity building and Architecture of Participation:
The capacity building activity will discover together with pilots and
participants how to draft a good governance and economic model to make all of
this work nicely.
- Protocol and platform integration:
Defining libre, reusable methods and systems for automatic DNS (across various
domain name registrars / DNS hosts) and server hosting provisioning (using e.g.
https://capsul.org), automated software installation and updates (using Co-op
Cloud's command-line tool Abra: https://docs.coopcloud.tech/abra/), backup and
data migrations (e.g. using http://tahoe-lafs.org/), user resource usage
measurement, payment integration, and dashboard UIs.
- Dissemination and communication:
This activity will focus on communicating with the world about our work, and
disseminate project outcomes and results through various channels, including
articles, conferences, social media, and project websites.
All the code produced will be documented, and publicly available with an open
source license. We will continue our outreach through our respective activity
on federated social media platforms including Bonfire itself, Mastodon,
Scuttlebutt, and Matrix.
## What partnerships and programs are critical to this work and how do you envision outreach activities? (400 words)
The proposed integration of Bonfire and Co-op Cloud is significantly enriched
by forming strategic partnerships with key entities in the open-source and
cooperative digital ecosystem. Here's how these partnerships are critical and
the envisioned outreach activities:
- Co-op Cloud Federation: partnership significance: Co-op Cloud Federation is
crucial for implementing the hosting and management of FOSS apps. This
partnership brings in vital technical expertise, hosting solutions, and the
potential for scaling the initiative across a federated network of service
providers. Outreach: Promoting the integrated solution through Co-op Cloud's
federated network, collaborating on joint marketing campaigns, and leveraging
the federation's channels to spread awareness and drive adoption.
- Bonfire Networks: partnership significance: Bonfire Networks provides the
foundational social networking toolkit that will be integrated with Co-op
Cloud. This partnership ensures technical synergy and collaborative
development, fostering an environment conducive to innovation and
user-centric design. Outreach: Engaging the existing community around Bonfire
Networks in workshops, webinars, and forums to introduce the integrated
solution, gather feedback, and foster active participation in its development
and utilization.
- Servers Co-op: partnership Significance: Servers.coop can play a key role as
a hosting provider within the ecosystem, offering reliable and cooperative
hosting solutions to users. Their involvement can help establish a network of
trustworthy hosting providers committed to cooperative principles. Outreach:
Joint campaigns promoting the benefits of cooperative hosting, showcasing
success stories, and educating communities on the advantages of
decentralized, cooperative digital infrastructures.
- Co-operative Computer: partnership Significance: Cooperative Computer can
provide valuable insights, technical expertise, and support in promoting
cooperative digital practices. This partnership can foster a shared learning
environment and potentially lead to collaborative projects enhancing the
integrated solution and actively participating in the open coop ecosystem.
Outreach: Hosting joint educational events, technical workshops, and online
discussions to explore cooperative computing models and their application in
the proposed ecosystem.
## What is your vision of success and what impact might it have? (400 words)
The vision of success for this initiative revolves around the establishment of
a self-sustaining, decentralized, and co-operative digital ecosystem that
significantly enhances the accessibility, usability, and economic
sustainability of FLOSS for all stakeholders.
The following are the key indicators of success and the potential impact of
this initiative:
- Ease of Access and Usability:
A successful implementation of the integrated dashboard that simplifies the
setup, hosting, and management of Bonfire instances, enabling a broader
spectrum of users, including those with limited technical skills, to leverage
FLOSS solutions effortlessly and in a trusted ecosystem.
- Economic Sustainability:
Establishment of a transparent and equitable economic model that ensures fair
revenue distribution among developers, hosting providers, and other
stakeholders, fostering financial sustainability and continued growth of the
Bonfire and Co-op Cloud ecosystems.
- Community Engagement and Governance:
Active engagement of the community in the decision-making processes,
development, and governance of the ecosystem, reflecting a vibrant,
participatory, and democratic digital co-operative environment.
- Increased Adoption and Experimentation:
A noticeable increase in the adoption of Bonfire and Co-op Cloud solutions,
alongside a proliferation of innovative projects and experiments emanating from
the co-operative ecosystem, contributing to a richer and more diverse digital
commons.
- Knowledge Sharing and Collaboration:
A thriving culture of knowledge sharing, collaborative development, and mutual
support within the ecosystem, facilitating continuous learning, innovation, and
problem-solving.
- Resilience and Longevity:
Demonstrated resilience of the co-operative digital ecosystem to evolving
economic, technical, and social challenges, ensuring its longevity and ongoing
relevance.
- Dissemination and Replication:
Effective dissemination of the insights, learnings, and models developed
through this initiative to the broader FLOSS community, encouraging replication
and adaptation of the co-operative model in other contexts.
In a broader sense, the success of this initiative could significantly
contribute to the reimagining and reshaping of the digital landscape in
alignment with the principles of openness, co-operation, and community-centric
development, echoing the core values and aspirations of the FLOSS community.
## Tell us more about the project team and collaborators (500 words)
The project is a multi-team effort between different stakeholders in the FLOSS
ecosystem. The project will be developed by a collaboration between two
projects: Bonfire and Co-op Cloud.
* Bonfire (https://bonfirenetworks.org) is an extensible open source federated
social networking toolkit, that empowers communities easily configure their
spaces from the ground up, according to a variety of needs and visions.
Bonfire envisions a web of independent but interconnected social networks
(using a wide definition, since we consider the social compoments of
activities in the economic, educational, and political spheres as well) -
able to speak and transfer information among each other, according to their
own boundaries and preferences.
* Co-op Cloud (https://coopcloud.tech/) is federation of democratic collectives
(including worker-owned co-operatives, an international radical art
collective, a labor union, and representatives from FLOSS software projects).
The federation is centred around a software stack that aims to make hosting
libre software applications simpler, aimed at organisations wanting to manage
their own infrastracture, as well as small service providers such as tech
co-operatives who are looking to standardise around an open, transparent and
scalable infrastructure -- but is also developing as community of practice
around these themes, beyond the specific technology stack.
## In which cost tier do you expect this work to sit?
- [ ] Between 50 and 75
- [ ] Between 75 and 100
- [x] Between 100 and 125
## How many months do you expect this work to take?
- 12 months
- more than 12 months (exception goes up to 18 months for part-time projects)
## Extras
### Research links
* https://apo.org.au/node/312607 - ONeil, Mathieu, et al. The coproduction of open source software by volunteers and big tech firms. News and Media Research Centre, 2021.
* https://dl.acm.org/doi/10.1145/3449249 - Geiger, R. Stuart, Dorothy Howard, and Lilly Irani. "The labor of maintaining and scaling free and open-source software projects." Proceedings of the ACM on human-computer interaction 5.CSCW1 (2021): 1-28.
* https://www.fordfoundation.org/wp-content/uploads/2020/12/regional-foss-communities_final-report_ahossain-1.pdf - Hossain, Anushah. "Regional Open Source Software Communities: The View From Dhaka, Bangladesh." (2021).
* https://digitalinfrastructure.fund/projects/cooperative-model-for-digital-infrastructure/ - Tierra Comun, Mexico, 2022
* https://ieeexplore.ieee.org/abstract/document/5279594 - E. Elmroth, F. G. Marquez, D. Henriksson and D. P. Ferrera, "Accounting and Billing for Federated Cloud Infrastructures," 2009 Eighth International Conference on Grid and Cooperative Computing, Lanzhou, China, 2009
* https://ieeexplore.ieee.org/abstract/document/7523331 - K. Chard and K. Bubendorfer, "Co-Operative Resource Allocation: Building an Open Cloud Market Using Shared Infrastructure," in IEEE Transactions on Cloud Computing, 2019
* https://ieeexplore.ieee.org/abstract/document/6253530 - F. Paraiso, N. Haderer, P. Merle, R. Rouvoy and L. Seinturier, "A Federated Multi-cloud PaaS Infrastructure," 2012 IEEE Fifth International Conference on Cloud Computing, Honolulu, HI, USA, 2012
* https://www.proquest.com/openview/d0bb1812450db201b4b67c84eca8cc50/1?pq-origsite=gscholar&cbl=18750&diss=y - Amini, Lisa D."Models and algorithms for resource management in distributed computing cooperatives,"Columbia University,2004
* https://hal.science/hal-03177060/document - Sébastien Broca, Laura Aufrère, Philippe Eynaud, Cynthia Srnec et Corinne Vercher-Chaptal, "Framasoft : de la plateforme à larchipel", 2021

View File

@ -0,0 +1,3 @@
---
title: Funding applications
---

View File

@ -0,0 +1,80 @@
---
title: Private funder
---
# Private funder
> Status: **accepted**
## Project Title
Co-op Cloud Federation & abra critical bug fixes
## Explain the project and its expected outcome(s).
We are requesting support to tackle two important tasks in Co-op Cloud, to improve the projects long-term sustainability:
* Formalising, and publicly launching the “Co-op Cloud Federation”,
* Fixing critical usability issues in abra which are hindering further adoption.
### The Federation
In April 2022, we announced our proposal for how the Co-op Cloud federation could function:
* [Public announcement blogpost](https://coopcloud.tech/blog/federation-proposal/)
* [Actual proposal text](https://pad.autonomic.zone/s/MLafJE2jC#)
Weve gathered feedback from community members and are ready to take the proposal forward. This period of feedback gathering went beyond our [ECF Culture of Solidarity funding timeline](https://culturalfoundation.eu/stories/culture-of-solidarity-fund/), so we are happy to receive support to finalise it now.
This will mean formalising our decision-making structure, clarifying membership in the federation and helping lay the foundations for economic self-sufficiency through agreed membership and user group fees.
We propose a series of meetings with active community members to achieve this.
### Critical abra bug fixes
We have identified a few bugs in theabra commandline tool that, once sorted, will greatly improve adoption of Co-op Cloud. This support will help us fix these bugs which takes us one step closer to a stable 1.0 release.
* Making abra resilient to outages in git.coopcloud.tech and the machine-readable `recipes.coopcloud.tech/recipes.json` (issue `#292`)
* Supporting language translations for the Co-op Cloud website and documentation (issue `coop-cloud/organising#74`)
* Bringing per-recipe documentation up-to-date with the latest abra syntax (issue `coop-cloud/organising#356`)
* Solidifying the machine-readable `recipes.coopcloud.tech/recipes.json` deployment (issue `coop-cloud/recipes-catalogue-json#3`)
* Making some usability tweaks to abras interface (issue `coop-cloud/organising#335` and issue `coop-cloud/organising#308)`
* Stabilising how abra interacts with SSH (issue `coop-cloud/organising#345`)
## Requested Amount
* 9,240 GBP
## Explain what the requested budget will be used for?
* Participation of all members at a series of meetings to discuss the proposal
* 60 GBP * 1 member from 8 member collectives * 6 hrs (3 meetings, 2 hr a meet) = 2880GBP
* Paying wages for 5 Autonomic members to collect feedback, amend the proposal & publish it
* 60 GBP * 5 members * 6 hrs = 1800GBP (collective meets)
* 60 GBP * 5 members * 4 hrs = 1200GBP (internal meets)
* 60 GBP * 1 member * 5 hrs = 300GBP (finance admin)
* Paying wages for 3 external contributors helping in the process (bug fix, writing, etc)
* 60 GBP * 3 members * 5 hrs = 900GBP
* Implementing the proposal: 3 months of admin time until which point we have enough members to support ongoing admin costs
* 60 GBP * 1 member * 2 hrs * 3 months = 360 GBP
* abra critical usability fixes
* 60 GBP * 2 members * 15 hrs = 1800 GBP
## What are significant challenges you expect to face?
Designing and settling on a format for the federation will be our main challenge. We expect that working together within a diversity of co-operatives and group members will present a spectrum of opinions on how the federation ought to function. Finding common ground amongst ourselves may pose a challenge. Finding a sufficient number of members for a functioning federation may be difficult.
While we all have a lot of experience with group decision-making through our involvement in Autonomic and other multi-stakeholder co-operatives, it could be a challenge to settle on a decision making system.
# Describe the ecosystem of the project, and how you will engage with relevant actors and promote the outcomes?
Several collectives are using Co-op Cloud as their preferred hosting method for example [Bonfire](https://bonfirenetworks.org/) and [Local-IT](https://local-it.org/) (see "Co-op Cloud “The Organisation”" on [The Co-op Cloud Public Beta](https://coopcloud.tech/blog/beta-release/) for the full list of participants).
We have over 500 followers on [Mastodon](https://social.coop/@coopcloud/), but our primary communication and recruitment relies on word of mouth, and people inviting each other to our Matrix channel. The community members have already [written](https://cgalo.dev/pages/from-coop-cloud-to-plain-docker-swarm/) [articles](https://gnulinux.ch/selfhosting-mit-co-op-cloud-und-abra) about Co-op Cloud and we expect this to happen again.

View File

@ -0,0 +1,105 @@
---
title: Sovereign Tech Fund
---
# Sovereign Tech Fund
> Status: **rejected**
## Project title
Critical fixes & enhancements for Abra, the Co-op Cloud command-line interface
## Describe your project in a sentence.
Abra is the flagship command-line interface for Co-op Cloud, built to support the day-to-day workflow of deployment operators and recipe (app configuration) maintainers.
## Describe your project more in-depth. Why is it critical?
The core technical work of the Co-op Cloud project involves democratic tech collectives hosting open source apps on self-managed servers. These apps empower digital sovereignty for members of our own collectives, and the wider community of partners, allies and clients for whom we operate these privacy-preserving, commons-based services. This is vital at a time of increasing surveillance predation and centralisation by "Big Tech" firms including widespread regulatory capture but also as public awareness of these issues grows, to facilitate concrete and meaningful action.
Day-to-day operation of Co-op Cloud uses the "Abra"command-line interface to interact with the app packaging & maintenance ecosystem, run app deployments and support long-term app maintenance (backup, restore, monitoring, etc.).
Since the Beta launch of Co-op Cloud in May 2022, we've formed a federation with 10 founding members, 2 of which run large-scale deployments (100+ apps in production) managed using Abra. Each open source app requires maintaining a shared app configuration ("recipe") using Abra, collectivising the federation members' experience into the digital commons.
Abra is a critical infrastructural resource because operators and recipe maintainers rely on it to do their work, share their work and operate and maintain their Co-op Cloud deployments and recipes. Abra is increasingly being relied upon for daily operations by more democratic tech collectives as the Co-op Cloud project scales up membership.
## Link to project repository
[`git.coopcloud.tech/coop-cloud/abra`](https://git.coopcloud.tech/coop-cloud/abra)
## Link to project website
[`coopcloud.tech`](https://coopcloud.tech)
## Please provide a brief overview over your projects own dependencies.
The design of Abra is based on the idea of wrapping existing APIs and interfaces to provide a more convenient and efficient workflow for operators and maintainers. In this way, Abra relies directly on integrations with core Linux tooling such as Docker, Git and SSH.
Abra relies primarily on interacting with the Docker Engine APIs using the Go programming language, in order to interact and control container runtimes on the self-managed servers. Abra speaks directly to the Docker daemon on the server using those APIs. Abra also relies on several non-public APIs from Docker and Mobdy related packages.
Abra provides [library APIs for clients](https://pkg.go.dev/coopcloud.tech/abra) which are currently available for experimental use. Tools such as [Kadabra](https://docs.coopcloud.tech/operators/tutorial/#automatic-upgrades) consume the Abra API in order to provide server-side automation, e.g. automatic upgrades. Furthermore, [cctuip](https://git.coopcloud.tech/decentral1se/cctuip), a prototype text-based user interface for operators also consumes the Abra APIs.
Both Kadabra and cctuip are being developed by members of the Co-op Cloud federation. Both tools are actively being used, tested and developed within the context of production deployments.
Abra relies on self-hosted Gitea (code hosting) & Drone (continuous integration / continuous deployment) systems to provide binary builds and release automation.
Operators and maintainers who rely on Abra for daily operations are as follows:
- [Autonomic co-operative](https://autonomic.zone)
- [Local-IT](https://local-it.org/)
- [Solisoft](https://solisoft.top)
- [Flancia](https://flancia.org/)
- [Social.coop](https://social.coop)
- [Bonfire](https://bonfirenetworks.org/)
- [ruangrupa](https://documenta-fifteen.de/en/lumbung-space/)
- [UTAW](https://utaw.tech/about/)
- [Kotec co-operative](https://kotec.space/)
## Which target groups does your project address (who are its users?) and how do they benefit from the funding (directly and indirectly)?
The intended public of the Co-op Cloud project are established democratic tech collectives, such as technology co-operatives, who are already involved in public service providing. This focus allows us to situate our work within the specific requirements of this community, of which we are also a member.
Collectives would immediately benefit from the funding of critical fixes and enhancements in Abra: the fixes and enhancements listed in this proposal are generated through our bug reports, discussions and proposals for change. Receiving funding to proceed with this work will bring the exact changes required to improve the day-to-day operations and maintenance of the Co-op Cloud technical community.
Collectives face issues of scale when trying to achieve financial sustainability. As a consequence of Big Tech, end-users are accustomed to receive services for free or at very little charge. Small service providers need to scale out usership to make ends meet, which brings the risk of becoming overwhelmed with maintenance tasks, e.g. responsibility to backup data correctly across several apps/servers/groups.
Tools such as Abra play a key role in reducing the maintenance burden and expanding collaboration within the responsible collectives, because it is designed to do so by the community itself. In this sense, an improved and stable Abra increases the chances that end-users receive a stable and reliable service, which in turn helps with further outreach to grow the number of users benefiting from privacy-preserving, user-friendly, and community-directed software systems.
## How was the work on the project made possible so far (structurally, financially, including volunteer work)? If applicable, list others sources of funding that you applied for and/or received.
Co-op Cloud, including Abra, was initiated by members of [Autonomic Co-operative](https://autonomic.zone/blog/2021/03/the-co-operative-cloud/) initially on a volunteer basis, and then financially compensated from Autonomic's revenue once Abra reached an initial alpha release, including nominal back-pay for the volunteer work.
Shortly afterwards, Co-op Cloud received 32,986 EUR in funding from the [European Cultural Foundation](https://culturalfoundation.eu/stories/cosround4-autonomic-co-operative) to bring the project to public beta, and more widespread adoption by tech collectives. Autonomic Co-operative, who applied for the funding and continued to manage Co-op Cloud & Abra development during this period, helped distribute this funding to community members, to help avoid the frequent reliance of commons technology projects on volunteer labour.
Following the public beta launch, the project received 10,000 GBP in funding from a private donor to support the launch of the Co-op Cloud Federation, a nascent multi-stakeholder co-operative modelled after the [CoopCycle model](https://coopcycle.org/en/federation/).
We also applied for the [NLNet User-Operated Internet Fund](https://nlnet.nl/useroperated/) for funding to work on an web-based operator interface but were unsuccesful.
Currently, the project's main sources of funding is the membership dues of 10 federation members who pay 10 GBP / month to the federation common fund, and the ~5000 EUR left over from the private donation.
## What do you plan to implement with the support from STF?
The Co-op Cloud project is reaching a point where a significant number of democratic tech collectives rely on Abra for daily operations of their large scale production deployments.
This brings new technical challenges in two directions.
The first is handling the increase in bug reports. The challenge here is the increasing scale, diversity and collective triage and discussion required to fix the bugs. We're seeing that these new fixes must be nuanced in their implementation and aware of diverse needs of operators/maintainers. This can often result in democratic decision-making to achieve consensus on a fix that is agreeable to those involved.
The second is a new challenge in which we must implement larger scale enhancements in Abra. We're seeing changing workflows, new approaches to deployments and discussion which result in proposals for significant changes in Abra. These changes often risk major disruption in workflows, e.g. for the app maintainer ecosystem and require a period of consensus building and democratic decision making around a proposal. Furthermore, the deployment of these changes typically require a pre-release and early adopter testing phase before rolling them out fully in a new release of Abra.
We currently categorise these two development trajectories under the following project boards:
* [Critical fixes (15 tickets at time of writing)](https://git.coopcloud.tech/coop-cloud/organising/projects/24)
* [Medium/large enhancements (15 tickets at time of writing)](https://git.coopcloud.tech/coop-cloud/organising/projects/25)
Abra has proven itself as a resilient toolset over 3 years of development and adoption. However, with the increase in scope of fixes and proposals for large scale changes, is at risk of falling behind and at worst, becoming an obstacle to day-to-day operations as the ecosystem of open source infrastructure management continues to change.
With the support of STF we can ensure the continued resilience of the project by implementing the fixes and changes generated by the Co-op Cloud community of operators and maintainers.
## Who (maintainer, contributor, organization) would be most qualified to implement this work/receive the support and why?
Abra currently has 7 maintainers who work infrequently on Abra alongside their existing responsibilities in their own tech collectives. 2 of these developers have been involved in the first implementation of Abra, including the original Bash implementation. 4 tech collectives are represented in this development team.
We believe we have the expertise within the existing maintenance team to carry out the proposed changes in Abra. In our estimations, we expect that 2 developers can engage significantly in Abra development on a more dedicated basis over the course of 8 months.

View File

@ -0,0 +1,91 @@
---
title: User-Operated Internet Fund
---
# User-Operated Internet Fund
> Status: **rejected** ([Link to open call](https://nlnet.nl/useroperated/))
## Questions
> Please be short and to the point in your answers; focus primarily on the what and how, not so much on the why. Add longer descriptions as attachments (see below). If English isn't your first language, don't worry - our reviewers don't care about spelling errors, only about great ideas. We apologise for the inconvenience of having to submit in English. On the up side, you can be as technical as you need to be (but you don't have to). Do stay concrete. Use plain text in your reply only, if you need any HTML to make your point please include this as attachment.
### 1. Abstract: Can you explain the whole project and its expected outcome(s). (1200 chars)
We're seeking financial support to build a web interface for [The Co-operative Cloud](https://coopcloud.tech), an open platform for public interest infrastructure. This will allow us to accelerate our plans to bring Co-op Cloud to end users, expanding the model from community hosting to self-hosting.
The command-line version of Co-op Cloud is already helping empower democratic collectives to run their own applications securely and reliably -- from file-sharing to broadcasting to real-time chat. We released the CLI in alpha form in March 2021, and we're currently working towards a beta release in November 2022.
Our current plan is to develop a web interface within the next 3-5 years, using income from providing managed Co-op Cloud hosting, to remove the requirement to be familiar with a shell prompt, and provide an open version of the "one click apps" available with some corporate providers.
### 2. Have you been involved with projects or organisations relevant to this project before? And if so, can you tell us a bit about your contributions? (??)
We have participated in the [Yunohost](https://yunohost.org) and [Librehosters](https://libreho.st) projects, which aim to address some of the same challenges as Co-op Cloud, and our experiences with those organisations informed our design. More broadly than those very similar projects, we have also contributed to libre software applications like Discourse, Drupal and Peertube, and we're helping with community stewardship of the Mailu libre email project.
### 3. Requested Amount (5000 to 50,000 EUR)
46,000
### 3A. Explain what the requested budget will be used for?
- Brand design, UI research & design: 10%
- UX testing: 5%
- Software architecture and implementation: 40%
- Project management: 10%
- Community engagement & outreach: 5%
- Security audit & bug bounties: 20%
- Language translations: 10%
### 3B. Does the project have other funding sources, both past and present?
We are currently receiving funding from the European Culture of Solidarity Foundation under the "Infodemic" call, to build the beta version of the Co-op Cloud platform, €31,000 in total from July 2021 - November 2022.
Beyond our grant funding, and support in terms of time and technical resources from Autonomic Co-operative, Co-op Cloud is also supported by 11 co-funding partner organisations who are now running some or all of their technology infrastructure using the platform: [ruangrupa](https://ruangrupa.id) -- curators of the upcoming ["documenta fifteen" event](https://www.documenta.de/en/documenta-fifteen/#) -- [WASHNote](https://washnote.com), [Social Media Analysis Toolkit (SMAT)](https://www.smat-app.com), [Neuronic Games](https://www.neuronicgames.com), [Third Sector Accountancy](https://www.thirdsectoraccountancy.coop), [Biobulkbende](https://biobulkbende.org), [Anarchy Rules](https://anarchyrules.info), [Fashion Revolution](https://fashionrevolution.org), the [Industrial Workers of the World](https://iww.org.uk), [Shaping Our Lives](https://www.shapingourlives.org.uk/) and [United Tech and Allied Workers](https://utaw.tech).
### 4. Compare your own project with existing or historical efforts. (eg what is new, more thorough, or otherwise different)
We maintain an ongoing analysis of Co-op Cloud compared to other options in the [Co-op Cloud documentation](https://docs.coopcloud.tech/faq/#what-about-alternative).
Overall, Co-op Cloud has architectural and organisational advantages over existing libre options like Yunohost and [Caprover](https://caprover.com), and our open governance and libre licencing make Co-op Cloud a better long-term, pro-social choice than proprietary platforms like [Cloudron](https://cloudron.io). Versus options like [Ansible](https://ansible.com) or [Kubernetes](https://kubernetes.io), Co-op Cloud aims to be usable by less-technical users, to reduce their reliance on third parties to manage their data and tools.
### 5. What are significant technical challenges you expect to solve during the project, if any?
The main challenge that we aim to overcome in building this web application is making some of the complex concepts around self-hosting accessibile to non-technical users, simplifying and automating DNS, backups, application updates, and updates of the Co-op Cloud web application itself.
A key secondary technical challenge will be ensuring up-to-date, high-quality translations, which we plan to achieve by closely integrating Weblate with our code and documentation management systems.
Another goal is to ensure the web application is resource-efficient, while remaining delightful to use, to maximise the range of hardware that it can be used on.
Lastly, we hope to continue the project of user education around the concept of data sovereignty, as well as provide the technical tools to help people migrate away from, and stay away from, big-tech surveillance.
In terms of technical risks in the project, we see:
- security (mitigated by an in-depth security review before launch, and the going bug bounty program)
- configuration management (mitigated by using the existing git-based configuration management system from Co-op Cloud's command-line interface)
- support (mitigated by continuing to grow the Co-op Cloud community, to maximise the opportunity for peer assistance)
### 6. Describe the ecosystem of the project, and how you will engage with relevant actors and promote the outcomes? (Eg which actors will you involve? Who should deploy or run your solution to make it a success?)
We plan to build on our existing, successful, outreach strategy throughout our networks. We will make use of:
.. forums such as [CoTech](https://community.coops.tech, 581 members) and [International Co-operative Alliance](https://patio.ica.coop, 250 members) to make the project visible for technology co-operatives. Estimated 861 technology co-operative members, representing over 100 different co-operatives.
.. the [CHATONS](https://chatons.org, 70 members) and [Librehosters](https://libreho.st, 21 members) networks to maximise our reach amongst democratic technology collectives based in Europe. Estimated 91 collectives.
.. Cyberia Computer Club, an international network with whom we've already collaborated on integrations between their software and Co-op Cloud. Approximately 260 people.
.. both [traditional](https://twitter.com/autonomiccoop, 220 followers) and [alternative social media](https://sunbeam.city/@autonomic, 119 followers) to reach open source developers and other wider comunity members. Estimated 339 followers.
.. our own [co-operative website](https://autonomic.zone), which is visited by a wide range of potential clients, partners, and members. Estimated 1,000 visitors / month.
.. our self-hosted Matrix channel for [Co-op Cloud](#coop-cloud:autonomic.zone). 44 members (and growing), including representatives of some international organisations.
.. our personal relationships with democratic technologists internationally, including in Pakistan, India, Brazil, Canada, Spain, the USA, and others. Estimated ~50 unique contacts.
Our goal would be to see at least 3 other democratic collectives, from anywhere within these networks, using Co-op Cloud by the time of the launch of the beta web application, and to see a further 20 people join our Matrix chat as individual users. We also hope to see at least one strategic alliance with an initiative like Freedombox, or Cyberia's Greenhouse, to integrate Co-op Cloud with other efforts to improve the self-hosting landscape.
### Attachments
Attachments: add any additional information about the project that may help us to gain more insight into the proposed effort, for instance a more detailed task description, a justification of costs or relevant endorsements. Attachments should only contain background information, please make sure that the proposal without attachments is self-contained and concise. Don't waste too much time on this. Really.
We have attached a budget document.

View File

@ -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 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.
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.
## Monthly updates

View File

@ -2,7 +2,7 @@
title: Organisers Guide
---
Welcome to the organisers guide! Organisers are folks who focus on the social work in the project. Speaking for the project at talks, helping new tech co-ops & collectives join, keeping an eye out for funding opportunities, seeing what things up come up in the community chats, etc. It's important work.
Welcome to the organisers guide! Organisers are folks who focus on the social work in the project. Speaking for the project at talks, helping new tech co-ops & collectives join, keeping an eye out for funding opportunities, seeing what things come up in the community chats, etc. It's important work.
We're still working out what it looks like to do this kind of work in the project. If you like the idea of this kinda of work and/or are already doing it, please send patches to improve this documentation :rocket:

View File

@ -0,0 +1,243 @@
---
title: The Co-op Cloud Federation Proposal
---
# The Co-op Cloud Federation Proposal
## Table of Contents
- [Goal](#Goal)
- [Overview](#Overview)
- [Process](#Process)
- [The Federation Proposal](#The-Federation-Proposal)
- [The Code of Co-operation Proposal](#The-Code-of-Co-operation-Proposal)
## Goal
This document is for the folks who are curious about what is means to "join the Co-op Cloud". You may already be lurking the Matrix channels, have deployed some apps with `abra` or support the project and want it to succeed :heart:
If this is the first time you're seeing the project, please do take a look at [coopcloud.tech](https://coopcloud.tech) & maybe [docs.coopcloud.tech](https://docs.coopcloud.tech) for more of a technical deep dive. You're also more than welcome to join the project!
## Overview
As part of the [beta bikemap goals](https://pad.autonomic.zone/s/C3uuqfSCk) we are aiming to formalise the idea of what ["Co-op Cloud 'The Organisation'"](https://pad.autonomic.zone/s/C3uuqfSCk#Co-op-Cloud-%E2%80%9CThe-Organisation%E2%80%9D) could mean concretely. Here is what we wrote in our bike map originally:
> One of the core goals of Co-op Cloud is to have the project run and managed by a diverse group of tech co-ops and collectives who are invested into building, maintaining and extending this digital configuraton commons. In order to open the project up we need to work on shared governance guidelines, codes of conduct, building community trust and working towards economic sustainability.
Now that we are reaching the moment where we can make the beta release, we are ready to publish this proposal for feedback, discussion & amendments.
## Process
In terms of feedback, we don't think we have to figure it all out now. What is more important is to lay the foundations for democratically working it out as we go on. Any red flags, major concerns & blockers to participation would be great to discover at this early stage. All comments, feedback & constructive criticism is welcome!
We are happy to receive this on any of the communication channels that we have. Please see our [contact docs](https://docs.coopcloud.tech/intro/contact/) for more. We will gather all feedback, discussions & follow up with people by the end of April 2022. We are aiming to publish this proposal by mid May 2022.
---
## The Federation Proposal
### Members
Co-op Cloud is a federation of co-operative hosters centred around the [Co-op Cloud project](https://coopcloud.tech). By Co-operative hosters, we mean worker- or user-owned co-operatives, or other democratic collectives who are operating in the public interest.
### Vision
A world where it's much easier to host technology services, creating local, community-run and participatory tech hosters, enabling more and more people to use services provided in the public interest, instead of ones operated by predatory advertising or planned obsolescence companies.
### Aims
1. Develop the Co-op Cloud technical app platform, including the [abra](https://docs.coopcloud.tech/abra/) command-line tool, the [application recipe catalogue](https://recipes.coopcloud.tech), and the [documentation](https://docs.coopcloud.tech).
1. Maintain a community of mutual support between co-operative hosters.
1. Facilitate communication between users and developers of libre software.
1. Create a support and knowledge sharing network to make setting up new co-operatives easier.
### Benefits
As a member of Co-op Cloud, you'll be able to:
- Participate in decision-making -- about the direction of Co-op Cloud, and how to distribute income from grants and donations.
- Get listed as a recommended service provider [on the Co-op Cloud website](https://coopcloud.tech).
- Receive announcements about opportunities for funded work on Co-op Cloud early, before they're sent out to the wider community.
- Use shared Co-op Cloud services, including code hosting ([git.coopcloud.tech](https://git.coopcloud.tech)), continuous deployment ([builds.coopcloud.tech](https://builds.coopcloud.tech)) and any future digital infrastructure we all decide to set up.
### Responsibilities
**Co-op Cloud members are expected to:**
- participate in all Large decisions,
- pay a financial contribution of £10/month or more via our [Open Collective](https://opencollective.com/coop-cloud),
- uphold the Code of Co-operation (see [below](#The-Code-of-Co-operation-Proposal))
### Decision-making
We propose to follow the decision making method of [Autonomic Co-op](https://autonomic.zone) which is explained in [this blog post](https://autonomic.zone/blog/how-we-make-decisions/) and adapted here for review. Decisions can be split intro three categories: Small, Medium and Large.
#### Small - "Get on and do a thing"
- No one cares.
- Made by an individual within the federation.
- Could be in any area.
- 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.
- Doesnt have an effect on the direction or operation of Co-op Cloud as a whole.
- Give a deadline: unless other members object or ask for more time by then, it goes ahead.
- The deadline must be reasonable (a week by default).
- If any member of Co-op Cloud thinks its a Large decision, achieve Maximum Consensus™ (see [below](#Large---Maximum-Consensus-™)).
#### Large - "Maximum Consensus ™"
- Important decisions affecting the operation, direction, working conditions and finances of Co-op Cloud.
- Consensus voting: addressing any concerns.
- Can be requested by any member of Co-op Cloud for any decision.
- Input from every Co-op Cloud member.
- Whoever proposes Large decisions is responsible for chasing up members for votes.
- Votes can be in favour, against, abstain (stand aside) or block.
- One member (individual or organisation) = 1 vote
#### Process
For Medium and Large decisions:
- Write up a proposal somewhere publicly accessible on the internet.
- Announce the decision in the [General chat (`#coopcloud:autonomic.zone`)](https://docs.coopcloud.tech/intro/contact/#matrix) on Matrix
- List the decision on the [decisions page](https://docs.coopcloud.tech/democracy/decisions) on our documentation
- Announce the result in the [General chat (`#coopcloud:autonomic.zone`)](https://docs.coopcloud.tech/intro/contact/#matrix) and record it on the [decisions page](https://docs.coopcloud.tech/democracy/decisions) of the documentation
#### Proposal format
(For Medium and Large decisions).
- What you want to change.
- Who it affects.
- Size (Medium / Large).
- Decision number
- Deadline.
- What chat channel you want discussion to happen in.
#### Example Proposal
**Large decision 001**: *Change the name of Co-op Cloud to Co-op Sun*
This decision affects everyone who uses and contributes to the project. I think the current name is too corporate.
The voting deadline for this decision is **January 1st 1970**.
Please discuss this proposal in `#coopcloud-comm-org:autonomic.zone`.
---
## The Code of Co-operation Proposal
> Huge thanks to the folks at [Varia](https://varia.zone/) & [LURK](https://lurk.org) who carefully prepared wonderful Code of Conduct documents which we have adapted for our needs (with permission). See the original documents [here](https://varia.zone/en/pages/code-of-conduct.html) and [there](https://lurk.org/TOS.txt).
Co-op Cloud is used by several communities coming from a variety of cultural, ethnic and professional backgrounds. We strive for to be welcoming to people of these various backgrounds and provide a non-toxic and harassment-free environment.
The Code of Conduct is a set of guidelines that help establish shared values and ensure that behaviour that may harm participants is avoided.
We acknowledge that we come from different backgrounds and all have certain biases and privileges. Therefore, this Code of Conduct cannot account for all the ways that people might feel excluded, unsafe or uncomfortable. We commit to open dialogues, and as such this Code of Conduct is never finished and should change whenever needed. We amend this document over time so it reflects the priorities and sensitivities of the community as it changes.
It is a collective responsibility for all of us to enact the behaviour described in this document.
## Expected behaviour
We expect each other to:
### Be considerate...
...of each other, the space we enter, the Co-op Cloud community and the practices that it houses.
### Be open and generous...
...while trying not to make assumptions about others. This can include assumptions about identity, knowledge, experiences or preferred pronouns. Be generous with our time and our abilities, when we are able to. Help others, but ask first. There are many ways to contribute to a collective practice, which may differ from our individual ways.
### Be respectful...
...of different viewpoints and experiences. Respect physical and emotional boundaries. Be respectful of each others' limited time and energy. Take each other and each other's practices seriously. Acknowledge that this might lead to disagreement. However, disagreement is no excuse for poor manners.
### Be responsible....
...for the promises we make, meaning that we follow up on our commitments. We take responsibility for the good things we do, but also for the bad ones. We listen to and act upon respectful feedback. We correct ourselves when necessary, keeping in mind that the impact of our words and actions on other people doesn't always match our intent.
### Be dedicated...
...which means not letting the group happen to us, but making the group together. We participate in the group with self-respect and don't exhaust ourselves. This might mean saying how we feel, setting boundaries, being clear about our expectations. Nobody is expected to be perfect in this community. Asking questions early avoids problems later. Those who are asked should be responsive and helpful.
### Be empathetic...
..by actively listening to others and not dominating discussions. We give each other the chance to improve and let each other step up into positions of responsibility. We make room for others. We are aware of each other's feelings, provide support where necessary, and know when to step back. One's idea of caring may differ from how others want to be cared for. We ask to make sure that our actions are wanted.
### Foster an inclusive environment...
...by trying to create opportunities for others to express views, share skills and make other contributions. Being together is something we actively work on and requires negotiation. We recognize that not everyone has the same opportunities, therefore we must be sensitive to the context we operate in. There are implicit hierarchies that we can challenge, and we should strive to do so. When we organize something (projects, events, etc.), we think about how we can consider degrees of privilege, account for the needs of others, promote an activist stance and support other voices.
## Unacceptable behaviour
### No structural or personal discrimination
Attitudes or comments promoting or reinforcing the oppression of any groups or people based on gender, gender identity and expression, race, ethnicity, nationality, sexuality, sexual orientation, religion, disability, mental illness, neurodiversity, personal appearance, physical appearance, body size, age, or class. Do not claim “reverse-isms”, for example “reverse racism”.
### No harrassment
Neither public nor private. Also no deliberate intimidation, stalking, following, harassing photography or recording, disruption of events, aggressive, slanderous, derogatory, or threatening comments online or in person and unwanted physical or electronic contact or sexual attention. No posting or disseminating libel, slander, or other disinformation.
### No violation of privacy
Namely publishing others private information, such as a physical or electronic address, without explicit permission. Do not take or publish photos or recordings of others after their request to not do so. Delete recordings if asked.
### No unwelcome sexual conduct
Including unwanted sexual language, imagery, actions, attention or advances.
### No destructive behaviour
Or any other conduct which could reasonably be considered inappropriate. This includes (but is not exclusive to) depictions of violence without content warnings, consistently and purposely derailing or disrupting conversations, or other behaviour that persistently disrupts the ability of others to engage in the group or space.
## Intervention procedure
**Immediate intervention (help is needed now!)**
If you are feeling unsafe, you can immediately contact the Co-op Cloud members who are tasked with making sure the code of co-operation is respected.
These contact people are members of Co-op Cloud who will do their best to help, or to find the correct assistance if relevant/necessary. Here is the list so far. If you would like to help in this task, please also feel free to volunteer to be a support member.
> handle: `decentral1se`
> contact: [helo@coopcloud.tech](mailto:helo@coopcloud.tech)
> handle: `3wc`
> contact: [helo@coopcloud.tech](mailto:helo@coopcloud.tech)
For example, something happened during a still-ongoing online event and needs to be acted upon right away. Action is taken immediately when this violation of the code of co-operation is reported. This could involve removing an attendee from said event.
## Non-immediate intervention (a situation that requires more time)
Other violations need to be considered and consulted upon with more people or in a more measured way. For example: If you experience an ongoing pattern of harrassment; if you witness structurally unacceptable behaviour; if somebody keeps "accidentally" using discriminatory language, after being asked to stop.
If you feel comfortable or able, discuss the issues with the involved parties before consulting a mediator. We prefer to constructively resolve disagreements together and work to right the wrong, when it is possible and safe to do so. However, if the problems still persist, those who are responsible for enforcing the code of co-operation can help you deal with these kinds of problems. Contact the members listed above. Information will be handled with sensitivity.

View File

@ -0,0 +1,3 @@
---
title: Proposals
---

View File

@ -7,13 +7,15 @@ use_directory_urls: true
theme:
name: material
features:
- content.action.edit
- navigation.expand
- navigation.indexes
- navigation.instant
- navigation.path
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.indexes
- content.action.edit
- navigation.tracking
palette:
primary: light pink
accent: purple
@ -59,6 +61,16 @@ nav:
- "Organisers Guide":
- organisers/index.md
- "Organising handbook": organisers/handbook.md
- "Funding applications":
- organisers/funding-applications/index.md
- organisers/funding-applications/culture-of-solidarity.md
- organisers/funding-applications/ford-foundation.md
- organisers/funding-applications/private-funder.md
- organisers/funding-applications/sovereign-tech-fund.md
- organisers/funding-applications/user-operated-internet.md
- "Proposals":
- organisers/proposals/index.md
- organisers/proposals/federation.md
- "Recipes":
- recipes/index.md
- "Abra":
@ -83,10 +95,14 @@ nav:
- federation/resolutions/passed/004.md
- federation/resolutions/passed/005.md
- federation/resolutions/passed/006.md
- federation/resolutions/passed/007.md
- federation/resolutions/passed/008.md
- federation/resolutions/passed/009.md
- federation/resolutions/passed/010.md
- federation/resolutions/passed/011.md
- federation/resolutions/passed/012.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

View File

@ -1,4 +1,4 @@
mkdocs-awesome-pages-plugin==2.9.1
mkdocs-material-extensions==1.1.1
mkdocs-material==9.1.19
mkdocs==1.4.3
mkdocs-awesome-pages-plugin==2.9.2
mkdocs-material-extensions==1.3
mkdocs-material==9.4.10
mkdocs==1.5.3