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

readme fixes

Browse Source
This commit is contained in:
azpsen 2025-01-05 17:48:21 -06:00
parent f076146ffb
commit 75b70669d3
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
readme.md
View File

@ -1,10 +1,10 @@
# homelab # Homelab
## services ## Services
These are all the services hosted here, what they are for, and any clients I use with them. These are all the services hosted here, what they are for, and any clients I use with them.
### user-facing ### User-Facing
- [Jellyfin](https://jellyfin.org) - Media server for movies, TV shows, and music - [Jellyfin](https://jellyfin.org) - Media server for movies, TV shows, and music
- [Feishin](https://github.com/jeffvli/feishin) - Desktop music client (soon to be replaced by [audioling](https://github.com/audioling/audioling)) - [Feishin](https://github.com/jeffvli/feishin) - Desktop music client (soon to be replaced by [audioling](https://github.com/audioling/audioling))
@ -12,7 +12,7 @@ These are all the services hosted here, what they are for, and any clients I use
- For other devices (desktop, mobile, Roku/Android TV) I use either the web app or the official Jellyfin client - For other devices (desktop, mobile, Roku/Android TV) I use either the web app or the official Jellyfin client
- [Miniflux](https://miniflux.app/) - Minimalist RSS feed reader - [Miniflux](https://miniflux.app/) - Minimalist RSS feed reader
- [NetNewsWire](https://netnewswire.com/) - Wonderful all-purpose iOS RSS client - [NetNewsWire](https://netnewswire.com/) - Wonderful all-purpose iOS RSS client
- [Vaultwarden](https://github.com/dani-garcia/vaultwarden) - Password manager - [vaultwarden](https://github.com/dani-garcia/vaultwarden) - Password manager
- [Bitwarden clients](https://bitwarden.com/download/) - [Bitwarden clients](https://bitwarden.com/download/)
- [Gitea](https://about.gitea.com/) - Git server - in the process of replacing my GitHub account - [Gitea](https://about.gitea.com/) - Git server - in the process of replacing my GitHub account
- [LinkStack](https://linkstack.org/) - Self-hosted LinkTree alternative - [LinkStack](https://linkstack.org/) - Self-hosted LinkTree alternative
@ -34,14 +34,14 @@ These are all the services hosted here, what they are for, and any clients I use
- [Yomu](https://www.yomu-reader.com/) for iOS is nice and minimal and supports OPDS for use with Calibre Web - [Yomu](https://www.yomu-reader.com/) for iOS is nice and minimal and supports OPDS for use with Calibre Web
- [Joplin](https://joplinapp.org/) - Notes (Obsidian alternative) - [Joplin](https://joplinapp.org/) - Notes (Obsidian alternative)
### monitoring ### Monitoring
- [Dozzle](https://dozzle.dev/) - Docker logs all in one place - [Dozzle](https://dozzle.dev/) - Docker logs all in one place
- [Scrutiny](https://github.com/AnalogJ/scrutiny) - HDD SMART monitoring, so I know when to prepare for a drive failure - [Scrutiny](https://github.com/AnalogJ/scrutiny) - HDD SMART monitoring, so I know when to prepare for a drive failure
- [Speedtest Tracker](https://speedtest-tracker.dev/) - Runs scheduled internet speedtests and creates pretty graphs to keep my ISP honest - [Speedtest Tracker](https://speedtest-tracker.dev/) - Runs scheduled internet speedtests and creates pretty graphs to keep my ISP honest
- [Glances](https://github.com/nicolargo/glances) - System monitor - I mostly have this for dashboard widgets but it can be useful by itself - [Glances](https://github.com/nicolargo/glances) - System monitor - I mostly have this for dashboard widgets but it can be useful by itself
### networking ### Networking
- [cloudflared](https://github.com/cloudflare/cloudflared) - CloudFlare tunnel client for easy and secure external service access - [cloudflared](https://github.com/cloudflare/cloudflared) - CloudFlare tunnel client for easy and secure external service access
- [gluetun](https://github.com/qdm12/gluetun) - Docker VPN client - [gluetun](https://github.com/qdm12/gluetun) - Docker VPN client
@ -49,7 +49,7 @@ These are all the services hosted here, what they are for, and any clients I use
Note that I run tailscale on bare metal so it is not listed here, but it is very useful for remote access to services I don't want visible on the open internet as well as SSH access. Note that I run tailscale on bare metal so it is not listed here, but it is very useful for remote access to services I don't want visible on the open internet as well as SSH access.
### downloading ### Downloading
- [qBittorrent](https://www.qbittorrent.org/) - The only torrent client I'll ever use - [qBittorrent](https://www.qbittorrent.org/) - The only torrent client I'll ever use
- [Radarr](https://radarr.video/) - Automated movie fetching - [Radarr](https://radarr.video/) - Automated movie fetching
@ -59,7 +59,7 @@ Note that I run tailscale on bare metal so it is not listed here, but it is very
I use [LunaSea](https://www.lunasea.app/) as a mobile client for Radarr and Sonarr. I use [LunaSea](https://www.lunasea.app/) as a mobile client for Radarr and Sonarr.
## environment ## Environment
This configuration uses `.env` files to separate secrets from public information and maintain brevity in the main `docker-compose.yml` This configuration uses `.env` files to separate secrets from public information and maintain brevity in the main `docker-compose.yml`
@ -83,7 +83,7 @@ SERVER_CITIES=
The actual values should be available in the WireGuard configuration from Mullvad. The actual values should be available in the WireGuard configuration from Mullvad.
### 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. My current Immich docker setup includes a lot of repetition - when I want to update, I have to change the version in 3 places.
@ -108,7 +108,7 @@ POSTGRES_USER=postgres
POSTGRES_DB=immich POSTGRES_DB=immich
``` ```
### joplin ### Joplin
``` ```
APP_PORT=22300 APP_PORT=22300
@ -131,14 +131,14 @@ MAILER_NOREPLY_NAME=
MAILER_NOREPLY_EMAIL= MAILER_NOREPLY_EMAIL=
``` ```
### linkstack ### LinkStack
``` ```
HTTPS_SERVER_NAME= HTTPS_SERVER_NAME=
SERVER_ADMIN= SERVER_ADMIN=
``` ```
### miniflux ### Miniflux
``` ```
DATABASE_URL=postgres://miniflux:{...}@rss_db:5432/miniflux?sslmode=disable # replace {...} with your postgres password DATABASE_URL=postgres://miniflux:{...}@rss_db:5432/miniflux?sslmode=disable # replace {...} with your postgres password
@ -149,7 +149,7 @@ POSTGRES_PASSWORD= # this is the password used above
POSTGRES_DB=miniflux POSTGRES_DB=miniflux
``` ```
### paperless ### Paperless-ngx
``` ```
USERMAP_UID=1000 USERMAP_UID=1000
@ -178,7 +178,7 @@ PAPERLESS_EMAIL_HOST_PASSWORD=
PAPERLESS_EMAIL_FROM= PAPERLESS_EMAIL_FROM=
``` ```
### speedtest tracker ### Speedtest Tracker
``` ```
PUID=1000 PUID=1000
@ -191,7 +191,7 @@ DISPLAY_TIMEZONE=
SPEEDTEST_SCHEDULE=0,15,30,45 * * * * # run speedtest every 15 minutes SPEEDTEST_SCHEDULE=0,15,30,45 * * * * # run speedtest every 15 minutes
``` ```
### tandoor ### Tandoor
``` ```
# 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