Compose-Examples/README.md

Awesome Docker Compose Examples

Various Docker Compose examples of selfhosted FOSS and proprietary projects.

✨ 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 be always adjusted due to security reasons. Read the comments!

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

Note: The samples are intended for use in 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, 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

Dashboards

• 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 Management

• 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.

Reverse Proxies

• 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 Providers / Single Sign On (SSO) / 2FA

• 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.
• 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.
• Authentik - authentik is an open-source Identity Provider focused on flexibility and versatility. You can use authentik in an existing environment to add support for new protocols. authentik is also a great solution for implementing signup/recovery/etc in your application, so you don't have to deal with it.
• Keycloak - Keycloak is an open-source Identity and Access Management (IAM) solution for modern applications and services.

Virtual Private Network (VPN)

• 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.
• 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.

Domain Name Service (DNS)

• 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.

Repository Management, Coding and Automation

• 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.
• n8n - Free and source-available fair-code licensed workflow automation tool. Easily automate tasks across different services.

Monitoring

• Watchtower - A container-based solution for automating Docker container base image updates.
• Portainer - Portainer is a lightweight management UI which allows you to easily manage your different Docker environments (Docker hosts or Swarm clusters).
• 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 like Loki, Promtail, InfluxDB and Telegraf, monitoring data can be aggregated, normalized, filtered, parsed and finally visualized within a web dashboard.
• Speedtest-Tracker - Continuously track your internet speed.
• Openspeedtest - A free and open-source HTML5 network performance estimation tool written in vanilla JavaScript and only uses built-in web APIs like XHR, HTML, CSS, JS and SVG.
• Goaccess - Real-time web log analyzer and interactive viewer that visualizes various logs of popular reverse proxies such as Nginx, Nginx Proxy Manager and Traefik.
• WatchYourLAN - Lightweight network IP scanner with web GUI.
• 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.
• dockcheck-web - A webpage showing available image updates for your running containers.

Tools & Helpers

• Network-Multitool - Multi-arch multitool for container network troubleshooting.
• IT-Tools - Collection of handy online tools for developers, with great UX.
• Monkeytype - The most customizable typing website with a minimalistic design and a ton of features. Test yourself in various modes, track your progress and improve your speed.
• GCHQ CyberChef - The Cyber Swiss Army Knife - a web app for encryption, encoding, compression and data analysis.

Recipe Managers

• Tandoor - Django application to manage, tag and search recipes using either built-in models or external storage providers hosting PDFs, Images or other files.
• Mealie - Material design inspired recipe manager with category and tag management, shopping-lists, meal-planner, and site customizations. Mealie is focused on simple user interactions to keep the whole family using the app.

Media Management (Photos, Music, Videos, -Arr)

• Immich - Self-hosted photo and video backup solution directly from your mobile phone. Alternative to Google Photos.
• Photoprism - Personal photo management powered by Go and Google TensorFlow. Browse, organize, and share your personal photo collection, using the latest technologies to automatically tag and find pictures.
• Stash - Stash is a self-hosted webapp written in Go which organizes and serves your porn.
• Raveberry - A multi-user music server with a focus on participation.
• Deemix - deemix is a barebone deezer downloader library built from the ashes of Deezloader Remix.
• Forte - forte is a self-hosted music platform. You can either connect to a forte server or create your own server for your friends & family. However, it is also very convenient to use forte on your local machine as a stand-alone music player. Supports group streaming sessions.
• MeTube - Web GUI for youtube-dl (using the yt-dlp fork) with playlist support. Allows you to download videos and audio only from YouTube and dozens of other sites.
• Syncthing - Syncthing is a continuous file synchronization program. It synchronizes files between two or more computers.
• Transmission - Transmission is a fast, easy, and free BitTorrent client.
• FlareSolverr - FlareSolverr is a proxy server to bypass Cloudflare and DDoS-GUARD protection.
• Plex - Plex organizes video, music and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices.
• Jellyfin - Jellyfin is the volunteer-built media solution that puts you in control of your media. Stream to any device from your own server, with no strings attached.
• Jackett - Jackett translates queries from apps (Sonarr, Radarr, SickRage, CouchPotato, Mylar3, Lidarr, DuckieTV, qBittorrent, Nefarious etc.) into tracker-site-specific http queries, parses the html or json response, and then sends results back to the requesting software. This allows for getting recent uploads (like RSS) and performing searches. Jackett is a single repository of maintained indexer scraping & translation logic - removing the burden from other apps.
• Lidarr - Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new albums from your favorite artists and will interface with clients and indexers to grab, sort, and rename them.
• Prowlarr - Prowlarr is an indexer manager/proxy built on the popular *arr .net/reactjs base stack to integrate with your various PVR apps. Prowlarr supports management of both Torrent Trackers and Usenet Indexers. It integrates seamlessly with Lidarr, Mylar3, Radarr, Readarr, and Sonarr offering complete management of your indexers with no per app Indexer setup required (we do it all).
• Radarr - Radarr is a movie collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new movies and will interface with clients and indexers to grab, sort, and rename them. It can also be configured to automatically upgrade the quality of existing files in the library when a better quality format becomes available.
• Sonarr - Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
• Ombi - Ombi is a tool that enables users to manage requests for movies and TV shows on their Plex server. It provides an easy-to-use interface for users to request new content, leave notes and report issues. Ombi also offers notification and newsletter features, making it easier for server owners to manage user requests and share new content updates.
• LibrePhotos - A self-hosted open source photo management service, with face recognition, geolocation, and more.

