Switch editing instructions from vim to nano and use kbd for keys

This commit is contained in:
Djeex
2026-08-30 18:49:10 +02:00
parent 2608bf64eb
commit bb1a482a8d
50 changed files with 210 additions and 210 deletions
@@ -198,10 +198,10 @@ sudo mkdir -p /docker/wireguard/config/wg_confs
Create the `wg0.conf` file:
```sh
sudo vi /docker/wireguard/config/wg_confs/wg0.conf
sudo nano /docker/wireguard/config/wg_confs/wg0.conf
```
Enter insert mode (`i`), paste the downloaded configuration, then save (`Esc``:x`).
Paste the downloaded configuration, then save with :kbd{value="Ctrl+O"}, :kbd{value="Enter"}, and exit with :kbd{value="Ctrl+X"}.
::tip
**Alternative method:** Transfer the file via SFTP and move it:
+20 -20
View File
@@ -69,7 +69,7 @@ sudo echo "AUTHENTIK_SECRET_KEY=$(openssl rand 60 | base64)" >> .env
To generate the keys, we created the folders ahead of deployment using Dockge. Dockge will prevent you from creating a stack with the same name in these folders unless a `compose.yml` file exists. So, create an empty `compose.yml` so it appears as an inactive stack:
```sh
sudo vi /docker/authentik/compose.yml
sudo nano /docker/authentik/compose.yml
```
::
@@ -218,7 +218,7 @@ You can use [File Browser](/serveex/files/file-browser) to navigate and edit fil
::
```sh
sudo vi /docker/swag/config/nginx/authentik-server.conf
sudo nano /docker/swag/config/nginx/authentik-server.conf
```
Verify that the following variables are set correctly:
@@ -228,15 +228,15 @@ set $upstream_authentik authentik-server;
proxy_pass http://$upstream_authentik:9000;
```
If not, press `i` to enter edit mode, make the necessary changes, then save and exit by pressing `Esc` followed by `:x`.
If not, make the necessary changes, then save with :kbd{value="Ctrl+O"}, :kbd{value="Enter"}, and exit with :kbd{value="Ctrl+X"}.
Create the `auth.subdomain.conf` file:
```sh
sudo vi /docker/swag/config/nginx/proxy-confs/auth.subdomain.conf
sudo nano /docker/swag/config/nginx/proxy-confs/auth.subdomain.conf
```
Press `i` to enter edit mode and paste the following configuration:
Paste the following configuration:
```nginx
## Version 2023/05/31
@@ -273,7 +273,7 @@ server {
}
```
Save and exit by pressing `Esc` then `:x`.
Save with :kbd{value="Ctrl+O"}, then :kbd{value="Enter"}, and exit with :kbd{value="Ctrl+X"}.
Go to Dockge, and edit the SWAG compose file to add the Authentik network:
@@ -349,12 +349,12 @@ Why do this when Dockge already has authentication? Because Dockge uses weak HTT
Edit the file `dockge.mydomain.com`:
```sh
sudo vi /docker/swag/config/nginx/proxy-confs/dockge.subdomain.conf
sudo nano /docker/swag/config/nginx/proxy-confs/dockge.subdomain.conf
```
Press `i` to enter edit mode and uncomment the two lines `#include /config/nginx/authentik-server.conf;`
Uncomment the two lines `#include /config/nginx/authentik-server.conf;`
Press `Esc`, type `:x`, and press `Enter` to save and exit.
Press :kbd{value="Ctrl+O"}, then :kbd{value="Enter"} to save, and :kbd{value="Ctrl+X"} to exit.
Done! Now when accessing `https://dockge.mydomain.com`, youll be redirected to the Authentik login screen.
@@ -417,7 +417,7 @@ docker_map_ports: true
docker_labels: null
```
Save and exit.
Save with :kbd{value="Ctrl+O"}, then :kbd{value="Enter"}, and exit with :kbd{value="Ctrl+X"}.
On the list of created outposts, locate the new one and click _Show details_ at the end of the line. Carefully copy the access token.
@@ -443,9 +443,9 @@ Create the `compose.yaml` file or paste the configuration directly into Dockge i
Via command line:
```sh
sudo vi /docker/authentik-outpost/compose.yaml
sudo nano /docker/authentik-outpost/compose.yaml
```
Enter edit mode by pressing `i` and paste the following configuration, updating the version in `{AUTHENTIK_TAG:proxy:2024.2.3}`{lang=properties} to match your Authentik server version.
Paste the following configuration, updating the version in `{AUTHENTIK_TAG:proxy:2024.2.3}`{lang=properties} to match your Authentik server version.
```yaml
version: "3.5"
@@ -472,7 +472,7 @@ services:
Go to the SWAG stack on the remote machine (or edit directly using Dockge) and add the authentik-outpost network in the configuration file like this (see `networks` section):
```sh
sudo vi /docker/swag/compose.yaml
sudo nano /docker/swag/compose.yaml
```
```yaml
@@ -491,7 +491,7 @@ networks: # Define the custom network
external: true # Marks it as an external network
```
Press `Esc`, then type `:x` and press `Enter` to save and exit.
Press :kbd{value="Ctrl+O"}, then :kbd{value="Enter"} to save, and :kbd{value="Ctrl+X"} to exit.
::note
@@ -512,10 +512,10 @@ Create (or fill using Dockge) the `.env` file in the `authentik-outpost` directo
Via command line:
```sh
sudo vi /docker/authentik-outpost/.env
sudo nano /docker/authentik-outpost/.env
```
Enter edit mode with `i` and paste the following configuration:
Paste the following configuration:
```properties
HOST=
@@ -529,7 +529,7 @@ Fill in the values:
| `HOST`{lang=properties} | The URL of your Authentik server | `https://auth.domain.com` |
| `TOKEN`{lang=properties} | The previously copied access token | `Q2pVEqsTNRkJSO9SkJzU3KZ2` |
Press `Esc`, then type `:x` and press `Enter` to save and exit.
Press :kbd{value="Ctrl+O"}, then :kbd{value="Enter"} to save, and :kbd{value="Ctrl+X"} to exit.
If using Dockge, deploy the stack.
@@ -547,17 +547,17 @@ Now, lets configure SWAG.
Open the `authentik-server.conf` file:
```sh
sudo vi /docker/swag/config/nginx/authentik-server.conf
sudo nano /docker/swag/config/nginx/authentik-server.conf
```
In the file, press `i` to enter edit mode and change `authentik-server` to `authentik-outpost` as shown:
In the file, change `authentik-server` to `authentik-outpost` as shown:
```nginx
set $upstream_authentik authentik-outpost;
proxy_pass http://$upstream_authentik:9000;
```
Save and exit with `Esc`, then `:x` and `Enter`.
Save with :kbd{value="Ctrl+O"}, then :kbd{value="Enter"}, and exit with :kbd{value="Ctrl+X"}.
Then configure the applications to protect as you did on your main server, whether they are [native](/serveex/security/authentik/#protecting-a-native-app) or protected via [reverse proxy](/serveex/security/authentik#protecting-an-app-via-reverse-proxy).
@@ -97,10 +97,10 @@ Create a file `tunnelconfig.yml` to reference in your SWAG `compose.yaml`.
::
```sh
sudo vi /docker/swag/config/tunnelconfig.yml
sudo nano /docker/swag/config/tunnelconfig.yml
```
Press `i` to enter insert mode and paste:
Paste:
```yaml
ingress:
@@ -114,7 +114,7 @@ ingress:
- service: http_status:404
```
Press `Esc`, then save and exit with `:x` and `Enter`.
Press :kbd{value="Ctrl+O"}, then :kbd{value="Enter"} to save, and :kbd{value="Ctrl+X"} to exit.
### Cloudflare Real IP Configuration
@@ -123,10 +123,10 @@ Now configure _Cloudflare Real IP_.
Open the `nginx.conf` file:
```sh
sudo vi /docker/swag/config/nginx/nginx.conf
sudo nano /docker/swag/config/nginx/nginx.conf
```
Press `i` and add the following at the end of the `http` section:
Add the following at the end of the `http` section:
```nginx
real_ip_header X-Forwarded-For;
@@ -135,7 +135,7 @@ include /config/nginx/cf_real-ip.conf;
set_real_ip_from 127.0.0.1;
```
Save and exit with `:x`.
Save with :kbd{value="Ctrl+O"}, then :kbd{value="Enter"}, and exit with :kbd{value="Ctrl+X"}.
### Docker Compose