diff --git a/README.md b/README.md index f2cd939..50f1302 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,42 @@ -[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) -[![GitLab last commit](https://img.shields.io/github/last-commit/Haxxnet/Compose-Examples.svg)](https://GitHub.com/Haxxnet/Compose-Examples/commits/)
-[![GitHub issues](https://img.shields.io/github/issues/Haxxnet/Compose-Examples.svg)](https://GitHub.com/Haxxnet/Compose-Examples/issues/) -[![GitHub issues-closed](https://img.shields.io/github/issues-closed/Haxxnet/Compose-Examples.svg)](https://GitHub.com/Naereen/Haxxnet/Compose-Examples/issues?q=is%3Aissue+is%3Aclosed) +
+

Awesome Docker Compose Examples

+

Various Docker Compose examples of selfhosted FOSS projects.

+ +

+
+ + +

+ +
+ + + + + +

-[![Docker](https://badgen.net/badge/icon/docker%20compose?icon=docker&label)](https://https://docker.com/) -[![Reddit](https://badgen.net/badge/icon/r%2fselfhosted?icon=reddit&label&color=red)](https://www.reddit.com/r/selfhosted)
-[![ForTheBadge makes-people-smile](http://ForTheBadge.com/images/badges/makes-people-smile.svg)](#)
-[![GitHub stars](https://img.shields.io/github/stars/Haxxnet/Compose-Examples.svg?style=social&label=Star&maxAge=2592000)](https://GitHub.com/Haxxnet/Compose-Examples/stargazers/) -[![GitHub forks](https://img.shields.io/github/forks/Haxxnet/Compose-Examples.svg?style=social&label=Fork&maxAge=2592000)](https://GitHub.com/Haxxnet/Compose-Examples/network/) -[![GitHub watchers](https://img.shields.io/github/watchers/Haxxnet/Compose-Examples.svg?style=social&label=Watch&maxAge=2592000)](https://GitHub.com/Haxxnet/Compose-Examples/watchers/) - -[![Maintainer](https://img.shields.io/badge/maintainer-LRVT-orange)](https://github.com/l4rm4nd) -[![GitHub contributors](https://img.shields.io/github/contributors/Haxxnet/Compose-Examples.svg)](https://GitHub.com/Haxxnet/Compose-Examples/graphs/contributors/) - -# Compose-Examples - -Various Docker Compose examples of selfhosted FOSS projects. +## ✨ Requirements +- Docker Compose +## 🎓 Usage - Volume bind mounts are assumed to be located at `/mnt/docker-volumes//` -- Permissions must be set correctly by yourself -- Docker networks are not pre-defined. Adjust to your preferences. -- Example config files are usually provided but not yet located in the correct volume bind mount paths. -- Default credentials should be adjusted to your needs. Read the comments! +- 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 -docker compose up -d -```` -## Dashboards +# read the notes, comments and adjust compose + volumes + configs +docker compose up +```` +## 🐳 Project List + +### Dashboards - [Homepage](homepage) - [Homer](homer) - [Dashy](dashy) @@ -38,29 +44,29 @@ docker compose up -d - [Flame](flame) - [Heimdall](heimdall) -## Password Management +### Password Management - [Vaultwarden](vaultwarden) - [Bitwarden Unified](bitwarden-unified) -## Reverse Proxies +### Reverse Proxies - [Traefik](traefik) - [Nginx Proxy Manager](nginx-proxy-manager) - [Caddy](caddy) -## Virtual Private Network (VPN) +### Virtual Private Network (VPN) - [wg-easy](wg-easy) - [Wireguard](wireguard) - ~~[Netbird](https://github.com/netbirdio/netbird)~~ - ~~[Firezone](https://github.com/firezone/firezone)~~ -## Domain Name Service (DNS) +### Domain Name Service (DNS) - [Adguard Home](adguard-home) - [Adguard Home Sync](adguard-home-sync) - [Technitium DNS](technitium-dns) - [Pihole](pihole) - [Cloudflare DDNS](cloudflare-ddns) -## Repository Management & Coding +### Repository Management & Coding - [Gitea](gitea) - [Drone](drone) - [Gitlab Community](gitlab-ce) @@ -68,7 +74,7 @@ docker compose up -d - [Obsidian-Remote](obsidian-remote) - ~~[Onedev](https://github.com/theonedev/onedev)~~ -## Monitoring +### Monitoring - [Watchtower](watchtower) - [Portainer Enterprise](portainer-ee) - [Uptimekuma](uptimekuma) @@ -81,22 +87,22 @@ docker compose up -d - [Network-Multitool](network-multitool) - [Home Assistant](homeassistant) -## Recipe Managers +### Recipe Managers - [Tandoor](tandoor) - [Mealie](mealie) -## Media Management +### Media Management - [Immich](immich) - [Photoprism](photoprism) - [Deemix](deemix) - [Papermerge](papermerge) - [Paperless NGX](paperless-ngx) -## Pastebins +### Pastebins - [PrivateBin](privatebin) - [Hemmelig](hemmelig) -## File Sharing +### File Sharing - [Nextcloud](nextcloud) - [Seafile](seafile) - [SFTPGo](sftpgo) @@ -105,51 +111,51 @@ docker compose up -d - [Pwndrop](pwndrop) - [Droppy](droppy) -## Publishing, Writing, Blogging, Hosting +### Publishing, Writing, Blogging, Hosting - [Ghost](ghost) - [WordPress](wordpress) - [Nginx + PHP](nginx-php) - [Overleaf](overleaf) - [Answer](answer) -## Analytics +### Analytics - [Matomo](matomo) - [Plausible](plausible) -## Security & Privacy +### Security & Privacy - [Nessus](nessus) - [Greenbone](greenbone) - [SonarQube](sonarqube) - [Fail2ban](fail2ban) - [Tor-Browser](tor-browser) -## Internet of Things / Smart Home +### Internet of Things / Smart Home - [Home Assistant](homeassistant) -## Asset Management +### Asset Management - [Domainmod](domainmod) - [Snipe-IT](snipe-it) -## Backups +### Backups - [Duplicati](duplicati) - [Duplicacy](duplicacy) -## Wiki & Knowledge Base +### Wiki & Knowledge Base - [Bookstack](bookstack) - [Wiki.js](wikijs) - [Answer](answer) - [Obsidian-Remote](obsidian-remote) -## Finance +### Finance - [TRSync](trsync) - [Money-Balancer](money-balancer) - [Firefly III](firefly-iii) -## Communication and Social +### Communication and Social - [Mirotalk WebRTC](mirotalk) - [Rocket.Chat](rocketchat) - [Answer](answer) - [Excalidraw](excalidraw) -## Project Management +### Project Management - [JetBrains YouTrack](youtrack)