Document Management Systems (DMS)

• Paperless NGX - A community-supported supercharged version of paperless: scan, index and archive all your physical documents.
• Papermerge - Free and open source document management system with OCR designed for scanned documents, digital archives, pdf, tiff, jpeg.

Pastebins

• PrivateBin - PrivateBin is a minimalist, opensource online pastebin/discussion board where the server has zero knowledge of hosted data.
• Hemmelig - Keep your sensitive information out of chat logs, emails, and more with encrypted secrets. Free encrypted secret sharing for everyone!

File Sharing / Storage / Collaboration

• ownCloud OCIS - ownCloud Infinite Scale (oCIS) is the new file sync & share platform written in Golang that will be the foundation of your data management platform.
• Nextcloud - Access and share your files, calendars, contacts, mail and more from any device, on your terms.
• Seafile - File hosting and sharing solution primary for teams and organizations.
• SFTPGo - Fully featured and highly configurable SFTP server with optional HTTP/S, FTP/S and WebDAV support - S3, Google Cloud Storage, Azure Blob.
• Filebrowser - filebrowser provides a file managing interface within a specified directory and it can be used to upload, delete, preview, rename and edit your files.
• FileRun - FileRun is a self-hosted File Sync and Share web-based application. It is a full featured web based file manager with an easy to use user interface.
• Gokapi - Lightweight selfhosted Firefox Send alternative without public upload. AWS S3 supported.
• Projectsend - ProjectSend is a free, open source software that lets you share files with your clients, focused on ease of use and privacy. It supports clients groups, system users roles, statistics, multiple languages, detailed logs and much more!
• Pwndrop - pwndrop is a self-deployable file hosting service for sending out red teaming payloads or securely sharing your private files over HTTP and WebDAV.
• Droppy (deprecated) - droppy is a self-hosted file storage server with a web interface and capabilities to edit files and view media directly in the browser. It is particularly well-suited to be run on low-end hardware like the Raspberry Pi.
• PairDrop - PairDrop is a sublime alternative to AirDrop that works on all platforms. Send images, documents or text via peer to peer connection to devices in the same local network/Wi-Fi or to paired devices.
• MinIO - MinIO is an object storage server, compatible with Amazon S3 cloud storage service, mainly used for storing unstructured data (such as photos, videos, log files, etc.).
• Transfer.sh - Easy and fast file sharing from the command-line.
• Transfer.zip - Transfer files securely and E2E encrypted (AES-256 GCM) between browsers using WebRTC Peer2peer.
• HedgeDoc - HedgeDoc lets you create real-time collaborative markdown notes.

Publishing, Writing, Blogging, Hosting

