toolshed/docs.coopcloud.tech
3
1
Fork 21
Code Issues 5 Pull Requests 1 Packages Releases Activity

docs: wording, link to handbook entry, formatting
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
decentral1se
2025-09-16 14:57:57 +02:00
parent 7743446f2c
commit 907f9e38e7
1 changed files with 12 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/operators/tutorial.md
View File

@ -60,6 +60,7 @@ groupadd docker
# add user to docker group # add user to docker group
sudo usermod -aG docker $USER sudo usermod -aG docker $USER
``` ```
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. 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.
The [official Docker documentation](https://docs.docker.com/engine/install/linux-postinstall/) can help if you run into further issues. The [official Docker documentation](https://docs.docker.com/engine/install/linux-postinstall/) can help if you run into further issues.
@ -85,8 +86,7 @@ Where `116.203.211.204` can be replaced with the IP address of your server.
### Install `abra` ### Install `abra`
Now we can install [`abra`](/abra) locally on your machine and hook it up to 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)):
your server. We support a script-based installation method ([script source](https://git.coopcloud.tech/toolshed/abra/src/branch/main/scripts/installer/installer)):
```bash ```bash
curl https://install.abra.coopcloud.tech | bash curl https://install.abra.coopcloud.tech | bash
@ -110,7 +110,7 @@ you have immediate access to `abra` on the current terminal.
export PATH=$PATH:$HOME/.local/bin 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?" ??? question "Can I install `abra` on my server?"
@ -124,7 +124,7 @@ With autocomplete enabled, you can run a command like `abra app deploy myapp.exa
### Add your server ### 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:" ??? warning "Beware of SSH dragons :dragon_face:"
@ -146,13 +146,13 @@ It is important to note that `<server-domain>` here is a publicly accessible dom
??? warning "Can I use arbitrary server names?" ??? warning "Can I use arbitrary server names?"
Yes, this is possible. You need to pass `-D` to `server add` and ensure 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`:
that your `Host ...` entry in your SSH configuration includes the name.
So, for example, in `~/.ssh/config`:
``` ```
Host example.com example Host example.com example
... ...
``` ```
And then: And then:
abra server add example abra server add example
@ -167,8 +167,9 @@ abra server ls
??? question "How do I share my configs in `~/.abra`?" ??? 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). entry](/operators/handbook/#understanding-app-and-server-configuration).
[Git](https://git-scm.com) skills are generally required.
### Web proxy setup ### Web proxy setup
@ -182,7 +183,9 @@ You need to keep port `:80` and `:443` free on your server for web proxying to y
??? question "Do you support multiple web proxies?" ??? question "Do you support multiple web proxies?"
We do not know if it is feasible and convenient to set things up on an existing server with another web proxy which uses ports `:80` & `:443`. We'd happily receive reports and documentation on how to do this if you manage to set it up! 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:** **1. To get started, you'll need to create a new app:**