Compare commits

...

21 Commits

Author SHA1 Message Date
sixsmith f9463a6986 Update docs/federation/membership.md
Change MIR voting member
2025-09-19 20:21:50 +00:00
decentral1se 907f9e38e7 docs: wording, link to handbook entry, formatting 2025-09-16 14:58:31 +02:00
cyrnel 7743446f2c Remove link to real website 2025-09-15 17:19:11 -04:00
cyrnel 6cdcf3a7f4 Move warning into warning box 2025-09-15 15:47:14 -04:00
cyrnel a56861701c Improve operators tutorial, mention cloud-init 2025-09-15 12:58:38 -04:00
decentral1se 69564fdadf docs: template announce 2025-09-10 23:15:09 +02:00
decentral1se 4fc19bb10d docs: few migration steps 2025-09-10 23:05:40 +02:00
decentral1se 1cc521acfe feat: mark new release 2025-09-10 22:51:15 +02:00
3wordchant 07ee33e92d Minor tweaks to "Abra on server" 2025-09-05 23:34:35 +00:00
3wordchant 4adcd6aa9f Update superquickstart guide 2025-09-05 16:27:41 -04:00
3wordchant 5dceb542a6 Loocal 2025-09-03 23:59:37 +00:00
3wordchant b58cd82d1f One More quickstart tweak 2025-09-03 23:50:01 +00:00
3wordchant ce3555e3d0 Tweak speedrun quickstart guide 2025-09-03 23:47:57 +00:00
3wordchant 2e46c22fe5 Attempt at copypastable ubuntu quickstart 2025-09-03 23:23:26 +00:00
decentral1se 1be011b07e refactor: it's an inventory 2025-09-03 00:15:38 +02:00
decentral1se 0621f89c09 docs: add more tools 2025-09-03 00:15:33 +02:00
decentral1se 3241b864a9 docs: shared infra 2025-09-03 00:08:35 +02:00
decentral1se 48489718b6 docs: templating
See toolshed/organising#521
2025-08-30 12:49:53 +02:00
decentral1se 09b90a7b8e docs: i18n merge conflict resolutions 2025-08-30 11:56:06 +02:00
decentral1se df617f4951 docs: remove ref to old repo
Closes toolshed/docs.coopcloud.tech#280
2025-08-30 10:22:44 +02:00
marlon 9db89e0ae5 update links that pointed to git.autonomic.zone to point to git.coopcloud.tech 2025-08-29 13:25:19 -04:00
15 changed files with 169 additions and 69 deletions
+48 -3
View File
@@ -12,8 +12,8 @@ In other words, we're happy to give you, as contributor, "the commit bit" (read/
We maintain a "team" called "Co-operators" on our 2 main repositories:
* [`git.coopcloud.tech/org/toolshed`](https://git.coopcloud.tech/org/toolshed/)
* [`git.coopcloud.tech/org/coop-cloud`](https://git.coopcloud.tech/org/coop-cloud/)
* [`git.coopcloud.tech/org/toolshed`](https://git.coopcloud.tech/toolshed/)
* [`git.coopcloud.tech/org/coop-cloud`](https://git.coopcloud.tech/coop-cloud/)
This gives you read/write access to all the repositories of the organisation.
@@ -38,6 +38,21 @@ Our [Drone CI configuration](https://git.coopcloud.tech/toolshed/abra/src/branch
Please use the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/) for your commits so we can automate our change log.
### Super quick-start (Ubuntu Server)
```bash
cd
sudo apt update && DEBIAN_FRONTEND=noninteractive sudo apt install -y golang make git
git clone https://git.coopcloud.tech/toolshed/abra.git && cd abra
make build
mkdir -p ~/.local/bin/
ln -sF $PWD/abra ~/.local/bin/abradev
if [[ "$PATH" != *".local/bin"* ]]; then export PATH="$PATH:~/.local/bin/"; echo 'export PATH=$PATH:~/.local/bin' >> ~/.bashrc; fi
# Set up Spanish auto-completion
LANG=es abra autocompletar bash | sed 's/abra/abradev/g' | sudo tee /etc/bash_completion.d/abra-dev
abradev --help
```
## Unit tests
### Run tests
@@ -220,7 +235,7 @@ bats -Tp tests/integration --filter-status failed # re-run only failed
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.
## Internationalisation
## Internationalisation (`i18n`)
`abra` can be translated into other languages. We use a combination of [`gettext`](https://www.gnu.org/software/gettext/), [`weblate`](https://translate.coopcloud.tech) and some [intermediate automation](https://git.coopcloud.tech/toolshed/abra/src/commit/20909695e0e05c6251029dba270b3d4741aeb7a8/.drone.yml#L10-L29) to help developers and translators work together conveniently.
@@ -249,6 +264,16 @@ make i18n
Commit the changes. Ignore `*.mo` changes if they only update the generation timestamp.
#### Resolving a merge conflict
```
git remote add weblate https://translate.coopcloud.tech/git/co-op-cloud/abra/
git remote update weblate
git merge weblate/main
```
Once you've resolved the conflict and pushed it, you'll need admin permissions on the Weblate repository to unlock it.
### Translator workflow
You can translate strings on [Weblate (`translate.coopcloud.tech`)](https://translate.coopcloud.tech).
@@ -345,6 +370,26 @@ For developers, while using this `-beta` format, the `y` part is the "major" ver
- Wait until the build finishes on [build.coopcloud.tech](https://build.coopcloud.tech/toolshed/abra)
- Deploy the new installer script (e.g. `cd ./scripts/installer && make`)
- Check the release worked, (e.g. `abra upgrade; abra -v`)
- Share the announcement:
```
📢📢📢 abra v0.XX is finally here 📢📢📢
TLDR; `abra upgrade` 👍
Upgrade docs:
https://docs.coopcloud.tech/abra/upgrade/
Changelog:
https://git.coopcloud.tech/toolshed/abra/releases/tag/0.XX.0-beta
0.XX.x-beta 👉 0.XX.x-beta migration guide:
https://docs.coopcloud.tech/abra/upgrade/#XXx-beta-0XXx-beta
A huge thanks to everyone who helped get this release done ❤️‍🔥
Happy Hacking 🫂
```
## Fork maintenance
+13 -3
View File
@@ -53,10 +53,20 @@ And test things work.
> General release notes are [here](https://git.coopcloud.tech/toolshed/abra/releases/)
### `0.10.x-beta` -> `WIP`
### `0.10.x-beta` -> `0.11.x-beta`
* We now ensure that `$ABRA_DIR/servers` has stricter permissions (`0600`).
See [`#592`](https://git.coopcloud.tech/toolshed/abra/pulls/592) for more.
* Timeouts are no longer used unless specifically set in the app `.env` file,
e.g `TIMEOUT=180`. Recipe maintainers should remove defaults so that these
are not imposed on operators. See
[`#596`](https://git.coopcloud.tech/toolshed/abra/issues/596).
* `--ignore-env-version` has gone away as a global flag. `--latest` is now
present on `abra app deploy`. See
[`#617`](https://git.coopcloud.tech/toolshed/abra/issues/617).
* We now ensure that `$ABRA_DIR/servers` has stricter permissions (`0600`). See
[`#592`](https://git.coopcloud.tech/toolshed/abra/pulls/592) for more. No
migration step should be required.
### `0.9.x-beta` -> `0.10.x-beta`
-4
View File
@@ -60,10 +60,6 @@ Finally, please let us know what your username/email is for your Open Collective
#### FAQ
##### Where are the bank details of federation members?
Please see [`Finance.md` in the internal Federation Wiki](https://git.coopcloud.tech/Federation/organising/wiki/Finance)
##### What transfer type do we use for USD?
`ACH`. If you see `Abartn`, that is the `ACH routing number`.
+6
View File
@@ -38,6 +38,12 @@ This is the public facing page where we publish all things federation in the ope
[Tools We Use](/federation/tools){ .md-button .md-button--primary }
- __Shared Infrastructure Inventory__
Tools we maintain for the federation 🛠
[Tools We Maintain](/federation/infra){ .md-button .md-button--primary }
- __Code of Co-operation__
Be excellent to each other 💝
+22
View File
@@ -0,0 +1,22 @@
---
title: Shared Infrastructure Inventory
---
## Shared repository for fedi maintainers
> [coop-cloud-apps](https://git.coopcloud.tech/toolshed/coop-cloud-apps)
## 2025 State of The Co-op Cloud Infra
| service | server | recipe/app | notes |
| --- | --- | --- | --- |
| build.coopcloud.tech | `swarm-0.coopcloud.tech` | drone | should probably be moved to separate VPS |
| (drone build runner) | `swarm-0.coopcloud.tech` | drone-docker-runner | should probably be moved to separate VPS |
| git.coopcloud.tech | `swarm-0.coopcloud.tech` | gitea | |
| recipes.coopcloud.tech | `swarm-0.coopcloud.tech` | [toolshed/recipes.coopcloud.tech](https://git.coopcloud.tech/coop-cloud/recipes.coopcloud.tech/)
| recipes.coopcloud.tech/recipes.json | `swarm-0.coopcloud.tech` | [toolshed/recipes-catalogue-json](https://git.coopcloud.tech/toolshed/recipes-catalogue-json) | |
| coopcloud.tech | `swarm-0.coopcloud.tech` | [toolshed/coopcloud.tech](https://git.coopcloud.tech/coop-cloud/coopcloud.tech/) | |
| docs.coopcloud.tech | `swarm-0.coopcloud.tech` | [toolshed/docs.coopcloud.tech](https://git.coopcloud.tech/toolshed/docs.coopcloud.tech/) | |
| install.abra.coopcloud.tech | `swarm-0.coopcloud.tech` | [toolshed/abra/scripts/installer](https://git.coopcloud.tech/toolshed/abra/src/branch/main/scripts/installer) | |
| sso.coopcloud.tech | `swarm-1.coopcloud.tech` | rauthy | |
| translate.coopcloud.tech | `swarm-1.coopcloud.tech` | weblate | |
+1 -1
View File
@@ -19,5 +19,5 @@ title: Membership
| `@decentral1se` | Waiver | - | `@decentral1se` |
| [ruangrupa](https://ruangrupa.id) | - | - | Henry `@babystepper:matrix.org` |
| [RTM](https://resisttechmonopolies.online) | ✅ | - | `@ammaratef45:matrix.org` + `@linnealovespie:matrix.org`|
| [MIR](https://mirnet.org/) | ✅ | - | `@brooke:pub.solar` |
| [MIR](https://mirnet.org/) | ✅ | - | `@sixsmith:matrix.org` |
| [Red Abya Yala](https://abyayala.sutty.nl/) | - | - | `@fauno:sutty.nl` |
-2
View File
@@ -100,8 +100,6 @@ Recap:
### decision-making process
proposal: https://git.coopcloud.tech/Federation/Federation/wiki/Proposals
- Trav: We adapted an old proposal for descision making process.
- https://pad.autonomic.zone/s/MLafJE2jC#Overview
- https://coopcloud.tech/blog/federation-proposal/
+2 -2
View File
@@ -13,13 +13,13 @@ Institute descision making process as per below. Special consensus voting in org
### Decision Making Process
* Write up a proposal using the below template, and add to the [Proposals wiki page](https://git.coopcloud.tech/Federation/Federation/wiki/Proposals).
* Write up a proposal using the below template, and add to the [Resolutions documentation "in-progress" section](https://docs.coopcloud.tech/federation/resolutions/).
* Specify if they are a large or medium proposal
* Votes are done via emoji-reaction in the Community Organising Matrix channel (<https://matrix.to/#/#coopcloud-comm-org:autonomic.zone>)
* List the decision on the [decisions page](https://docs.coopcloud.tech/federation/resolutions) on our documentation
* Decisions can be split intro three categories: Small, Medium and Large.
* Votes can be in favour :+1:, against :-1: (block), or abstain :shrug:
* Announce the result in the [Federation chat (#coop-cloud-fedi:autonomic.zone)](https://docs.coopcloud.tech/intro/contact/#matrix) and record it on the [decisions page](https://docs.coopcloud.tech/federation/resolutions) of the documentation
* Move it to the [Resolutions documentation "passed" section](https://docs.coopcloud.tech/federation/resolutions/).
### Types of Proposals
+2 -2
View File
@@ -1,5 +1,5 @@
---
title: "Resolution 005: Public federation membership.."
title: "Resolution 005: Public federation membership"
---
* Topic: Public federation membership, notes and decisions
@@ -18,4 +18,4 @@ The following federation info will be made public on [`docs.coopcloud.tech/feder
### Details
This will make the process of documenting easier to mutualise and increase transparency for those interested in joining. The [`git.coopcloud.tech/Federation`](https://git.coopcloud.tech/Federation/Federation/wiki/) wiki can still be used for storing private details such as bank account information. If members do not want to be listed, they can do so even when this decision passes.
This will make the process of documenting easier to mutualise and increase transparency for those interested in joining. The `git.coopcloud.tech/Federation` wiki (**NOTE(d1) from the future**: this repository is now decommissioned) can still be used for storing private details such as bank account information. If members do not want to be listed, they can do so even when this decision passes.
+3 -2
View File
@@ -3,9 +3,10 @@ title: Digital tools
---
- [Public documentation](https://docs.coopcloud.tech/federation)
- [Organising repository (private)](https://git.coopcloud.tech/Federation/organising)
- [Wiki (private)](https://git.coopcloud.tech/Federation/organising/wiki)
- [Git hosting](https://git.coopcloud.tech/)
- [Matrix Space](https://matrix.to/#/#coop-cloud-space:autonomic.zone)
- [Website](https://coopcloud.tech/)
- [Single Sign On](https://translate.coopcloud.tech/)
- [Translation](https://translate.coopcloud.tech/)
- [Sheets and time tracking](https://sheets.coopcloud.tech/)
- [Drone CI/CD](https://build.coopcloud.tech)
+14
View File
@@ -256,6 +256,20 @@ file_env "DB_PASSWORD"
Sometimes the containers don't even have Bash installed on them. You had better just use `/bin/sh` or, in your entrypoint script, install Bash :upside_down: The entrypoint secrets hack listed above doesn't work in this case (as it requires Bash), so instead you can just do `export FOO=$(cat /run/secrets/<secret-name>)`.
## Templating
### Templating domain names in the `.env.sample`
`<recipe>.example.com` will be transformed into the end-user app domain when `abra app new` is run.
### Templating domain names in release notes
!!! warning "Watch out for old versions of `abra` 🚧"
This feature is only available in the >= 0.11.x series of `abra`.
`<recipe>.example.com` will be transformed into the end-user app domain when `abra app upgrade` shows release notes.
## How do I reference services in configs?
When referencing an `app` service in a config file, you should prefix with the `STACK_NAME` to avoid namespace conflicts (because all these containers sit on the traefik overlay network). You might want to do something like this `{{ env "STACK_NAME" }}_app` (using the often obscure dark magic of the Golang templating language). You can find examples of this approach used in the [Peertube recipe](https://git.coopcloud.tech/coop-cloud/peertube/src/commit/d1b297c5a6a23a06bf97bb954104ddfd7f736568/nginx.conf.tmpl#L9).
+2 -2
View File
@@ -50,7 +50,7 @@ Open the `compose.yml` in your favourite editor and have a gander &#129442;. The
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.
The resulting `compose.yml` is available [here](https://git.autonomic.zone/coop-cloud/matomo/src/branch/main/compose.yml).
The resulting `compose.yml` is available [here](https://git.coopcloud.tech/coop-cloud/matomo/src/branch/main/compose.yml).
### Updating the `.env.sample`
@@ -87,7 +87,7 @@ Otherwise, or once you've done that, go ahead and deploy the app:
abra app deploy swarm.example.com
```
Then, open the `DOMAIN` you configured (you might need to wait a while for Traefik to generate SSL certificates) to finish the set-up. Luckily, this container is (mostly) configurable via environment variables, if we want to auto-generate the configuration we can use a `config` and / or a custom `entrypoint` (see [`coop-cloud/mediawiki`](https://git.autonomic.zone/coop-cloud/mediawiki) for examples of both).
Then, open the `DOMAIN` you configured (you might need to wait a while for Traefik to generate SSL certificates) to finish the set-up. Luckily, this container is (mostly) configurable via environment variables, if we want to auto-generate the configuration we can use a `config` and / or a custom `entrypoint` (see [`coop-cloud/mediawiki`](https://git.coopcloud.tech/coop-cloud/mediawiki) for examples of both).
### Finishing up
+2 -2
View File
@@ -116,7 +116,7 @@ Then `$ABRA_DIR` will be automatically picked up as `$PWD`. This is useful when
## Running abra server side
If you're on an environment where it's hard to run Docker, or command-line programs in general, you might want to install `abra` on a server instead of your local work station.
If you're on an environment where it's hard to run Docker, or command-line programs in general, you might want to install `abra` on a server instead of your local computer.
To install `abra` on the same server where you'll be hosting your apps, just follow [getting started guide](/operators/tutorial#deploy-your-first-app) as normal except for one difference. Instead of providing your SSH connection details when you run `abra server add ...`, just pass `--local`.
@@ -126,7 +126,7 @@ abra server add --local
!!! note "Technical details"
This will tell `abra` to look at the Docker system running on the server, instead of a remote one (using the Docker internal `default` context). Once this is wired up, `abra` knows that the deployment target is the local server and not a remote one. This will be handle seamlessly for all other deployments on this server.
This will tell `abra` to look at the Docker system running on the server itself, instead of a remote one (using the Docker internal `default` context). Once this is wired up, `abra` knows that the deployment target is the local server and not a remote one. This will be handled seamlessly for all other deployments on this server.
Make sure to back up your `~/.abra` directory on the server, or put it in version control, as well as other files you'd like to keep safe.
+53 -46
View File
@@ -13,24 +13,23 @@ In order to deploy an app you need two things:
This tutorial tries to help you make choices about which server and which DNS setup you need to run a _Co-op Cloud_ deployment but it does not go into great depth about how to set up a new server.
### Server setup
We will deploy a new Nextcloud instance in this guide, so you will only need 1GB of RAM according to [their documentation](https://docs.nextcloud.com/server/latest/admin_manual/installation/system_requirements.html).
Co-op Cloud has itself near zero system requirements. You only need to worry about the system resource usage of your apps and the overhead of running containers with the docker runtime (often negligible. If you want to know more, see [this FAQ entry](/intro/faq/#isnt-running-everything-in-containers-inefficient)).
### Server provisioning
We will deploy a new Nextcloud instance in this guide, so you will only need 1GB of RAM according to [their documentation](https://docs.nextcloud.com/server/latest/admin_manual/installation/system_requirements.html). You may also be interested in this [FAQ entry](/intro/faq/#arent-containers-horrible-from-a-security-perspective) if you are curious about security in the context of containers.
Co-op Cloud is designed to run on a variety of hardware, so you can use those single-board computers, old laptops/desktops, or refurbished servers. However, hardware setup is a skill that's beyond the scope of this guide. As long as it's running Linux and has networking, it should be fine! Most Co-op Cloud deployments have been run on Debian machines so far.
Most Co-op Cloud deployments have been run on Debian machines so far. Some experiments have been done on single board computers & servers with low resource capacities.
If you don't have the time or equipment to run your own hardware, rented hardware is fine too! There are many hosting providers which will provide a Linux server to you for a monthly fee.
You need to keep port `:80` and `:443` free on your server for web proxying to your apps. Typically, you don't need to keep any other ports free as the core web proxy ([Traefik](https://traefik.io)) keeps all app ports internal to its network. Sometimes however, you need to expose an app port when you need to use a transport which would perform better or more reliably without proxying.
### Server configuration
`abra` has support for creating servers (`abra server new`) but that is a more advanced automation feature which is covered in the [handbook](/operators/handbook). For this tutorial, we'll focus on the basics. Assuming you've managed to create a testing VPS with some `$hosting_provider`, you'll need to install Docker, add your user to the Docker group & setup swarm mode:
Assuming you've got a running server, it's now time to configure it.
!!! warning "You may need to log in/out"
Co-op Cloud has very few system requirements. You only need to worry about the system resource usage of your apps and the overhead of running containers with the docker runtime (often negligible. If you want to know more, see [this FAQ entry](/intro/faq/#isnt-running-everything-in-containers-inefficient)).
When running `usermod ...`, you may need to (depending on your system) log
in and out again of your shell session to get the required permissions for
Docker.
Alternatively you can run [`newgrp`](https://www.man7.org/linux/man-pages/man1/newgrp.1.html) to register the group chnage.
To get started, you'll need to install Docker, add your user to the Docker group & setup swarm mode. Many hosting providers support [cloud-init](https://cloudinit.readthedocs.io/en/latest/index.html), which allows you to automate the steps in this section. If that applies to you, you can use [our cloud-init file](https://git.coopcloud.tech/toolshed/abra/raw/branch/main/scripts/cloud-init/cloud-init.yaml).
Otherwise, here are the step required:
```
# ssh into your server
@@ -39,34 +38,32 @@ ssh <server-domain>
# docker install convenience script
wget -O- https://get.docker.com | bash
# check that docker was installed correctly
sudo docker run hello-world
# now setup swarm
sudo docker swarm init
sudo docker network create -d overlay proxy
```
#### Using docker without sudo
Abra can't deploy any applications in future steps unless it can run `docker` commands without sudo.
```
# check if the docker group exists
groups | grep docker
# if the docker group doesn't already exist, add it manually
sudo groupadd docker
groupadd docker
# add user to docker group
sudo usermod -aG docker $USER
# check that docker installed correctly
docker run hello-world
# exit and re-login to load the group
exit
ssh <server-domain>
# back on the server, setup swarm
docker swarm init
docker network create -d overlay proxy
# now you can exit and start using abra
exit
```
Abra can't deploy any applications in future steps if the docker group cannot run without sudo. If you install docker a different way, it may not create a docker group automatically. The [official Docker documentation](https://docs.docker.com/engine/install/linux-postinstall/) can help if you run into further issues.
??? question "Do you support multiple web proxies?"
After running `usermod`, you may need to (depending on your system) log out (`exit`) and back in again (`ssh <server-domain>`) to get the required permissions for Docker before proceeding.
We do not know if it is feasible and convenient to set things up on an existing server with another web proxy which uses ports `:80` & `:443`. We'd happily receive reports and documentation on how to do this if you manage to set it up!
The [official Docker documentation](https://docs.docker.com/engine/install/linux-postinstall/) can help if you run into further issues.
### DNS setup
@@ -79,7 +76,9 @@ Your entries in your DNS provider setup might look like the following.
Where `116.203.211.204` can be replaced with the IP address of your server.
Warning: If the you are in the same local netwrok as the server, you might run into [NAT Hairpin](https://superuser.com/questions/663820/port-forwarding-from-inner-network-to-inner-network-hairpin-nat) issues.
!!! warning Beware local network pitfalls!
If you are in the same local network as the server, you might run into [NAT Hairpin](https://superuser.com/questions/663820/port-forwarding-from-inner-network-to-inner-network-hairpin-nat) issues.
??? question "How do I know my DNS is working?"
@@ -87,8 +86,7 @@ Warning: If the you are in the same local netwrok as the server, you might run i
### Install `abra`
Now we can install [`abra`](/abra) locally on your machine and hook it up to
your server. We support a script-based installation method ([script source](https://git.coopcloud.tech/toolshed/abra/src/branch/main/scripts/installer/installer)):
Now we can install [`abra`](/abra) locally on your machine and hook it up to your server. We support a script-based installation method ([script source](https://git.coopcloud.tech/toolshed/abra/src/branch/main/scripts/installer/installer)):
```bash
curl https://install.abra.coopcloud.tech | bash
@@ -112,7 +110,7 @@ you have immediate access to `abra` on the current terminal.
export PATH=$PATH:$HOME/.local/bin
```
If you run into issues during installation, [please report a ticket](https://git.coopcloud.tech/toolshed/organising/issues/new) :pray:
If you run into issues during installation, [please report a ticket](https://git.coopcloud.tech/toolshed/abra/issues/new) :pray:
??? question "Can I install `abra` on my server?"
@@ -126,7 +124,7 @@ With autocomplete enabled, you can run a command like `abra app deploy myapp.exa
### Add your server
Now you can connect `abra` with your server. You must have a working SSH configuration for your server before you can proceed. That means you can run `ssh <server-domain>` on your command-line and everything Works :tm:. See the [`abra` SSH troubleshooting](/abra/trouble/#ssh-connection-issues) for a working SSH configuration example.
Now you can connect `abra` with your server. You must have a working SSH configuration for your server before you can proceed. That means you can run `ssh <server-domain>` on your command-line and everything Works :tm:. See the [`abra` SSH troubleshooting](/abra/trouble/#ssh-connection-issues) for a working SSH configuration example or use `abra server add -h` for the help output.
??? warning "Beware of SSH dragons :dragon_face:"
@@ -140,21 +138,21 @@ Now you can connect `abra` with your server. You must have a working SSH configu
troubleshooting entry](/abra/trouble/#ssh-connection-issues).
```bash
ssh <server-domain> # make sure it works
ssh <server-domain> hostname -I # make sure it works
abra server add <server-domain>
```
It is important to note that `<server-domain>` here is a publicy accessible domain name which points to your server IP address. `abra` does make sure this is the case and this is done to avoid issues with HTTPS certificate rate limiting.
It is important to note that `<server-domain>` here is a publicly accessible domain name which points to your server IP address. `abra` does make sure this is the case and this is done to avoid issues with HTTPS certificate rate limiting.
??? warning "Can I use arbitrary server names?"
Yes, this is possible. You need to pass `-D` to `server add` and ensure
that your `Host ...` entry in your SSH configuration includes the name.
So, for example, in `~/.ssh/config`:
Yes, this is possible. You need to ensure that your `Host ...` entry in your SSH configuration includes the name. So, for example, in `~/.ssh/config`:
```
Host example.com example
...
```
And then:
abra server add example
@@ -169,8 +167,9 @@ abra server ls
??? question "How do I share my configs in `~/.abra`?"
It's possible and quite easy, for more see [this handbook
It's possible and relatively easy, for more see [this handbook
entry](/operators/handbook/#understanding-app-and-server-configuration).
[Git](https://git-scm.com) skills are generally required.
### Web proxy setup
@@ -180,6 +179,14 @@ Traefik is the main entrypoint for all web requests (e.g. like NGINX) and
supports automatic SSL certificate configuration and other quality-of-life
features which make deploying libre apps more enjoyable.
You need to keep port `:80` and `:443` free on your server for web proxying to your apps. Typically, you don't need to keep any other ports free as the core web proxy keeps all app ports internal to its network. Sometimes however, you need to expose an app port when you need to use a transport which would perform better or more reliably without proxying.
??? question "Do you support multiple web proxies?"
Yes, this is possible. See [this handbook
entry](/operators/handbook/#proxying-apps-outside-of-co-op-cloud-with-traefik)
for more. Be warned, this is a relatively advanced topic.
**1. To get started, you'll need to create a new app:**
```bash
@@ -187,8 +194,10 @@ abra app new traefik
```
Choose your newly registered server and specify a domain name. By default `abra`
will suggest `<app-name>.server.org` or prompt you with a list of servers.
will suggest `<app-name>.<your-server>` or prompt you with a list of servers.
??? question "Should I use www for traefik?"
Generally no. No one will be directly accessing the traefik domain name unless they want to see the traefik dashboard. You should reserve the `www` or apex domains for apps like [custom-html](https://recipes.coopcloud.tech/custom-html-tiny) which let you host sites. Traefik is just a proxy to other apps!
**2. Configure this new `traefix` app**
@@ -217,8 +226,6 @@ DASHBOARD_ENABLED=false
**3. Now it is time to deploy your app:**
Ensure `<traefic-domain>` is registered in `/etc/hosts` then run:
```
abra app deploy <traefik-domain>
```
@@ -231,7 +238,7 @@ Voila. Abracadabra :magic_wand: your first app is deployed :sparkles:
And now we can deploy apps. Let's create a new Nextcloud app.
```bash
abra app new nextcloud -S
abra app new nextcloud --secrets
```
The `-S` or `--secrets` flag is used to generate secrets for the app: database connection password, root password and admin password.
@@ -240,7 +247,7 @@ The `-S` or `--secrets` flag is used to generate secrets for the app: database c
Take care, these secrets are only shown once on the terminal so make sure to take note of them! `abra` makes use of the [Docker secrets](/operators/handbook/#managing-secret-data) mechanism to ship these secrets securely to the server and store them as encrypted data. Only the apps themselves have access to the values from here on, they're placed in `/run/secrets` on the container file system.
Make sure` <nextcloud-domain>` is registered in `/etc/hosts`, then we can deploy Nextcloud:
Now we can deploy Nextcloud:
```bash
abra app deploy <nextcloud-domain>
@@ -254,7 +261,7 @@ abra app logs <nextcloud-domain> # logs trailing
abra app errors -w <nextcloud-domain> # error catcher
```
Your new `traefik` instance will detect that a new app is coming up and generate SSL certificates for it. You can see what `traefik` is up to using the same commands above but replacing `<netcloud-domain>` with the `<traefik-domain>` you chose earlier (`abra app ls` will remind you what domains you chose :grinning:).
Your new `traefik` instance will detect that a new app is coming up and generate TLS certificates for it. You can see what `traefik` is up to using the same commands above but replacing `<nextcloud-domain>` with the `<traefik-domain>` you chose earlier (`abra app ls` will remind you what domains you chose :grinning:).
### Upgrade Nextcloud
+1
View File
@@ -88,6 +88,7 @@ nav:
- "Finance": federation/finance.md
- "Membership": federation/membership.md
- "Code of Co-operation": federation/code-of-coop.md
- "Shared Infrastructure Inventory": federation/infra.md
- "Proposals":
- federation/proposals/index.md
- federation/proposals/federation.md