Skip to content

Commit 11d7c6b

Browse files
authored
chore: update readme
1 parent 8e4b8c9 commit 11d7c6b

File tree

1 file changed

+25
-7
lines changed

1 file changed

+25
-7
lines changed

examples/firezone/README.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,40 @@
55

66
# Notes
77

8-
1. Download the `docker-compose.yml` file from this repository.
9-
2. Create a firezone `.env` file via the command `docker run --rm l4rm4nd/firezone bin/gen-env > .env`
10-
3. Adjust `docker-compose.yml` and created `.env` to your needs. Especially change the environment variables `DEFAULT_ADMIN_EMAIL`, `DEFAULT_ADMIN_PASSWORD` and `EXTERNAL_URL` to secure values!
11-
4. Proceed by executing the below commands.
12-
138
````
9+
# download compose file
10+
wget https://raw.githubusercontent.com/Haxxnet/Compose-Examples/main/examples/firezone/docker-compose.yml
11+
12+
# generate an .env file
13+
docker run --rm ghcr.io/l4rm4nd/firezone:latest bin/gen-env > .env
14+
15+
# adjust .env file to your needs
16+
# define EXTERNAL_URL + DEFAULT_ADMIN_EMAIL + DEFAULT_ADMIN_PASSWORD
17+
18+
# disable telemetry via .env
19+
echo -e "\nTELEMETRY_ENABLED=false" >> .env
20+
21+
# enable local auth
22+
echo -e "\nLOCAL_AUTH_ENABLED=true" >> .env
23+
24+
# migrate database and create admin user
1425
docker compose run --rm firezone bin/migrate
1526
docker compose run --rm firezone bin/create-or-reset-admin
27+
28+
# spawn the container stack
1629
docker compose up -d
1730
````
1831

19-
Note: It is recommended to run the Firezone web panel behind a reverse proxy (e.g. Traefik) if you want to expose it. Alternatively, keep it running on http://127.0.0.1:13000.
32+
Afterwards, the admin mgmt UI is accessible on http://127.0.0.1:13000.
33+
34+
It is recommended to combine Firezone with a TLS reverse proxy such as Traefik as well as with an Identity Provider (IdP) such as Keycloak or Authentik for Single-Sign-On (SSO). Once SSO is enabled, you should disable the possibility for local authentication via the .env file.
2035

2136
> [!WARNING]
2237
> Firezone v0.7 has reached End-of-Life on 31st January 2024.
2338
>
2439
> It undergoes a complete redesign (zero-knowledge, cloud) for v1.0 and won't provide any updates for the v0.7 (legacy) branch anymore. More information can be found [here](https://www.firezone.dev/blog/firezone-1-0).
25-
>
40+
41+
> [!TIP]
2642
> A new fork (l4rm4nd/fireabend) tries to fix outdated dependencies and keep the software alive.
43+
>
44+
> The fork starts with a new v7.0.0 release version and tag.

0 commit comments

Comments
 (0)