mathdatech/Compose-Examples
1
0
Fork 0
mirror of https://github.com/Haxxnet/Compose-Examples synced 2025-01-18 23:37:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
improve readme
This commit is contained in:
LRVT 2023-02-21 09:49:11 +01:00 committed by GitHub
parent ff4cfa9c0a
commit 99ce74a74f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 50 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
README.md
View File

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