Compose-Examples

<div align="center" width="100%"> <h1>Awesome Docker Compose Examples</h1> <p>Various Docker Compose examples of selfhosted FOSS and proprietary projects.</p> <a target="_blank" href="https://github.com/docker/compose"><img src="https://badgen.net/badge/icon/docker%20compose?icon=docker&label" /></a> <a target="_blank" href="https://www.reddit.com/r/selfhosted"><img src="https://badgen.net/badge/icon/r%2fselfhosted?icon=reddit&label&color=red" /></a><p> <!--<a target="_blank" href="#"><img src="https://ForTheBadge.com/images/badges/makes-people-smile.svg" /></a><br>--> <a target="_blank" href="https://github.com/Haxxnet/Compose-Examples/stargazers"><img src="https://img.shields.io/github/stars/Haxxnet/Compose-Examples.svg?style=social&label=Star" /></a> <a target="_blank" href="https://github.com/Haxxnet/Compose-Examples/network/members"><img src="https://img.shields.io/github/forks/Haxxnet/Compose-Examples.svg?style=social&label=Fork" /></a> <a target="_blank" href="https://github.com/Haxxnet/Compose-Examples/watchers"><img src="https://img.shields.io/github/watchers/Haxxnet/Compose-Examples.svg?style=social&label=Watch" /></a><p> <a target="_blank" href="https://github.com/Haxxnet/Compose-Examples/tree/main/examples"><img src="https://img.shields.io/github/directory-file-count/Haxxnet/Compose-Examples/examples?label=Compose%20Examples&style=for-the-badge.svg" /></a><br> <a target="_blank" href="https://github.com/l4rm4nd"><img src="https://img.shields.io/badge/maintainer-LRVT-orange" /></a> <a target="_blank" href="https://GitHub.com/Haxxnet/Compose-Examples/graphs/contributors/"><img src="https://img.shields.io/github/contributors/Haxxnet/Compose-Examples.svg" /></a> <a target="_blank" href="https://github.com/Haxxnet/Compose-Examples/actions"><img src="https://github.com/Haxxnet/Compose-Examples/actions/workflows/validator.yml/badge.svg" /></a><br> <a target="_blank" href="https://github.com/Haxxnet/Compose-Examples/issues/new/choose"><img src="https://img.shields.io/badge/PRs+Issues-welcome-brightgreen.svg?style=flat-square" /></a> <a target="_blank" href="https://GitHub.com/Haxxnet/Compose-Examples/commits/"><img src="https://img.shields.io/github/last-commit/Haxxnet/Compose-Examples.svg" /></a> <a target="_blank" href="https://GitHub.com/Haxxnet/Compose-Examples/issues/"><img src="https://img.shields.io/github/issues/Haxxnet/Compose-Examples.svg" /></a> <a target="_blank" href="https://github.com/Haxxnet/Compose-Examples/issues?q=is%3Aissue+is%3Aclosed"><img src="https://img.shields.io/github/issues-closed/Haxxnet/Compose-Examples.svg" /></a><p> <a href="https://www.buymeacoffee.com/LRVT" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a> </div>

✨ Requirements

• Docker Compose

🎓 Usage

• Volume bind mounts are assumed to be located at /mnt/docker-volumes/<container-name>/. You can adjust the path via the global env variable DOCKER_VOLUME_STORAGE to your liking though. The compose examples will fall back to /mnt/docker-volumes/<container-name>/ if the env variable is not set on your Docker server.
• Volume permissions (UID:GUID) must be set correctly by yourself. Usually 1000:1000 - otherwise read the notes!
• Docker networks are not pre-defined. Adjust to your preference and network/proxy setup.
• Example config files are usually provided but not yet located in the correct volume bind mount paths. Adjust!
• Example credentials should always be adjusted due to security reasons. May put them in a separate .env file or platform for secrets management.

Otherwise, it should be a matter of:

git clone https://github.com/Haxxnet/Compose-Examples && cd Compose-Examples
cd <container-of-interest>

# read the notes, comments and adjust compose + volumes + configs
docker compose up

[!TIP]
You can find an online web version of this GitHub repository here.

