diff --git a/README.md b/README.md index 7523d22..1e099a0 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,35 @@ # Self-Hosted Services -This repository contains my personal Docker Compose configuration for various self-hosted services, all exposed via Traefik. -It serves primarily as a personal deployment configuration and a reference for others. +This repository contains my personal Docker Compose configuration for various self-hosted services, all exposed via Traefik. It serves primarily as a personal deployment configuration and a reference for others. ---- +*** ### Services Included: -- **Traefik:** Reverse proxy and load balancer with automatic HTTPS, now also handling SSH entry points and `bouvais.lu` redirection. -- **Prometheus:** Monitoring system. -- **Grafana:** Data visualization and dashboarding for Prometheus. -- **cAdvisor:** Container resource usage and performance analysis. -- **Node Exporter:** Exposes hardware and OS metrics for Prometheus. -- **Nvidia GPU Exporter:** Exposes NVIDIA GPU metrics for Prometheus. -- **Fail2Ban:** Intrusion prevention for various services, specifically configured to monitor Docker logs. -- **Vaultwarden:** Unofficial Bitwarden server implementation, with an added secure admin interface. -- **Kopia:** Fast, secure, and incremental backups, with a web UI. -- **Siyuan:** A local-first personal knowledge management system (replaces Memos). -- **Jellyfin:** Free software media system. -- **Filebrowser:** Web interface to browse and manage files. -- **Gitea:** Lightweight Git service (this repository is hosted on it!), also serving documentation via MkDocs. -- **Gitea Runner:** A runner for Gitea actions. -- **MkDocs ZipponDB:** Serves documentation generated by MkDocs. -- **Actual Budget:** Local-first personal finance app. -- **MinIO:** High performance, S3 compatible object storage. -- **Open WebUI:** A user-friendly interface for interacting with large language models. -- **Ollama:** A framework for running large language models locally, with GPU support. -- **Personal Website (website-pro):** A custom-built professional website. +* **Traefik:** Reverse proxy and load balancer with automatic HTTPS, now also handling SSH entry points and `bouvais.lu` redirection. +* **Monitoring Stack:** + * **Prometheus:** Monitoring system. + * **Grafana:** Data visualization and dashboarding for Prometheus. + * **cAdvisor:** Container resource usage and performance analysis. + * **Node Exporter:** Exposes hardware and OS metrics for Prometheus. + * **Nvidia GPU Exporter:** Exposes NVIDIA GPU metrics for Prometheus. +* **Fail2Ban:** Intrusion prevention for various services, specifically configured to monitor Traefik's access logs. +* **Vaultwarden:** Unofficial Bitwarden server implementation, with an added secure admin interface. +* **Kopia:** Two instances for fast, secure, and incremental backups: one for local backups (`kopia`) and another for off-site backups to Google Cloud Platform (`kopia-gcp`). +* **Siyuan:** A local-first personal knowledge management system. +* **Jellyfin:** Free software media system. +* **Filebrowser:** Web interface to browse and manage files. +* **LibreOffice Online:** A web-based version of the LibreOffice suite for in-browser document editing. +* **Gitea & Gitea Runner:** A lightweight Git service and a runner for Gitea actions. +* **MkDocs:** Serves a static documentation site generated by MkDocs. +* **Docker Registry & UI:** A private Docker registry to store custom images, complete with a web interface for management. +* **Actual Budget:** Local-first personal finance app. +* **MinIO:** High performance, S3 compatible object storage. For DVC. +* **Open WebUI & Pipelines:** A user-friendly interface for interacting with large language models, supported by a backend pipeline service. +* **Web-based Arch Linux Terminals:** Two `ttyd`-based containers (`arch-cpu` and `arch-gpu`) providing persistent Arch Linux environments accessible through a web browser, with one configured for GPU access. ---- +*** ### Usage -This repository is not intended for direct cloning and deployment as-is. It is highly tailored to my specific setup, including domain names (`bouvais.lu`), paths, and personal configurations. -However, you can use this repository as an example or reference. +This repository is not intended for direct cloning and deployment as-is. It is highly tailored to my specific setup, including domain names (`bouvais.lu`), paths, and personal configurations. However, you can use this repository as an example or reference.