diff --git a/docs/abra/install.md b/docs/abra/install.md index 52741bd..cff525e 100644 --- a/docs/abra/install.md +++ b/docs/abra/install.md @@ -18,6 +18,24 @@ curl https://install.abra.coopcloud.tech | bash curl https://install.abra.coopcloud.tech | bash -s -- --rc ``` +## Manual verification + +You can download the `abra` binary yourself from the [releases +page](https://git.coopcloud.tech/coop-cloud/abra/releases) along with the +`checksums.txt` file and verify it's integrity with the following command. + +```bash +sha256sum -c checksums.txt --ignore-missing +``` + +If you see a line starting with `abra_...` which matches the filename you downloaded and it ends with `OK` - you're good to go! + +``` +abra_X.X.X-beta_linux_x86_64: OK +``` + +Otherwise, you downloaded a corrupted file and you should re-download it. + ## Compile from source Follow the guide [here](https://docs.coopcloud.tech/abra/hack/) diff --git a/docs/operators/handbook.md b/docs/operators/handbook.md index 50e6c37..a0dedf1 100644 --- a/docs/operators/handbook.md +++ b/docs/operators/handbook.md @@ -205,18 +205,6 @@ At time of writing (Jan 2022), we think there is a limitation in our design whic This may be possible to overcome if someone really needs it, we encourage people to investigate. We've found that often there are limitations in the actual software which don't support this anyway and several of the current operators simply use a new domain per app. -## Validating `abra` binary checksums - - You can download `abra` yourself from the [releases page](https://git.coopcloud.tech/coop-cloud/abra/releases) along with the `checksums.txt` file. - -```bash -grep $(sha256sum abra_[version]_[platform]) checksums.txt > /dev/null && echo "checksum OK" -``` - -If "checksum OK" appears in your terminal - you're good to go! - -Otherwise, you have downloaded a corrupted file. - ## Creating a new server `abra server new` can create servers if you have an account with a supported 3rd party integration. We currently support [Servers.coop](https://servers.coop) & [Hetzner](https://hetzner.com). The process of creating a new server usually goes like this: diff --git a/docs/operators/tutorial.md b/docs/operators/tutorial.md index c5b2eeb..09e7c81 100644 --- a/docs/operators/tutorial.md +++ b/docs/operators/tutorial.md @@ -63,23 +63,30 @@ 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 ` should show the IP address of your server if things are working. -### Command-line setup +### 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 [here](https://git.coopcloud.tech/coop-cloud/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/coop-cloud/abra/src/branch/main/scripts/installer/installer)): ```bash curl https://install.abra.coopcloud.tech | bash ``` -The installer will verify the downloaded binary checksum. You may need to add the `~/.local/bin/` directory with your `$PATH` in order to run the executable. You can validate that everything is in working order by listing the default help output: +The installer will verify the downloaded binary checksum. If you prefer, you can +[manually verify](/abra/install/#manual-verification) the binary, and then +manally place it in one the directories in your `$PATH` variable. To validate +that everything is working try listing the `--help` command or `-h` to view +output: + +```bash +abra -h +``` + +You may need to add the `~/.local/bin/` directory to your `$PATH` variable, in +order to run the executable. ```bash export PATH=$PATH:$HOME/.local/bin -abra -h # check it works ``` If you run into issues during installation, [please report a ticket](https://git.coopcloud.tech/coop-cloud/abra/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. @@ -88,7 +95,7 @@ If you run into issues during installation, [please report a ticket](https://git 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). -#### Add your server +### Add your server Now you can connect `abra` with your server. You should have a working SSH configuration before you can do this (e.g. a matching `Host ` entry in `~/.ssh/config` with the correct SSH connection details). That means you can run `ssh ` on your command-line and everything Works :tm:.