toolshed/docs.coopcloud.tech
3
2
Fork 22
Code Issues 8 Pull Requests Packages Releases Activity

minor improvement suggestions for operator docs #292

Merged
decentral1se merged 4 commits from namnatulco/docs.coopcloud.tech:minor-changes into main 2025-12-16 17:20:57 +00:00
Conversation 1 Commits 4 Files Changed 2 +9 -5
2 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/operators/handbook.md
View File

@ -118,7 +118,7 @@ Then `$ABRA_DIR` will be automatically picked up as `$PWD`. This is useful when
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. 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`. 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` and specify the domain during deployment.
``` ```
abra server add --local abra server add --local

10
docs/operators/tutorial.md
View File

@ -36,7 +36,8 @@ Otherwise, here are the step required:
ssh <server-domain> ssh <server-domain>
# docker install convenience script # docker install convenience script
wget -O- https://get.docker.com | bash # not suitable for production environments - refer to the script header for alternatives
curl https://get.docker.com | bash
# check that docker was installed correctly # check that docker was installed correctly
sudo docker run hello-world sudo docker run hello-world
@ -84,6 +85,10 @@ Where `116.203.211.204` can be replaced with the IP address of your server.
You can use a tool like `dig` on the command-line to check if your server has the necessary DNS records set up. Something like `dig +short <domain>` should show the IP address of your server if things are working. You can use a tool like `dig` on the command-line to check if your server has the necessary DNS records set up. Something like `dig +short <domain>` should show the IP address of your server if things are working.
??? question "Can I use DynDNS with a home server?"
Yes. If your DNS provider does not allow you to set a *. A-Record, you may still be able to use a *. CNAME-Record to your example.com domain.
### Install `abra` ### 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)):
@ -183,8 +188,7 @@ 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?"
Yes, this is possible. See [this handbook Yes, this is possible. See [this handbook entry](/operators/handbook/#proxying-apps-outside-of-co-op-cloud-with-traefik)
entry](/operators/handbook/#proxying-apps-outside-of-co-op-cloud-with-traefik)
for more. Be warned, this is a relatively advanced topic. 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:**