[!CAUTION] The samples are intended for local development environments such as project setups, tinkering with software stacks, etc. These samples may be deployed in production environments or exposed to the Internet but please adhere to general hardening and security guidelines. Adjust all default credentials, use a separate .env file or platform for secret management, implement a backup process and have a tested disaster recovery plan. Use a reverse proxy to stream-line your web service exposure and provide an encrypted HTTPS communication channel with trusted SSL certificates.

🐳 Project List

Table of Contents (ToC)

• Analytics
• Archiving and Digital Preservation (DP)
• Asset Management
• Audio and Video Management
• Automation and Monitoring
• Backups
• Blogging Platforms and Homepages
• Communication - Social Networks, Forums and Video Conferencing
• Document Management
• Domain Name Service (DNS)
• E-commerce
• File Transfer & Synchronization
• Games and Control Panels
• Genealogy
• Identity Management - Single Sign-On (SSO) & LDAP
• LLM & AI
• Miscellaneous
• Money, Budgeting & Management
• Note-taking & Editors
• Password Managers
• Pastebins
• Personal Dashboards
• Photo and Video Galleries
• Proxy
• Recipe Management
• Request Bins
• Security & Privacy
• Software Development - Project Management, DevOps
• URL Shorteners
• Virtual Private Network (VPN) & Remote Access
• Wikis & Knowledge Base

Personal Dashboards

^ back to top ^

Dashboards for accessing information and applications.

• Homepage - A highly customizable homepage (or startpage / application dashboard) with Docker and service API integrations.
• Homer - A dead simple static homepage to expose your server services, with an easy yaml configuration and connectivity check.
• Dashy - Feature-rich homepage for your homelab, with easy YAML configuration.
• Homarr - A sleek, modern dashboard that puts all of your apps and services at your fingertips.
• Flame - Flame is self-hosted startpage for your server. Easily manage your apps and bookmarks with built-in editors.
• Heimdall - Heimdall is an elegant solution to organise all your web applications.

Password Managers

^ back to top ^

A password manager allows users to store, generate, and manage their passwords for local applications and online services.

• Vaultwarden - Lightweight Bitwarden server API implementation written in Rust. Unlocks paid Bitwarden features such as 2FA.
• Bitwarden Unified - Official Bitwarden deployment option (beta) targeting selfhosters by providing a resource-efficient, single Docker image with multiple database support.
• Passbolt CE - Passbolt CE open source password manager for teams based on GPG.

Proxy

^ back to top ^

A proxy is a server application that acts as an intermediary between a client requesting a resource and the server providing that resource.

• Traefik - Traefik is a modern HTTP reverse proxy and load balancer made to deploy microservices with ease. It supports several backends (Docker, Swarm, Mesos/Marathon, …) to manage its configuration automatically and dynamically.
• Nginx Proxy Manager - Nginx Proxy Manager is an easy way to accomplish reverse proxying hosts with SSL termination.
• Caddy - The Caddy web server is an extensible, cross-platform, open-source web server written in Go. Caddy obtains and renews TLS certificates for your sites automatically.
• oauth2-proxy - A reverse proxy that provides authentication with Google, Azure, OpenID Connect and many more identity providers.

Identity Management - Single Sign-On (SSO) & LDAP

^ back to top ^

Single sign-on (SSO) is an authentication scheme that allows a user to log in with a single ID to any of several related, yet independent, software systems.

• Authelia - Authelia is an open-source authentication and authorization server providing two-factor authentication and single sign-on (SSO) for your applications via a web portal. It acts as a companion for reverse proxies by allowing, denying, or redirecting requests. Recommended to combine with Traefik.
• Authentik - Authentik is an open-source Identity Provider focused on flexibility and versatility.
• Keycloak - Keycloak is an open-source Identity and Access Management (IAM) solution for modern applications and services.
• lldap - lldap is a lightweight authentication server that provides an opinionated, simplified LDAP interface for authentication. It integrates with many backends, from KeyCloak to Authelia to Nextcloud and more.

Large Language Models & AI

^ back to top ^

A Large Language Model (LLM) is a language model notable for its ability to achieve general-purpose language generation and other natural language processing tasks such as classification. LLMs can be used for text generation, a form of generative AI, by taking an input text and repeatedly predicting the next token or word.