• Ghost - Ghost is a free and open source blogging platform written in JavaScript and distributed under the MIT License, designed to simplify the process of online publishing for individual bloggers as well as online publications.
• WordPress - WordPress is a free and open-source content management system written in hypertext preprocessor language and paired with a MySQL or MariaDB database with supported HTTPS.
• Nginx + PHP - Nginx is a web server that can also be used as a reverse proxy, load balancer, mail proxy and HTTP cache. Combined with PHP, a general-purpose scripting language geared toward web development, server-side functions can be implemented for the webs.
• Overleaf - Overleaf is a collaborative cloud-based LaTeX editor used for writing, editing and publishing scientific documents.
• Answer - An open-source knowledge-based community software. You can use it quickly to build Q&A community for your products, customers, teams, and more.
• Obsidian-Gitsync-Perlite - Continuously sync Obsidian markdown notes from GitHub and publish it for the webs.
• Obsidian-Remote - This docker image allows you to run obsidian in docker as a container and access it via your web browser.
• Memos - An open-source, self-hosted memo hub with knowledge management and social networking.
• Reactive-Resume - A one-of-a-kind resume builder that keeps your privacy in mind. Completely secure, customizable, portable, open-source and free forever.
• Monkeytype - The most customizable typing website with a minimalistic design and a ton of features. Test yourself in various modes, track your progress and improve your speed.
• HedgeDoc - HedgeDoc lets you create real-time collaborative markdown notes.

Analytics

• Matomo - Matomo is the leading Free/Libre open analytics platform.
• Plausible - Simple, open-source, lightweight (< 1 KB) and privacy-friendly web analytics alternative to Google Analytics.

Security & Privacy

• Nessus - Nessus is a proprietary vulnerability scanner developed by Tenable, Inc.
• Greenbone - Greenbone is the world's most trusted provider of open source vulnerability management.
• SonarQube - SonarQube is an open-source platform developed by SonarSource for continuous inspection of code quality to perform automatic reviews with static analysis of code to detect bugs and code smells on 29 programming languages.
• Fail2ban - Fail2ban is an intrusion prevention software framework. Written in the Python programming language, it is designed to prevent against brute-force attacks.
• Tor-Browser - Running a Tor browser instance on any headless server.
• Firefox - Firefox by linuxserver.io allows you to run the popular Firefox web broser on a remote server.
• Libreddit - Libreddit is a portmanteau of "libre" (meaning freedom) and "Reddit". It is a private front-end like Invidious but for Reddit. Browse the coldest takes of r/unpopularopinion without being tracked.
• Bibliogram (deprecated) - Bibliogram is a private front-end frontend to Instagram, similar to Invidous.
• Nitter - Nitter is an alternative front-end to Twitter, and was inspired by Invidious.

Internet of Things / Smart Home / IT Automation

• 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.
• UpSnap - A simple wake on lan app written with SvelteKit, Go, PocketBase and nmap.

Asset Management

• Domainmod - DomainMOD is an open source application used to manage your domains and other internet assets in a central location.
• Snipe-IT - Snipe-IT is a free, open source IT asset management system written in PHP.

Backups & Syncing

• Duplicati - Duplicati is a backup client that securely stores encrypted, incremental, compressed remote backups of local files on cloud storage services and remote file servers.
• Duplicacy - A lock-free deduplication cloud backup tool.
• Syncthing - Syncthing is a continuous file synchronization program. It synchronizes files between two or more computers.

Wiki & Knowledge Base

• Bookstack - BookStack is a free and open-source wiki software aimed for a simple, self-hosted, and easy-to-use platform.
• Wiki.js - Wiki.js is an open source project that has been made possible due to the generous contributions by community backers.
• Answer - An open-source knowledge-based community software. You can use it quickly to build Q&A community for your products, customers, teams, and more.
• Obsidian-Remote - This docker image allows you to run obsidian in docker as a container and access it via your web browser.
• Obsidian-Gitsync-Perlite - Continuously sync Obsidian markdown notes from GitHub and publish it for the webs.
• Memos - An open-source, self-hosted memo hub with knowledge management and social networking.
• HedgeDoc - HedgeDoc lets you create real-time collaborative markdown notes.

Finance

• TRSync - Django web frontend for pytr to download all Trade Republic depot data.
• Money-Balancer - A simple application for managing debt with your friends!
• Firefly III - A self-hosted manager for your personal finances.

Communication and Social

• Mirotalk P2P - Simple, Secure, Fast Real-Time Video Conferences Up to 4k and 60fps, compatible with all browsers and platforms.
• Rocket.Chat - Rocket.Chat is an open-source fully customizable communications platform developed in JavaScript for organizations with high standards of data protection.
• Answer - An open-source knowledge-based community software. You can use it quickly to build Q&A community for your products, customers, teams, and more.
• Excalidraw - Excalidraw is a virtual collaborative whiteboard tool that lets you easily sketch diagrams that have a hand-drawn feel to them.
• Reactive-Resume - A one-of-a-kind resume builder that keeps your privacy in mind. Completely secure, customizable, portable, open-source and free forever.

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.

Star History

Join the community!