azpsen/homelab
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add more documentation links

Browse Source
This commit is contained in:
April Petersen 2025-01-06 10:17:47 -06:00
parent 665db5ca1d
commit c1ce4eda52
1 changed files with 21 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
readme.md
View File

@ -100,7 +100,9 @@ Below are the variables that need to be set in the `.env` file for each service.
### gluetun ### gluetun
The values below are specific to Mullvad VPN ([docs](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/mullvad.md)). Other providers need different values, refer to the corresponding gluetun documentation. [Docs](https://github.com/qdm12/gluetun)
The values below are specific to Mullvad VPN ([gluetun docs](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/mullvad.md)). Other providers need different values, refer to the corresponding gluetun documentation.
```env ```env
VPN_SERVICE_PROVIDER=mullvad VPN_SERVICE_PROVIDER=mullvad
@ -114,9 +116,9 @@ The values for `WIREGUARD_PRIVATE_KEY` and `WIREGUARD_ADDRESSES` should be avail
### Immich ### Immich
My current Immich docker setup includes a lot of repetition - when I want to update, I have to change the version in 3 places. I have plans to improve this, but for now this is what works. Also note that the way I set the upload location is not recommended by the Immich docs. [Docs](https://immich.app/docs/install/docker-compose/)
For more information, see the Immich [docker-compose setup instructions](https://immich.app/docs/install/docker-compose/). My current Immich docker setup has a lot of repetition - when I want to update, I have to change the version in 3 places. I have plans to improve this, but for now this is what works. Also note that the way I set the upload location is not recommended by the Immich docs.
```env ```env
UPLOAD_LOCATION=/media/immich UPLOAD_LOCATION=/media/immich
@ -139,7 +141,7 @@ POSTGRES_DB=immich
### Joplin ### Joplin
See the [docker-joplin-server docs](https://github.com/flosoft/docker-joplin-server) for more info. [Docs](https://github.com/flosoft/docker-joplin-server)
```env ```env
APP_PORT=22300 APP_PORT=22300
@ -151,7 +153,7 @@ POSTGRES_USER=
POSTGRES_PORT=5432 POSTGRES_PORT=5432
POSTGRES_HOST=joplin-db POSTGRES_HOST=joplin-db
# Optional SMTP options # Optional SMTP settings
MAILER_ENABLED=1 MAILER_ENABLED=1
MAILER_HOST= MAILER_HOST=
MAILER_PORT=465 MAILER_PORT=465
@ -164,7 +166,9 @@ MAILER_NOREPLY_EMAIL=
### LinkStack ### LinkStack
This one just needs the public hostname and admin email. [Docs](https://linkstack.org/docker/). [Docs](https://linkstack.org/docker/)
This one just needs the public hostname and admin email.
```env ```env
HTTPS_SERVER_NAME= HTTPS_SERVER_NAME=
@ -217,13 +221,18 @@ PAPERLESS_EMAIL_FROM=
### Speedtest Tracker ### Speedtest Tracker
[Docs](https://docs.speedtest-tracker.dev/getting-started/installation/using-docker-compose). `APP_URL` is the public address, `APP_KEY` is generated with `echo -n 'base64:'; openssl rand -base64 32;` [Docs](https://docs.speedtest-tracker.dev/getting-started/installation/using-docker-compose)
```env ```env
PUID=1000 PUID=1000
PGID=1000 PGID=1000
# Generate with `echo -n 'base64:'; openssl rand -base64 32;` or use the speedtest-tracker website
APP_KEY= APP_KEY=
# Public address or IP
APP_URL= APP_URL=
DB_CONNECTION=sqlite DB_CONNECTION=sqlite
APP_TIMEZONE= APP_TIMEZONE=
DISPLAY_TIMEZONE= DISPLAY_TIMEZONE=
@ -232,7 +241,7 @@ SPEEDTEST_SCHEDULE=0,15,30,45 * * * * # run speedtest every 15 minutes
### Tandoor ### Tandoor
[Docs](https://docs.tandoor.dev/install/docker/). [Docs](https://docs.tandoor.dev/install/docker/)
```env ```env
# Random secret key, use for example `base64 /dev/urandom | head -c50` to generate one # Random secret key, use for example `base64 /dev/urandom | head -c50` to generate one
@ -252,16 +261,18 @@ POSTGRES_PASSWORD=
### vaultwarden ### vaultwarden
[Docs](https://github.com/dani-garcia/vaultwarden). Note that the crypto API requires HTTPS, so local access is a bit of a challenge. [Docs](https://github.com/dani-garcia/vaultwarden)
Note that the cryptography API used by vaultwarden requires HTTPS, so local access can be a bit of a challenge.
These values are only required if you need to use the vaultwarden admin page (for user management, SMTP, hardware 2FA, etc.). The `ADMIN_TOKEN` value gave me trouble - to make it work, I used the 'Using `argon2`' instructions from [Enabling admin page](https://github.com/dani-garcia/vaultwarden/wiki/Enabling-admin-page) in the docs. At `your-ip-or-url.com/admin`, the password you used for the hash will unlock it (e.g. `MySecretPassword` per their example). These values are only required if you need to use the vaultwarden admin page (for user management, SMTP, hardware 2FA, etc.). The `ADMIN_TOKEN` value gave me trouble - to make it work, I used the 'Using `argon2`' instructions from [Enabling admin page](https://github.com/dani-garcia/vaultwarden/wiki/Enabling-admin-page) in the docs. At `your-ip-or-url.com/admin`, the password you used for the hash will unlock it (e.g. `MySecretPassword` per their example).
Note: The `ADMIN_TOKEN` value should be enclosed in single quotes. If it is not, all instances of `$` in the value will need to be replaced with `$$` to prevent the value from being split by the parser. Note: The `ADMIN_TOKEN` value should be enclosed in single quotes. If it is not, all instances of `$` in the value will need to be replaced with `$$` to prevent the value from being split by the parser.
```env ```env
# Public domain or IP
DOMAIN= DOMAIN=
# Dollar signs must be replaced with two dollar signs to properly escape variables in this token
ADMIN_TOKEN= ADMIN_TOKEN=
# Optional SMTP email settings # Optional SMTP email settings