diff --git a/docs/intro/bikemap.md b/docs/intro/bikemap.md new file mode 100644 index 0000000..e6fe416 --- /dev/null +++ b/docs/intro/bikemap.md @@ -0,0 +1,5 @@ +--- +title: Bike map +--- + +The project is currently in an [alpha quality](https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha) release state. We are working towards a [beta release](https://en.wikipedia.org/wiki/Software_release_life_cycle#Beta). We do not currently have an exact for the public Beta release yet. Our public Beta goals are listed in the following pad: [Beta Bike Map](https://pad.autonomic.zone/s/C3uuqfSCk). What we're currently working on is listed on this issue tracker: [`coop-cloud/organising`](https://git.autonomic.zone/coop-cloud/organising/issues). diff --git a/docs/x-archive/credits.md b/docs/intro/credits.md similarity index 79% rename from docs/x-archive/credits.md rename to docs/intro/credits.md index 6fac357..9a87d16 100644 --- a/docs/x-archive/credits.md +++ b/docs/intro/credits.md @@ -9,3 +9,4 @@ Special thanks to: - [Doop Coop](mailto:cluck@doop.coop), for making a transparent version of the Co-op Cloud logo, and helping with OSX alpha testing. - [Social.coop](https://social.coop), for warmly welcoming us onto [`social.coop/@coopcloud`](https://social.coop/@coopcloud). - [Servers.coop](https://servers.coop), for hosting our digital infrastructure (website, builds, git hosting, etc.). +- Every single last one of you heroic & patient alpha/beta testers, you are all comrades of the highest order of kropotkin :heart: diff --git a/docs/x-archive/apps.md b/docs/x-archive/apps.md deleted file mode 100644 index 61dd13a..0000000 --- a/docs/x-archive/apps.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -title: Application catalogue ---- - - - -An experimental version of this catalogue is available here: -https://dev.apps.coopcloud.tech - -## Applications - -| **Name** | **Status** | **Image** | **Healtcheck** | **Backups** | **Email** | **CI** | **Single-Sign-On** | -| --- | --- | --- | --- | --- | --- | --- | --- | -| [Adapt Authoring Tool](https://git.autonomic.zone/coop-cloud/adapt_authoring) | ❸🍎 | βΉπŸ’£ | βœ… | ❌ | ❌ | β·πŸ’› | ❌ | -| [alerta](https://git.autonomic.zone/coop-cloud/alerta) | | 0 | | | | | | -| [botamusique](https://git.autonomic.zone/coop-cloud/botamusique) | | | | | | | | -| [calendso](https://git.autonomic.zone/coop-cloud/calendso) | | 4 | ❌ | ❌ | βœ… | ❌ | β›” | -| [capsul](https://git.autonomic.zone/coop-cloud/capsul) | ❸🍎 | βΉπŸ’£ | βœ… | ❌ | βΆπŸ’š | β·πŸ’› | ❌ | -| [CiviCRM-Backdrop](https://git.autonomic.zone/coop-cloud/civicrm-backdrop) | βΉπŸ’£ | ? | ❌ | ❌ | ❌ | ❌ | ❌ | -| [collabora](https://git.autonomic.zone/coop-cloud/collabora) | βΆπŸ’š | βΆπŸ’š | ❌ | ❌ | βΆπŸ’š | β·πŸ’› | ❌ | -| [cryptpad](https://git.autonomic.zone/coop-cloud/cryptpad) | | | | | | | | -| [Custom HTML](https://git.autonomic.zone/coop-cloud/custom-html) | β·πŸ’› | βΆπŸ’š | ❌ | ❌ | β›” | β·πŸ’› | ❌ | -| [Discourse](https://git.autonomic.zone/coop-cloud/discourse) | | [`bitnami/discourse`](https://hub.docker.com/r/bitname/discourse) | yes | no | yes | no | no | -| [Drone](https://git.autonomic.zone/coop-cloud/drone) | 1, alpha | βΆπŸ’š | βœ… | ? | ? | β·πŸ’› | βΆπŸ’š (OAuth) | -| [Federated Wiki](https://git.autonomic.zone/coop-cloud/federatedwiki) | βΉπŸ’£ | βΆπŸ’š | ❌ | ❌ | ❌ | ❌ | ❌ | -| [Filerun](https://git.autonomic.zone/coop-cloud/filerun) | 0, work-in-progress | βΆπŸ’š | ❌ | ❌ | ❌ | ❌ | ❌ | -| [Filestash](https://git.autonomic.zone/coop-cloud/filestash) | βΉπŸ’£ | βΆπŸ’š | ❌ | ❌ | ❌ | ❌ | ❌ | -| [foodsoft](https://git.autonomic.zone/coop-cloud/foodsoft) | | 4 | | | | | | -| [ghost](https://git.autonomic.zone/coop-cloud/ghost) | | | | | | | | -| [Gitea](https://git.autonomic.zone/coop-cloud/gitea) | βΆπŸ’š | βΆπŸ’š | βœ… | βœ… | ? | β·πŸ’› | (OAuth) | -| [H5ai](https://git.autonomic.zone/coop-cloud/h5ai) | ❸🍎 | ❸🍎 | βœ… | ❌ | β›” | ❌ | ❌ | -| [Hedgedoc](https://git.autonomic.zone/coop-cloud/hedgedoc) | β·πŸ’› | βΆπŸ’š | βœ… | ❌ | ❌ | β·πŸ’› | βΆπŸ’š (OAuth) | -| [Hometown](https://git.autonomic.zone/coop-cloud/hometown) | | [`decentral1se/hometown`](https://hub.docker.com/r/decentral1se/hometown) | | | | | | -| [Invoiceninja](https://git.autonomic.zone/coop-cloud/invoiceninja) | βΉπŸ’£ | ❸🍎 | ❌ | ❌ | ? | ❌ | ? | -| [Jupyter Lab](https://git.autonomic.zone/coop-cloud/jupyter-lab) | 1 | `jupyter/datascience-notebook` | ❌ | ❌ | β›” | ❌ | ❌ | -| [keycloak](https://git.autonomic.zone/coop-cloud/keycloak) | β·πŸ’› | βΆπŸ’š | βœ… | ? | ❸🍎 | β·πŸ’› | β›” | -| [Keyoxide](https://git.autonomic.zone/coop-cloud/keyoxide) | β·πŸ’› | βΆπŸ’š | βœ… | ❌ | β›” | β·πŸ’› | β›” | -| [Kimai](https://git.autonomic.zone/coop-cloud/kimai) | ? | β·πŸ’› | ❌ | ❌ | ❌ | β·πŸ’› | ❌ | -| [Kutt](https://git.autonomic.zone/coop-cloud/kutt) | ❸🍎 | βΆπŸ’š | ❌ | ❌ | ❌ | ❌ | ❌ | -| [laplace](https://git.autonomic.zone/coop-cloud/laplace) | | βΆπŸ’š | ❌ | ❌ | ❌ | ❌ | ❌ | -| [levelfly](https://git.autonomic.zone/coop-cloud/levelfly) | | 4 | | | | | | -| [Loomio](https://git.autonomic.zone/coop-cloud/loomio) | βΉπŸ’£ | [`loomio/*`](https://hub.docker.com/r/loomio) | ❌ | ❌ | ? | ❌ | ❌ | -| [mailman3](https://git.autonomic.zone/coop-cloud/mailman3) | 1, alpha | [`maxking/mailman-*`](https://github.com/maxking/docker-mailman) | | | | | | -| [Mailu](https://git.autonomic.zone/coop-cloud/mailu) | ❸🍎 | βΆπŸ’š | ❌ | ❌ | β›” | ❌ | ❌ | -| [Mastodon](https://git.autonomic.zone/coop-cloud/mastodon) | | [`tootsuite/mastodon`](https://hub.docker.com/r/tootsuite/mastodon) | | | | | | -| [Matomo](https://git.autonomic.zone/coop-cloud/matomo) | ❸🍎 | βΆπŸ’š | βœ… | ❌ | ❌ | β·πŸ’› | ❌ | -| [Matrix (Synapse)](https://git.autonomic.zone/coop-cloud/matrix-synapse) | βΉπŸ’£ | βΆπŸ’š | βœ… | ❌ | ❌ | ❌ | ❌ | -| [Mediawiki](https://git.autonomic.zone/coop-cloud/mediawiki) | ❸🍎 | βΆπŸ’š | ❌ | βœ… | βΆπŸ’š | β·πŸ’› | β·πŸ’› (OAuth, SAML) | -| [monica](https://git.autonomic.zone/coop-cloud/monica) | | βΆπŸ’š | no | no | βΆπŸ’š | β·πŸ’› | no | -| [mumble](https://git.autonomic.zone/coop-cloud/mumble) | ❸🍎 | ❸🍎3rdparty | ❌ | ❌ | β›” | ❌ | β›” | -| [Nextcloud](https://git.autonomic.zone/coop-cloud/nextcloud) | β·πŸ’› | βΆπŸ’š | βœ… | ❌ | βΆπŸ’š | β·πŸ’› | ❸🍎 (OAuth) | -| [notea](https://git.autonomic.zone/coop-cloud/notea) | βΉπŸ’£ | [`notea`](https://hub.docker.com/r/cinwell/notea) | ❌ | ❌ | ❌ | ❌ | ❌ | -| [oasis](https://git.autonomic.zone/coop-cloud/oasis) | 0, work-in-progress | | | | | | | -| [onlyoffice](https://git.autonomic.zone/coop-cloud/onlyoffice) | βΆπŸ’š | βΆπŸ’š | ❌ | ❌ | βΆπŸ’š | β·πŸ’› | ❌ | -| [Osticket](https://git.autonomic.zone/coop-cloud/osticket) | 0, work-in-progress | [`osticket`](https://hub.docker.com/r/osticket/osticket) | | | | | | -| [Outline](https://git.autonomic.zone/coop-cloud/outline) | | [outlinewiki/outline](https://hub.docker.com/r/outlinewiki/outline) | | | | | | -| [Pelican](https://git.autonomic.zone/coop-cloud/pelican) | β·πŸ’› | βΉπŸ’£ | ❌ | ❌ | β›” | β·πŸ’› | ❌ | -| [Penpot](https://git.autonomic.zone/coop-cloud/penpot) | βΉπŸ’£ | [`penpotapp/*`](https://hub.docker.com/r/penpotapp) | | | | | | -| [PHP / LEMP](https://git.autonomic.zone/coop-cloud/lemp) | βΆπŸ’š | βΆπŸ’š | βœ… | βœ… | βΆπŸ’š | β·πŸ’› | ❌ | -| [PHPServerMon](https://git.autonomic.zone/coop-cloud/phpservermon) | 0, work-in-progress | ❸🍎 | | ❌ | ❌ | ❌ | ❌ | -| [plausible](https://git.autonomic.zone/coop-cloud/plausible) | 1, alpha | βΆπŸ’š | | | | | | -| [Projectsend](https://git.autonomic.zone/coop-cloud/projectsend) | 0, work-in-progress | ❸🍎 | βœ… | ❌ | ❌ | ❌ | ❌ | -| [Radicale](https://git.autonomic.zone/coop-cloud/radicale) | βΉπŸ’£ | ❸🍎 | βœ… | ❌ | ❌ | ❌ | ❌ | -| [Rocket.chat](https://git.autonomic.zone/coop-cloud/rocketchat) | β·πŸ’› | βΆπŸ’š | βœ… | ❌ | ❌ | β·πŸ’› | βΆπŸ’š (OAuth) | -| [Rstudio](https://git.autonomic.zone/coop-cloud/rstudio) | | [`rstudio`](https://hub.docker.com/r/rstudio/rstudio) | | | | | | -| [Selfoss](https://git.autonomic.zone/coop-cloud/selfoss) | ❸🍎 | ❸🍎 | βœ… | ❌ | ❌ | ❸🍎 | β›” | -| [singlelink](https://git.autonomic.zone/coop-cloud/singlelink) | 0, work-in-progress | | | | | | | -| [snikket](https://git.autonomic.zone/coop-cloud/snikket) | | [`thecoopcloud/snikket-*`](https://hub.docker.com/u/thecoopcloud) | | | | | | -| [Statping](https://git.autonomic.zone/coop-cloud/statping) | ❸🍎 | βΆπŸ’š | ❌ | ❌ | ❸🍎 | ❌ | ❌ | -| [Statuspal](https://git.autonomic.zone/coop-cloud/statuspal) | 0, work-in-progress | βΆπŸ’š | ❌ | ❌ | ❌ | ❌ | ❌ | -| [Strapi](https://git.autonomic.zone/coop-cloud/strapi) | ❸🍎 | βΆπŸ’š | ❌ | ❌ | ❌ | β·πŸ’› | ❌ | -| [vaultwarden](https://git.autonomic.zone/coop-cloud/vaultwarden) | | | | | | | | -| [Wallabag](https://git.autonomic.zone/coop-cloud/wallabag) | ❸🍎 | βΆπŸ’š | ❌ | ❌ | ❌ | β·πŸ’› | ❌ | -| [Wordpress](https://git.autonomic.zone/coop-cloud/wordpress) | βΆπŸ’š | βΆπŸ’š | βœ… | βœ… | βΆπŸ’š | β·πŸ’› | ❌ | -| [Workadventure](https://git.autonomic.zone/coop-cloud/workadventure) | βΉπŸ’£ | [`thecodingmachine/workadventure*`](https://hub.docker.com/r/thecodingmachine/) | ❌ | ❌ | ❌ | ❌ | ❌ | -| [ZNC](https://git.autonomic.zone/coop-cloud/znc) | βΉπŸ’£ | ❸🍎 | ❌ | ❌ | ❌ | ❌ | ❌ | - -## Utilities - -| **Name** | **Status** | **Image** | **Healtcheck** | **Backups** | **Email** | **CI** | **Single-Sign-On** | -| --- | --- | --- | --- | --- | --- | --- | --- | -| [AWX](https://git.autonomic.zone/coop-cloud/AWX) | 0, work-in-progress | | | | | | | -| [Backupbot II](https://git.autonomic.zone/coop-cloud/backup-bot-two) | 0, work-in-progress | 4 | ❌ | β›” | β›” | ❌ | β›” | -| [container](https://git.autonomic.zone/coop-cloud/container) | 1, alpha | any | ❌ | ❌ | ❌ | ❌ | ❌ | -| [croc](https://git.autonomic.zone/coop-cloud/croc) | βΆπŸ’š | βΆπŸ’š | ❌ | ❌ | ❌ | ❌ | ❌ | -| [distribution](https://git.autonomic.zone/coop-cloud/distribution) | 0, work-in-progress | βΆπŸ’š | ? | ? | ? | ? | ? | -| [Docker-Hub-RSS](https://git.autonomic.zone/coop-cloud/docker-hub-rss) | ? | βΆπŸ’š | ? | ? | ? | ? | ? | -| [drone-docker-runner](https://git.autonomic.zone/coop-cloud/drone-docker-runner) | 1, alpha | βΆπŸ’š | ? | ? | ? | ? | ? | -| [go-neb](https://git.autonomic.zone/coop-cloud/go-neb) | βΉπŸ’£ | βΆπŸ’š | | | | | | -| [go-ssb-room](https://git.autonomic.zone/coop-cloud/go-ssb-room) | βΉπŸ’£ | βΉπŸ’£ | ❌ | ❌ | β›” | ❌ | ❌ | -| [Jupyter Lab](https://git.autonomic.zone/coop-cloud/n8n) | 1 | `n8nio/n8n` | ❌ | ❌ | β›” | ❌ | ❌ | -| [keycloak-collective-portal](https://git.autonomic.zone/coop-cloud/keycloak-collective-portal) | 1, alpha | [`decentral1se/keycloak-collective-portal`](https://hub.docker.com/r/decentral1se/keycloak-collective-portal) | βœ… | ❌ | β›” | βœ… | β›” | -| [minio](https://git.autonomic.zone/coop-cloud/minio) | β·πŸ’› | βΆπŸ’š | βœ… | ❌ | ❌ | β·πŸ’› | ❌ | -| [portainer](https://git.autonomic.zone/coop-cloud/portainer) | ? | βΆπŸ’š | ❌ | ? | ? | β·πŸ’› | ❌ | -| [Postfix-Relay](https://git.autonomic.zone/coop-cloud/postfix-relay) | β·πŸ’› | βΆπŸ’š | βœ… | ❌ | β›” | β·πŸ’› | β›” | -| [renovate](https://git.autonomic.zone/coop-cloud/renovate) | | | | | | | | -| [swarm-cronjob](https://git.autonomic.zone/coop-cloud/swarm-cronjob) | ? | βΆπŸ’š | ? | ? | ? | ? | ? | -| [Swarmpit](https://git.autonomic.zone/coop-cloud/swarmpit) | β·πŸ’› | βΆπŸ’š | βœ… | ❌ | ❌ | β·πŸ’› | β›” | -| [traefik-forward-auth](https://git.autonomic.zone/coop-cloud/traefik-forward-auth) | ? | βΆπŸ’š | ? | ? | ? | ? | ? | -| [Traefik](https://git.autonomic.zone/coop-cloud/traefik) | ? | βΆπŸ’š | βœ… | ❌ | β›” | β·πŸ’› | ? (Keycloak) | - -## Status legend - -### Overall - -- 🌈🌈: everything in βΆπŸ’š + Single-Sign-On -- βΆπŸ’š: upstream image, backups, email, healthcheck, integration testing -- β·πŸ’›: upstream image, missing 1-2 items from βΆπŸ’š -- ❸🍎: missing 3-4 items from βΆπŸ’š or no upstream image -- βΉπŸ’£: alpha - -### Image - -- βΆπŸ’š: official upstream image -- β·πŸ’›: semi-official / actively-maintained image -- ❸🍎: 3rd-party image -- βΉπŸ’£: our own custom image - -### Email - -- βΆπŸ’š: automatic (using environment variables) -- β·πŸ’›: mostly automatic -- ❸🍎: manual -- ❌: none - -### CI - -- βΆπŸ’š: as β·πŸ’›, plus healthcheck -- β·πŸ’›: auto secrets + networks -- ❸🍎: basic deployment using `stack-ssh-deploy`, manual secrets + networks -- ❌: none - -### Single-Sign-On - -- βΆπŸ’š: automatic (using environment variables) -- β·πŸ’›: mostly automatic -- ❸🍎: manual -- ❌: none -- πŸ’£: not supported diff --git a/docs/x-archive/backup-restore.md b/docs/x-archive/backup-restore.md deleted file mode 100644 index 9acc4a5..0000000 --- a/docs/x-archive/backup-restore.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Back-up and restore an app ---- - -We'll use the example of a [`coop-cloud/wordpress`][wordpress] app deployed at -`blog.example.com`. - -## Backing up - -``` -abra app wordpress_blog_example_com backup --all -``` - -This will download backups of the Wordpress files (plugins, themes, and uploads) -and database (posts, settings and users) to the default backup directory, -`~/.abra/backups`. - -You can also back up just the files: - -``` -abra app wordpress_blog_example_com backup app -``` - -or just the database: - -``` -abra app wordpress_blog_example_com backup db -``` - -!!! warning - - Not all types of apps know how to do backups yet -- if you see a message - like `ERROR: 'nextcloud' doesn't know how to do app backups`, then extra - code is needed in that app's `abra.sh` -- you might be able to add this - yourself based on [`coop-cloud/wordpress` `abra.sh`][wordpress_abra.sh], - otherwise please open a new issue (in this case for - [`coop-cloud/nextcloud`][nextcloud]). - -## Restore - -You can restore data into a running application. This is useful to restore an -app to a previous state, to migrate an app from one Co-op Cloud server to -another, or to help move an app to Co-op Cloud initially. - -Using the same example app above, you can restore files: - -``` -abra app wordpress_blog_example_com restore app blog_example_com_app.tar.gz -``` - -and/or the database: - -``` -abra app wordpress_blog_example_com restore db blog_example_com_db.sql.gz -``` - -(there isn't yet a command to restore files and database data at the same time) - -[wordpress]: https://git.autonomic.zone/coop-cloud/wordpress -[wordpress_abra.sh]: https://git.autonomic.zone/coop-cloud/wordpress/src/branch/master/abra.sh -[nextcloud]: https://git.autonomic.zone/coop-cloud/nextcloud diff --git a/docs/x-archive/bikemap.md b/docs/x-archive/bikemap.md deleted file mode 100644 index 378a5ec..0000000 --- a/docs/x-archive/bikemap.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Bike map ---- - -- The project is currently in an [alpha quality](https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha) release state. -- We are working towards a [beta release](https://en.wikipedia.org/wiki/Software_release_life_cycle#Beta). -- We do not currently have an exact for the public Beta release yet. -- Our public Beta goals are listed in the following pad: [beta bike map](https://pad.autonomic.zone/s/C3uuqfSCk) -- What we're currently working on is listed on this issue tracker: [`coop-cloud/organising`](https://git.autonomic.zone/coop-cloud/organising/issues) diff --git a/docs/x-archive/index.md b/docs/x-archive/index.md deleted file mode 100644 index 417a30f..0000000 --- a/docs/x-archive/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Co-op Cloud ---- - -Welcome to the Co-op Cloud technical documentation. It's primarily meant for co-ops and other democratic tech collectives already doing libre software hosting who are interested in the project and thinking about doing some alpha testing. - -- New to the project and wondering where to start? Try our [getting started guide](/overview/). - -- Want to see what apps are already available? See the [app catalogue](https://dev.apps.coopcloud.tech). - -- Trying to understand more about the project? See the [the FAQ](/faq/). - -- Interested to learn more about the goals and background of the project? See the [strategy page](/strategy). - -!!! danger "Here be dragons" - - This project is still [alpha quality software](https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha). Please take that into consideration if you are thinking about using this system in production. We're working hard to make Co-op Cloud stable. In the meantime, this is a good time to help us out with initial testing, feedback, ideas or [join in with development](/contribute/). - -!!! note "Looking for managed Co-op Cloud hosting?" - - If you're looking for a co-operative or tech collective to host digital services for you using the Co-op Cloud, then please see [the managed hosting](/managed/) page for more. diff --git a/docs/x-archive/rollback.md b/docs/x-archive/rollback.md deleted file mode 100644 index f4529a8..0000000 --- a/docs/x-archive/rollback.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Roll an app back to a previous version ---- - -TODO. diff --git a/docs/x-archive/scale.md b/docs/x-archive/scale.md deleted file mode 100644 index f7621bc..0000000 --- a/docs/x-archive/scale.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Scale an app up to handle more traffic ---- - -TODO. diff --git a/mkdocs.yml b/mkdocs.yml index 9bbc4e7..a45f8d5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -41,8 +41,10 @@ nav: - index.md - "Frequently asked questions": intro/faq.md - "Project strategy": intro/strategy.md + - "Project status": intro/bikemap.md - "Managed hosting": intro/managed.md - "Get in touch": intro/contact.md + - "Credits": intro/credits.md - "Operators Guide": operators/index.md - "Recipes": recipes/index.md - "Get Involved": get-involved/index.md