From 38c6ec1c6b94acdc9d9518d19e40bfd3398b874b Mon Sep 17 00:00:00 2001 From: basebuilder Date: Tue, 2 Apr 2024 10:39:10 +0200 Subject: [PATCH] minor text and styling improvements to Operators Tutorial --- docs/operators/tutorial.md | 34 +++++++++++++++++++++++++++++----- 1 file changed, 29 insertions(+), 5 deletions(-) diff --git a/docs/operators/tutorial.md b/docs/operators/tutorial.md index dea0ce2..58bc46c 100644 --- a/docs/operators/tutorial.md +++ b/docs/operators/tutorial.md @@ -139,15 +139,21 @@ abra server ls In order to have your Co-op cloud deployment serve the public internet, we need to install the core web proxy, [Traefik](https://doc.traefik.io/traefik/). -Traefik is the main entrypoint for all web requests (e.g. like NGINX) and supports automatic SSL certificate configuration and other quality-of-life features which make deploying libre apps more enjoyable. +Traefik is the main entrypoint for all web requests (e.g. like NGINX) and +supports automatic SSL certificate configuration and other quality-of-life +features which make deploying libre apps more enjoyable. -To get started, you'll need to create a new app: +**1. To get started, you'll need to create a new app:** ```bash abra app new traefik ``` -Choose your newly registered server and specify a domain name. +Choose your newly registered server and specify a domain name. By default `abra` +will suggest `.server.org` or prompt you with a list of servers. + + +**2. Configure this new `traefix` app** You will want to take a look at your generated configuration and tweak the `LETS_ENCRYPT_EMAIL` value. You can do that by running `abra app config`: @@ -155,14 +161,32 @@ You will want to take a look at your generated configuration and tweak the `LETS abra app config ``` -Every app you deploy will have one of these `.env` files, which contains variables which will be injected into app configurations when deployed. Variables starting with `#` are optional, others are required. +Every app you deploy will have one of these `.env` files, which contains +variables which will be injected into app configurations when deployed. These +files exist at relevantly named path: -Now it is time to deploy: +```bash +~/.abra/servers//.env +``` + +Variables starting with `#` are optional, others are required. Some things to +consider here is that by default our *Traefik* recipe exposes the metric +dashboard unauthenticated on the public internet at the URL `` +it is deployed to, which is not ideal. You can disable this with: + +``` +DASHBOARD_ENABLED=false +``` + +**3. Now it is time to deploy your app:** ``` abra app deploy ``` +Voila. Abracadabra :magic_wand: your first app is deployed :sparkles: + + ### Deploy Nextcloud And now we can deploy apps. Let's create a new Nextcloud app.