Documentation Cleanup #112

New Issue

Jafner · 2023-12-16T14:25:19-08:00

Jafner commented

2023-12-16 14:25:19 -08:00

Tune up the repo README to introduce the tech stack, address how to use, and walk through the deployment process.
Categorize existing documentation.
Browse historical issues for process documentation which has not been collected into a doc.
Make a quick Mermaid diagram of what hosts do what.

Relates to #34

- [ ] Tune up the repo README to introduce the tech stack, address how to use, and walk through the deployment process. - [ ] Categorize existing documentation. - [ ] Browse historical issues for process documentation which has not been collected into a doc. - [ ] Make a quick Mermaid diagram of what hosts do what. Relates to #34

Jafner changed title from ~~Write Homelab Tour~~ to Documentation Cleanup

2024-02-15 13:10:32 -08:00

Jafner referenced this issue from a commit

2024-02-17 19:39:13 -08:00

#112 Init reorganized README

Jafner commented

2024-02-21 13:08:14 -08:00

flowchart TD
    barbarian
    druid
    fighter
    monk
    wizard
    cloudflare

cloudflare["Cloudflare DNS"] --DNS *.jafner.tools--> druid["Druid: High-uptime, low data services"]
cloudflare --DNS *.jafner.net----> wizard["Wizard: Routing with VyOS"]
wizard --Port forward :80,:443--> fighter["Fighter: Data-dependent services"]
barbarian["Barbarian: Primary NAS"] --Rsync backup--> monk["Monk: Backup NAS"]

druid --Docker--> 5eTools["5eTools: D&D 5th Edition Wiki"]
druid --Docker--> Gitea["Gitea: This Git server!"]
druid --Docker--> Uptime-Kuma["Uptime-Kuma: Synthetic monitoring and alerting"]
druid --Docker--> Vaultwarden["Vaultwarden: Self-hosted Bitwarden server"]
druid --Docker--> Wireguard["Wireguard: Performant VPN"]

fighter --Docker--> Autopirate["Autopirate: Stack of applications for downloading Linux ISOs"] <--SMB--> barbarian
fighter --Docker--> Calibre-web["Calibre-web: Ebook library frontend"] <--SMB--> barbarian
fighter --Docker--> Keycloak["Keycloak: SSO Provider"] 
fighter --Docker--> Minecraft["Minecraft Servers"] <--iSCSI--> barbarian
fighter --Docker--> Grafana["Grafana, Prometheus, Uptime-Kuma"]
fighter --Docker--> Nextcloud["Nextcloud: Cloud drive and office suite"] <--iSCSI--> barbarian
fighter --Docker--> Plex["Plex: Media library frontend"] <--SMB--> barbarian
fighter --Docker--> Qbittorrent["Qbittorrent: Torrent client"] <--SMB--> barbarian
fighter --Docker--> Send["Send: Self-hosted Firefox Send"] <--iSCSI--> barbarian
fighter --Docker--> Stash["Stash: Linux ISO frontend"] <--SMB--> barbarian
fighter --Docker--> Unifi["Unifi controller"]
fighter --Docker--> Vandam["Manyfold: 3D Asset library manager"] <--SMB--> barbarian
fighter --Docker--> Wireguard2["Wireguard: Performant VPN"]

```mermaid flowchart TD barbarian druid fighter monk wizard cloudflare cloudflare["Cloudflare DNS"] --DNS *.jafner.tools--> druid["Druid: High-uptime, low data services"] cloudflare --DNS *.jafner.net----> wizard["Wizard: Routing with VyOS"] wizard --Port forward :80,:443--> fighter["Fighter: Data-dependent services"] barbarian["Barbarian: Primary NAS"] --Rsync backup--> monk["Monk: Backup NAS"] druid --Docker--> 5eTools["5eTools: D&D 5th Edition Wiki"] druid --Docker--> Gitea["Gitea: This Git server!"] druid --Docker--> Uptime-Kuma["Uptime-Kuma: Synthetic monitoring and alerting"] druid --Docker--> Vaultwarden["Vaultwarden: Self-hosted Bitwarden server"] druid --Docker--> Wireguard["Wireguard: Performant VPN"] fighter --Docker--> Autopirate["Autopirate: Stack of applications for downloading Linux ISOs"] <--SMB--> barbarian fighter --Docker--> Calibre-web["Calibre-web: Ebook library frontend"] <--SMB--> barbarian fighter --Docker--> Keycloak["Keycloak: SSO Provider"] fighter --Docker--> Minecraft["Minecraft Servers"] <--iSCSI--> barbarian fighter --Docker--> Grafana["Grafana, Prometheus, Uptime-Kuma"] fighter --Docker--> Nextcloud["Nextcloud: Cloud drive and office suite"] <--iSCSI--> barbarian fighter --Docker--> Plex["Plex: Media library frontend"] <--SMB--> barbarian fighter --Docker--> Qbittorrent["Qbittorrent: Torrent client"] <--SMB--> barbarian fighter --Docker--> Send["Send: Self-hosted Firefox Send"] <--iSCSI--> barbarian fighter --Docker--> Stash["Stash: Linux ISO frontend"] <--SMB--> barbarian fighter --Docker--> Unifi["Unifi controller"] fighter --Docker--> Vandam["Manyfold: 3D Asset library manager"] <--SMB--> barbarian fighter --Docker--> Wireguard2["Wireguard: Performant VPN"] ```

Jafner referenced this issue from a commit

2024-02-21 13:39:42 -08:00

#112 Init Diagram.md

Sign in to join this conversation.

No Label

No Milestone

No project

No Assignees

1 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: Jafner/homelab#112