3 Commits

Author SHA1 Message Date
f
aacdbac9ad fix: be specific about when commands are local or remote 2024-07-11 11:39:48 -03:00
f
58d5e91927 fix: you need to re-login after usermod 2024-07-11 11:39:33 -03:00
f
e4092a2eed fix: instruct people to restart their terminals
modifying shell rc files don't have immediate effect and it's confusing
if you don't know this.
2024-07-11 11:38:09 -03:00
3 changed files with 18 additions and 5 deletions

View File

@ -15,6 +15,8 @@ Definitely set up autocomplete or you'll be sad :sob: `abra` supports `bash`,
``` ```
$ abra autocomplete bash $ abra autocomplete bash
# Restart your terminal or load autocompletion in place
$ source /etc/bash_completion.d/abra
``` ```

View File

@ -41,7 +41,7 @@ For a simple example check the [entrypoint.sh for `croc`](https://git.coopcloud.
If you write your own entrypoint, it needs to be specified in the `config` section of compose.yml. See [this handbook entry](/maintainers/handbook/#how-do-i-set-a-custom-entrypoint) for more. If you write your own entrypoint, it needs to be specified in the `config` section of compose.yml. See [this handbook entry](/maintainers/handbook/#how-do-i-set-a-custom-entrypoint) for more.
### `release/` directory ### `releases/` directory
This directory contains text files whose names correspond to the recipe versions which have been released and contain useful tips for operators who are doing upgrade work. See [this handbook entry](/maintainers/handbook/#how-do-i-write-version-release-notes) for more. This directory contains text files whose names correspond to the recipe versions which have been released and contain useful tips for operators who are doing upgrade work. See [this handbook entry](/maintainers/handbook/#how-do-i-write-version-release-notes) for more.
@ -396,11 +396,11 @@ mkdir -p release
And then create a text file which corresponds to the version release, e.g. `1.1.0+5.9.0` and write some notes. `abra` will show these when another operator runs `abra app deploy` / `abra app upgrade`. And then create a text file which corresponds to the version release, e.g. `1.1.0+5.9.0` and write some notes. `abra` will show these when another operator runs `abra app deploy` / `abra app upgrade`.
You can also add release notes for the next release into a special file `release/next`. This file will be used when running `abra recipe release`. You can also add release notes for the next release into a special file `releases/next`. This file will be used when running `abra recipe release`.
!!! warning "Not available previous versions of Abra" !!! warning "Not available previous versions of Abra"
Using `release/next` is only available in > 0.9.x series of `abra`. Using `releases/next` is only available in > 0.9.x series of `abra`.
## How do I generate the recipe catalogue ## How do I generate the recipe catalogue

View File

@ -32,15 +32,25 @@ You need to keep port `:80` and `:443` free on your server for web proxying to y
Docker. Docker.
``` ```
# ssh into your server
ssh <server-domain>
# docker install convenience script # docker install convenience script
wget -O- https://get.docker.com | bash wget -O- https://get.docker.com | bash
# add user to docker group # add user to docker group
sudo usermod -aG docker $USER sudo usermod -aG docker $USER
# setup swarm # exit and re-login to load the group
exit
ssh <server-domain>
# back on the server, setup swarm
docker swarm init docker swarm init
docker network create -d overlay proxy docker network create -d overlay proxy
# now you can exit and start using abra
exit
``` ```
??? question "Do you support multiple web proxies?" ??? question "Do you support multiple web proxies?"
@ -82,7 +92,8 @@ 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
order to run the executable. order to run the executable. Also, run this line into your terminal so
you have immediate access to `abra` on the current terminal.
```bash ```bash
export PATH=$PATH:$HOME/.local/bin export PATH=$PATH:$HOME/.local/bin