• Ollama + Open WebUI - Get up and running with Llama 3, Mistral, Gemma, and other large language models using Ollama. Using an interactive, user-friendly WebUI via Open WebUI (formerly known as Ollama WebUI).
• Serge - A web interface for chatting with Alpaca through llama.cpp. Fully dockerized, with an easy to use API.

Virtual Private Network (VPN) & Remote Access

^ back to top ^

A VPN is a mechanism for creating a secure connection between a computing device and a computer network, or between two networks, using an insecure communication medium such as the public Internet.

• wg-easy - The easiest way to install & manage WireGuard on any Linux host. All-in-one deployment of a WireGuard VPN network service + web management UI.
• WireGuard - WireGuard by Linuxserver.io is an extremely simple yet fast and modern VPN that utilizes state-of-the-art cryptography.
• IPSec VPN Server - Docker image to run an IPsec VPN server, with IPsec/L2TP, Cisco IPsec and IKEv2.
• OpenVPN-AS - OpenVPN Access Server delivers an enterprise VPN solution for businesses of all sizes, providing a securely encrypted connection to private networks over unsecured public internet.
• Firezone - Self-hosted secure remote access gateway that supports the WireGuard protocol. It offers a Web GUI, 1-line install script, multi-factor auth (MFA), and SSO.
• Netbird - Quickly connect your computers, servers, cloud instances, and IoT devices into a secure private network. No configuration required.
• Headscale - An open source, self-hosted implementation of the Tailscale control server.
• Guacamole - Guacamole is a clientless remote desktop gateway. It supports standard protocols like VNC, SSH and RDP.

Domain Name Service (DNS)

^ back to top ^

DNS servers and management tools with advertisement blocking funtionality, primarily aimed at home or small networks.

• AdGuard Home - AdGuard Home is a network-wide software for blocking ads and tracking.
• AdGuard Home Sync - Synchronize AdGuardHome config to replica instances.
• Technitium DNS - An open source authoritative as well as recursive DNS server that can be used for self hosting a DNS server for privacy & security.
• Pihole - Pi-hole is a Linux network-level advertisement and Internet tracker blocking application which acts as a DNS sinkhole and optionally a DHCP server, intended for use on a private network.
• Cloudflare DDNS - Dynamic DNS (DDNS) is a service that keeps the DNS updated with a web property's correct IP address, even if that IP address is constantly being updated.

Software Development - Project Management, DevOps

^ back to top ^

Tools and software for software project management.

• JetBrains YouTrack - YouTrack is a proprietary, commercial browser-based bug tracker, issue tracking system and project management software developed by JetBrains.
• Leantime - Leantime is an open source project management system for small teams and startups written in PHP, Javascript using MySQL.
• Gitea - Community managed fork of Gogs, lightweight code hosting solution.
• Drone - Drone is a continuous delivery system built on container technology. Drone uses a simple YAML build file, to define and execute build pipelines inside Docker containers.
• Gitlab Community - Self Hosted Git repository management, code reviews, issue tracking, activity feeds and wikis.
• Code-Server - VS Code in the browser, hosted on a remote server.
• Onedev - Self-hosted Git Server with CI/CD and Kanban.

Automation and Monitoring

^ back to top ^

Automation software designed to reduce human intervention in processes.

• n8n - Free and source-available fair-code licensed workflow automation tool. Easily automate tasks across different services.
• Home Assistant - Open source home automation that puts local control and privacy first. Powered by a worldwide community of tinkerers and DIY enthusiasts. Perfect to run on a Raspberry Pi or a local server.
• Portainer - Portainer is a lightweight management UI which allows you to easily manage your different Docker environments (Docker hosts or Swarm clusters).
• Dockge - A fancy, easy-to-use and reactive self-hosted docker compose.yaml stack-oriented manager.
• Uptimekuma - Uptime Kuma is an easy-to-use self-hosted monitoring tool.
• Changedetection - Self-hosted tool for staying up-to-date with web-site content changes.
• Grafana+Loki+Promtail+InfluxDB+Telegraf - Grafana is the open source analytics & monitoring solution for every database. Combined with other open-source tools