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

Add section for autocomplete in new operators tutorial
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Mac Chaffee 2025-05-26 10:28:19 -04:00
parent 88ed1fab36
commit a492386ce3
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/operators/tutorial.md
View File

@ -62,7 +62,7 @@ docker network create -d overlay proxy
# now you can exit and start using abra # now you can exit and start using abra
exit 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. 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?" ??? question "Do you support multiple web proxies?"
@ -101,7 +101,7 @@ that everything is working try listing the `--help` command or `-h` to view
output: output:
```bash ```bash
abra -h abra -h
``` ```
You may need to add the `~/.local/bin/` directory to your `$PATH` variable, in You may need to add the `~/.local/bin/` directory to your `$PATH` variable, in
@ -112,12 +112,18 @@ 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: Once you're all set up, we **highly** recommend configuring command-line auto-completion for `abra`. See `abra autocomplete -h` for more on how to do this. If you run into issues during installation, [please report a ticket](https://git.coopcloud.tech/toolshed/organising/issues/new) :pray:
??? question "Can I install `abra` on my server?" ??? question "Can I install `abra` on my server?"
Yes, this is possible. However, the instructions for this setup are different. For more info see [this handbook entry](/operators/handbook/#running-abra-server-side). Yes, this is possible. However, the instructions for this setup are different. For more info see [this handbook entry](/operators/handbook/#running-abra-server-side).
### Set up autocomplete
Most `abra` commands require typing the fully qualified domain name for your app, so we **highly** recommend configuring command-line auto-completion. See `abra autocomplete -h` for more on how to do this. The instructions vary depending on which shell you use.
With autocomplete enabled, you can run a command like `abra app deploy myapp.example.com` by just typing `abra app deploy myapp<tab>`.
### 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.
@ -172,7 +178,7 @@ In order to have your Co-op cloud deployment serve the public internet, we need
Traefik is the main entrypoint for all web requests (e.g. like NGINX) and Traefik is the main entrypoint for all web requests (e.g. like NGINX) and
supports automatic SSL certificate configuration and other quality-of-life supports automatic SSL certificate configuration and other quality-of-life
features which make deploying libre apps more enjoyable. features which make deploying libre apps more enjoyable.
**1. To get started, you'll need to create a new app:** **1. To get started, you'll need to create a new app:**
@ -211,7 +217,7 @@ DASHBOARD_ENABLED=false
**3. Now it is time to deploy your app:** **3. Now it is time to deploy your app:**
Ensure `<traefic-domain>` is registered in `/etc/hosts` then run: Ensure `<traefic-domain>` is registered in `/etc/hosts` then run:
``` ```
abra app deploy <traefik-domain> abra app deploy <traefik-domain>