self-hosted-cookbook/README.md

# Self-hosted Cookbook

If you're like me and love not only to self-host, but to constantly test new apps, you probably already discovered `docker-compose` as the fastest and easiest way towards that goal.
There is, however, one problem: not all image authors are as great as [linuxserver.io](https://hub.docker.com/u/linuxserver), whose docs are as simple as they should be: you just copy & paste `docker-compose.yml` and run `docker-compose up -d` and IT JUST WORKS!<br>
This is how all images should be documented!<br>
But unfortunately, it isn't!<br>
Sometimes you have to spend a lot of time to make it work.<br>
Hence - this repo.<br>
The aims is to provide a ready-to-run recipes that you can just copy, paste and run.



# How to use this cookbook
- There are certain things that some recipes need which cannot be filled in due to security reasons.
  - `example.com` needs to be replaced with your own domain
  - `username`, `password`, etc. - should be replaced by your username & password
  - keys (like `APP_KEY`, `SECRET` etc.) should be regenerated using e.g. `openssl rand -base64 32`
- Not all apps have been tested & described. These are marked as 🔗 (external links).



# General Information
- [Get started with docker & docker-compose](docker/get-started.md)
- [Troubleshooting](docker/troubleshooting.md)



# Other self-hosted sources
- [awesome-selfhosted](https://github.com/awesome-selfhosted/awesome-selfhosted)
- [r/selfhosted](https://www.reddit.com/r/selfhosted/)
- [Homelab OS](https://homelabos.com/docs/#available-software)
- [Gardens self-hosted tools](https://joingardens.com/tools)



# Ad Blockers & local DNS
- [AdGuard Home](apps/ad-blockers/adguard.md)
- [PiHole](apps/ad-blockers/pihole.md)
- [Block Lists](apps/ad-blockers/lists.md)



# Analytics
- [Matomo](apps/analytics/matomo.md)
- [Plausible](apps/analytics/plausible.md)
- [Swetrix](https://docs.swetrix.com/selfhosting/how-to) 🔗
- [Umami](apps/analytics/umami.md)



# Antivirus
- [MalwareMultiScan](https://github.com/mindcollapse/MalwareMultiScan) 🔗



# Backup
- [Duplicati](apps/backup/duplicati.md)
- [Elkar Backup](apps/backup/elkar-backup.md)
- [websync](https://furier.github.io/websync/) 🔗 - an rsync task manager, where tasks can be added, scheduled and maintained in a sane manner



# Blogging & CMS
- [Ghost](apps/cms/ghost.md)
- [Wordpress](apps/cms/wordpress.md)

### Other (not tested)
- [AnchorCMS](https://github.com/anchorcms/anchor-cms#installation) 🔗
- [Bludit](https://www.bludit.com) 🔗 - Simple, Fast, Secure, Flat-File CMS.
- [Grav](https://getgrav.org) 🔗 - modern open source flat-file CMS.
- [Hugo](https://gohugo.io/) 🔗
- [Kirby](https://getkirby.com/) 🔗
- [Metalsmith](https://metalsmith.io/) 🔗
- [Pagekit](https://pagekit.com/docs/getting-started/installation) 🔗
- [Pelican](https://docs.getpelican.com/en/stable/quickstart.html#installation) 🔗 - Static Site Generator.
- [PostLeaf](https://www.postleaf.org/installing) 🔗
- [Textpattern](https://docs.textpattern.com/installation/) 🔗
- [WriteFreely](https://github.com/writeas/writefreely) 🔗


# Bookmarks & Read Later
- [Benotes](https://github.com/fr0tt/benotes) 🔗 - An open source self-hosted notes and bookmarks taking web app.
- [Cherry](apps/bookmarks/cherry.md)
- [Hoarder](apps/bookmarks/hoarder.md)
- [LinkAce](apps/bookmarks/linkace.md)
- [Linkding](apps/bookmarks/linkding.md)
- [linkwarden](https://linkwarden.app/) 🔗 - Another source self-hosted bookmarks manager.
- [Shaarli](apps/bookmarks/shaarli.md)
- [Shiori](apps/bookmarks/shiori.md)
- [Shaark](apps/bookmarks/shaark.md)
- [Wallabag](apps/bookmarks/wallabag.md)


### Other
- [Nunux Keeper](https://keeper.nunux.org/) 🔗 - similar to wallabag, but not as good (more complicated, less usable and doesn't have mobile apps).
- [Reminescence](https://github.com/kanishka-linux/reminiscence#using-docker) 🔗 - Clean and simple. Has a DIY-Docker-Image. Buggy (archiving doesn't work half of the time).



# Cloud & File Sharing
- [Filebrowser](apps/cloud/filebrowser.md)
- [FileRun](apps/cloud/filerun.md)
- [NextCloud](apps/cloud/nextcloud.md)
- [oasis](apps/cloud/oasis.md)
- [Pydio](apps/cloud/pydio.md)
- [Seafile](apps/cloud/seafile.md)
- [Nginx-WebDav](apps/cloud/nginx-webdav.md)


# Contacts - calendars
- [Baikal](apps/contacts-calendars/baikal.md)
- [Radicale](apps/contacts-calendars/radicale.md)

# Cookbook
- [NextCloud Cookbook](https://apps.nextcloud.com/apps/cookbook) 🔗 - quite good. Can import from URL (some pages), but manually editing longer recipes is a bit of a pain (you need to add and paste every single ingredient & preparation step one-by-one).
- [Mealie](apps/cookbook/mealie.md)
- [recipes](https://github.com/vabene1111/recipes) 🔗 - a bit complex, but feature rich food processing manager for your home (from shopping to the table). Importing doesn't seem to work as good as in the NextCloud's Cookbook (for some pages at least).



# Dashboard
- [DashMachine](apps/dashboard/dashmachine.md)
- [Flame](apps/dashboard/flame.md)
- [Homarr](apps/dashboard/homarr.md)
- [Homer](apps/dashboard/homer.md)
- [SUI](apps/dashboard/sui.md)
- [Organizr](https://github.com/causefx/Organizr) 🔗
- [Heimdall](https://github.com/linuxserver/Heimdall) 🔗
- [Mafl](apps/dashboard/mafl.md)



# Database
- [baserow](apps/database/baserow.md)
- [budibase](apps/other/budibase.md)
- [SeaTable](apps/database/seatable.md)
- [Dataspread](https://dataspread.github.io) 🔗 - combines the intuitiveness and flexibility of spreadsheets and the scalability and power of databases.
- [Hue](https://docs.gethue.com/quickstart/) 🔗 - open source SQL Assistant for Databases.
- [NocoDB](apps/database/nocodb.md) - Open Source Airtable Alternative - turns a DB into a Spreadsheet with API.



# Docker Managers
- [Diun](apps/docker/diun.md)
- [Doku](apps/docker/doku.md) - docker disk usage
- [Portainer](apps/docker/portainer.md)
- [WatchTower](apps/docker/watch-tower.md)



# Document Managers
- [paperless-ngx](apps/documents/paperless-ngx.md)
- [Papermerge](https://www.papermerge.com) 🔗 - document manager with tags & searches.
- [DocSpell](https://docspell.org/) 🔗 - simple document organizer.


# Download Managers
- [Deluge](apps/downloads/deluge.md)
- [qbittorrent](apps/downloads/qbit.md)
- [SimpleTorrent](apps/downloads/simple-torrent.md)
- [Transmission](apps/downloads/transmission.md)


# E-mail
- CLIENTS (webmail)
  - [Roundcube](apps/email/roundcube.md)
  - [Rainloop](http://www.rainloop.net/) 🔗
  - [Rainloop in MailCow](https://github.com/mailcow/mailcow-dockerized/issues/613) 🔗
  - [Mailpile](https://www.mailpile.is/) 🔗
  - [WebMail Lite](https://afterlogic.com/docs/webmail-lite-8/installation) 🔗
  - [Cypht](https://cypht.org/) 🔗
  - [Cypht docker](https://hub.docker.com/r/sailfrog/cypht-docker) 🔗
- SERVERS
  - [Mailcow](apps/email/mailcow.md)
  - [Mailu](https://github.com/Mailu/Mailu) 🔗 - Can't send from roundcube as e.g. `username@gmail.com`
  - [Mail-in-a-box](https://mailinabox.email/) 🔗
  - [Mailcare](https://gitlab.com/mailcare/mailcare) 🔗 - open source disposable email address service.
  - [Poste.io](https://poste.io/doc/getting-started) 🔗 - doesn't allow fetching from other imap servers, keeps pushing the pro version
  - [Wildduck](https://wildduck.email/#/) 🔗 - has app passwords, doesn't seem to have contacts or other stuff (unless you'd use e.g. Roundcube)
- SMTP Relays
  - [SMTP2Go](https://www.smtp2go.com/pricing/) 🔗 - Free: 1k/month
  - [Mailgun](https://www.mailgun.com/pricing/) 🔗 - PAYG: $8/10k/month
  - [Sendgrid](https://sendgrid.com/pricing/) 🔗 - Free 100/day
  - [MailJet](https://www.mailjet.com/pricing/) 🔗 - Free 6k/month
- Anonymous emails - not self-hosted but important for privacy
  - [Reddit Thread](https://www.reddit.com/r/selfhosted/comments/isu8mw/selfhosted_throw_away_email_addresses_that_allow/) 🔗
  - [burnermail.io](https://burnermail.io/) 🔗
  - [anonaddy.com](https://anonaddy.com/#pricing) 🔗
  - [simplelogin.io](https://simplelogin.io/) 🔗
  - [simplelogin.io github repo](https://github.com/simple-login/app) 🔗
  - [Forward Email](https://forwardemail.net/en) 🔗 - Unlimited email addresses, custom domain, catch-all, wildcard, and disposable aliases (has free and paid plans).
- Tools
  - [verify domain for google](https://postmaster.google.com/managedomains) 🔗
  - [remove IP from spam house](https://www.spamhaus.org/lookup/) 🔗
  - [check dns & reverse dns](https://mxtoolbox.com/) 🔗
  - [reverse-dns-check](https://www.debouncer.com/reverse-dns-check) 🔗
  - [DNS Records checker](https://www.digwebinterface.com/) 🔗
  - [Domain security checker](https://www.hardenize.com/) 🔗



# GIT
- [Gitea](apps/git/gitea.md)
- [GitLab](https://about.gitlab.com/) 🔗
- [Gogs](https://gogs.io/) 🔗
- [Phabricator](https://secure.phabricator.com/book/phabricator/article/configuration_guide/) 🔗



# Home Automation
- [HomeAssistant](apps/home-automation/home-assistant.md)
- [Homebridge](apps/home-automation/homebridge.md)
- [Beehive](https://github.com/muesli/beehive) 🔗 - flexible event/agent & automation system
- [Huginn](https://github.com/huginn/huginn) 🔗 - Create agents that monitor and act on your behalf.
- [Node-RED](https://nodered.org/) 🔗 - Low-code programming for event-driven applications
- [Kibitzr](https://kibitzr.github.io/) 🔗 - Personal Web Assistant



# Media Managers
- [Alternatrr](https://github.com/TheUltimateC0der/alternatrr) 🔗 - alternative titles for Sonarr
- [Audiobookshelf](apps/media/audiobookshelf.md) - audiobooks
- [Bazarr](apps/media/bazarr.md) - subtitles
- [Calibre](apps/media/calibre.md) - e-books
- [Deemix](apps/media/deemix.md) - music
- [Jackett](apps/media/jackett.md) - search engine proxy/adapter
- [Jellyfin](apps/media/jellyfin.md) - watch movies & shows almost everywhere!
- [Kavita](apps/media/kavita.md) - like plex for ebooks & comics
- [Komga](apps/media/komga.md) - comics
- [Navidrome](apps/media/navidrome.md) - music streaming server
- [Plex](apps/media/plex.md) - watch movies & shows everywhere!
- [Radarr](apps/media/radarr.md) - movies
- [Readerr](apps/media/readerr.md) - ebooks & comics
- [Sonarr](apps/media/sonarr.md) - tv shows
- [Tautulli](apps/media/tautulli.md) - dashboard for Plex
- [Ubooquity](http://vaemendis.net/ubooquity) 🔗 - another Ebook & Comics server. Didn't work properly.



### Apps for Youtube
- [Invidious](apps/media/invidious.md) - Privacy-focused YT Proxy interface
- [Metube](apps/media/metube.md) - youtube-dl webUI
- [TubeArchivist](apps/media/tubearchivist.md) - youtube-dlp - based
- [YoutubeDL-web](apps/media/youtubedl-web.md) - youtube-dl webUI
- [YoutubeDL-material](apps/media/youtubedl-material.md) - youtube-dl webUI



# Monitors

### Self-hosted
- [Cachet](apps/monitors/cachet.md)
- [CheckMK](apps/monitors/checkmk.md)
- [Dockprom](apps/monitors/dockprom.md)
- [Uptime Kuma](apps/monitors/uptime-kuma.md)
- [PhpServerMonitor](apps/monitors/php-server-monitor.md)
- [Statping](apps/monitors/statping.md)
- [Monocker](apps/monitors/monocker.md)


### Other, not-fully tested
- [Staytus](https://github.com/adamcooke/staytus) 🔗 - service status is updated manually!
- [cstate](https://cstate.mnts.lt/) 🔗 - weird...
- [Glances](https://glances.readthedocs.io/en/stable/install.html) 🔗 - resource hog
- [Netdata](https://hub.docker.com/r/netdata/netdata) 🔗 - lots of stuff, nothing relevant
- [LibreNMS](https://github.com/librenms/docker) 🔗 - ugly



### Useful links
- [awesome-sysadmin: monitoring](https://github.com/n1trux/awesome-sysadmin#monitoring)
- [reddit thread](https://www.reddit.com/r/selfhosted/comments/epzt3f/im_looking_for_a_lean_monitoring_and_altert/)
- [reddit thread](https://www.reddit.com/r/selfhosted/comments/gwe18p/looking_for_a_neat_status_page_like/)



# Notes
- [Joplin Server](apps/notes/joplin.md)
- [Joplin WebView](apps/notes/joplin-web.md)
- [Memos](apps/notes/memos.md)



# Notifications
- [Notifiers by service](apps/notifications/notifiers-by-service.md) - comparison table
- [Pushover](apps/notifications/pushover.md)
- [Synology-sms-relay](apps/notifications/synology-sms-relay.md)
- [Synology-notifications](https://github.com/ryancurrah/synology-notifications) 🔗 - similar to the above - works with Slack (and potentially Discord)

### Other
- [apprise](https://github.com/caronc/apprise) 🔗
- [Synapse](https://github.com/matrix-org/synapse#synapse-installation) 🔗
- [Gotify](https://github.com/gotify/server) 🔗 - notification server
- [pushover](https://pushover.net/) 🔗
- [unifi event monitor](https://github.com/tborychowski/unifi-event-monitor) 🔗



# Other services
- [bitwarden_rs](apps/other/bitwarden.md)
- [Brave sync server](apps/other/brave-sync.md)
- [change-detection](apps/other/change-detection.md)
- [Cockpit](apps/other/cockpit.md)
- [Code server](apps/other/code.md)
- [Crowdsec](apps/other/crowdsec.md)
- [Firefox sync server](apps/other/firefox-sync.md)
- [Firefox](apps/other/firefox.md)
- [LanguageTool server](apps/other/language-tool.md)
- [Ntfy](apps/other/ntfy.md)
- [OpenSpeedTest](apps/other/openspeedtest.md)
- [Owntracks location tracker](apps/other/owntracks.md)
- [Penpot](apps/other/penpot.md)
- [Traccar location tracker](apps/other/traccar.md)
- [VPN client](apps/other/vpn.md)
- [Windows](apps/other/windows.md)

# Photos
- [Comparison table](apps/photos/comparison.md)
- [Chevereto](apps/photos/chevereto.md)
- [LibrePhotos](apps/photos/libre-photos.md)
- [Lychee](apps/photos/lychee.md)
- [Pigallery2](apps/photos/pigallery.md)
- [Piwigo](apps/photos/piwigo.md)
- [Pixelfed](apps/photos/pixelfed.md)
- [PhotoPrism](apps/photos/photoprism.md)
- [PhotoStructure](apps/photos/photostructure.md)
- [PhotoView](apps/photos/photoview.md)

### Other tested
- [PhotoShow](https://github.com/thibaud-rohmer/PhotoShow/) 🔗 - seems dead and doesn't work.
- [Photosync](https://www.photosync-app.com/home.html) 🔗 - paid, app, not really self-hosted, just sync.
- [OwnPhotos](https://github.com/hooram/ownphotos) 🔗 - limited features, ugly & dead.
- [FileStash](https://github.com/mickael-kerjean/filestash) 🔗 - old-time-dropbox-like file manager.

### Untested
- [picapport](https://www.picapport.de/en/index.php) 🔗 - weird
- [immich](https://github.com/immich-app/immich) 🔗 - a new kid, very promising and cool looking!



# Project Management
- [Jira](apps/project-mgmt/jira.md)
- [Kanboard](apps/project-mgmt/kanboard.md)
- [OpenProject](apps/project-mgmt/open-project.md)
- [Planka](apps/project-mgmt/planka.md)
- [Vikunja](apps/project-mgmt/vikunja.md)
- [Wekan](apps/project-mgmt/wekan.md)
- [Taskcafe](https://github.com/JordanKnott/taskcafe) 🔗 - early stage, active development.
- [YouTrack](https://www.jetbrains.com/youtrack/) 🔗 - The project management tool designed for agile teams (from JetBrains).



# Reverse proxy & SSO
- [Authelia](apps/reverse-proxy-sso/authelia.md)
- [Caddy](https://caddyserver.com/) 🔗 - very good web server with reverse-proxy & automatic https.
- [lldap](https://github.com/nitnelave/lldap/) 🔗 - simple ldap implementation with a nice UI.
- [nginx-proxy-manager](apps/reverse-proxy-sso/npm.md)
- [Traefik](apps/reverse-proxy-sso/traefik.md)




# RSS
 - [Miniflux](rss/../apps/rss/miniflux.md)
 - [Miniflux-filter](rss/../apps/rss/miniflux-filter.md)
 - [FreshRSS](https://www.freshrss.org/) 🔗 - second best :-)
 - [RSS to telegram bot](apps/rss/rsstt.md)

### RSS Tools
- [PolitePol](https://github.com/taroved/pol) 🔗 - Create RSS where there was none
- [FetchRSS](https://fetchrss.com/) 🔗 - Create RSS for FB, Twitter, YT, and websites
- [rss-bridge](apps/rss/rssbridge.md)- The RSS feed for websites missing it
- [rss2full](https://github.com/feedocean/rss2full) 🔗 - Transform summary feeds into full-text
- [rsshub](apps/rss/rsshub.md) - Create RSS feeds from almost everything



# Search engines
- [librex](https://github.com/hnhx/librex) 🔗 - Simple meta search engine for google & torrents
- [Searx](apps/search/searx.md)
- [Whoogle](apps/search/whoogle.md)



# Social
- [Etesync](apps/social/etesync.md)
- [Monica](apps/social/monica.md)
- [Mastodon](apps/social/mastodon.md)

### Other untested
- [HumHub](https://www.humhub.com/en) 🔗 - Free social network software and framework.
- [RocketChat](https://docs.rocket.chat/installation/docker-containers/) 🔗 - The Ultimate Communication Hub.
- [Snikket](https://snikket.org/) 🔗 - Chat that is simple, secure, and private.
- [Jami](https://jami.net/) 🔗 - Audio & video calls, screen sharing, IM.



# Wiki
- [Bluespice free](apps/wiki/bluespice.md)
- [Bookstack](apps/wiki/bookstack.md)
- [Confluence](apps/wiki/confluence.md)
- [Docmost](apps/wiki/docmost.md)
- [Notea](apps/wiki/notea.md)
- [Wiki.js](apps/wiki/wikijs.md)
- [XWiki](apps/wiki/xwiki.md)

### Other
- [Pepperminty Wiki](https://peppermint.mooncarrot.space/) 🔗 - wiki engine contained in a single file. Doesn't seem to have a structured navigation (tree-like menu). Subpages are supported though.
- [Wreeto](https://github.com/chrisvel/wreeto_official) 🔗 - impossible to install
- [Outline](https://github.com/chsasank/outline-wiki-docker-compose) 🔗 (Original docker was impossible to use. This one allegedly works.) - It looks cool, but requires Slack to use...
- [Gollum](https://github.com/gollum/gollum) 🔗 - A simple, Git-powered wiki with a sweet API and local frontend.