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, 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! This is how all images should be documented! But unfortunately, it isn't!
Sometimes you have to spend a lot of time to make it work.
Hence - this repo.
The aims is to provide a ready-to-run recipes that you can just copy, paste and run.
So, without further ado, here's the current list:

General Information

• How to setup docker & docker-compose?
• How to use docker-compose
• Troubleshooting

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] (external links).

Ad Blockers & local DNS

• AdGuard Home
• PiHole
• Block Lists

Antivirus

• MalwareMultiScan [external]

Blogging

• AnchorCMS [external]
• Ghost [external]
• Hugo [external]
• Kirby [external]
• Metalsmith [external]
• Pagekit [external]
• Pelican [external]
• PostLeaf [external]
• Textpattern [external]
• WriteFreely [external]

Bookmarks & Read Later

• Shaarli
• Shiori
• Shaark
• Wallabag

Other

• Nunux Keeper [external] - similar to wallabag, but not as good (more complicated, less usable and doesn't have mobile apps).

Cloud & File Sharing

• FileRun
• NextCloud
• Pydio
• Seafile

Dashboard

• DashMachine
• Homer
• SUI
• Organizr [external]
• Heimdall [external]

Docker Managers

• Diun
• WatchTower

Download Managers

• Deluge
• qbittorrent
• Transmission

E-mail

• CLIENTS (webmail)
  • Roundcube
  • Rainloop [external]
  • Rainloop in MailCow [external]
  • Mailpile [external]
  • WebMail Lite [external]
  • Cypht [external]
  • Cypht docker [external]
• SERVERS
  • Mailcow
  • Mailu [external]
    • Can't send from roundcube as e.g. username@gmail.com
  • Mail-in-a-box [external]
  • Mailcare [external]
    • open source disposable email address service.
  • Poste.io [external]
    • doesn't allow fetching from other imap servers
    • keeps pushing the pro version
  • Wildduck [external]
    • has app passwords
    • doesn't seem to have contacts or other stuff (unless you'd use e.g. Roundcube)
• Hosted e-mail providers
• SMTP Relays
• Anonymous emails - not self-hosted but important for privacy
  • Reddit Thread [external]
  • burnermail.io [external]
  • anonaddy.com [external]
  • simplelogin.io [external]
  • simplelogin.io github repo [external]
• Tools
  • verify domain for google [external]
  • remove IP from spam house [external]
  • check dns & reverse dns [external]
  • reverse-dns-check [external]
  • DNS Records checker [external]
  • Domain security checker [external]

Home Automation

• HomeAssistant
• Huginn [external]
• Node-RED [external]

Media Managers

• Bazarr (subtitles)
• Calibre (e-books)
• Deemix
• Jackett (search engine proxy/adapter)
• Komga (comics)
• Navidrome
• Radarr (movies)
• Readerr (ebooks & comics)
• Sonarr (tv shows)
• Tautulli
• Ubooquity [external] - Another Ebook & Comics server. Didn't work properly.
• Youtube downloader

Monitors

Self-hosted

• Cachet
• Dockprom
• PhpServerMonitor
• Statping

Other, not-fully tested

• Staytus [external] - service status is updated manually!
• cstate [external] - weird...
• Glances [external] - resource hog
• Netdata [external] - lots of stuff, nothing relevant
• LibreNMS [external] - ugly

Hosted

• statuspage.io [external] - same - manual process!
• updown [external] - doesn't seem to have a page with multiple services' statuses...
• healthchecks [external] - cron-based monitoring, no public status page, just badges
• uptimerobot [external] - free is very basic, constantly nags for upgrade to paid...

Useful links

• awesome-sysadmin: monitoring
• reddit thread
• reddit thread

Notifications

• Notifiers by service - comparison table
• Pushover
• Synology-sms-relay

Other

• apprise [external]
• Synapse [external]
• Gotify [external] - notification server
• pushover [external]
• unifi event monitor [external]

Photos

• Comparison table
• PhotoPrism
• PhotoView
• Piwigo
• Pixelfed

Other tested

• Chevereto [external] - quite nice. No video support.
• Lychee [external] - good looking, no video support.
• PhotoShow [external] - seems dead and doesn't work.
• Photosync [external] - paid, app, not really self-hosted, just sync.
• OwnPhotos [external] - limited features, ugly & dead.
• FileStash [external] - old-time-dropbox-like file manager.

Untested

• pigallery2 [external] - minimal feats
• photostructure [external] - too early
• picapport [external] - weird

Project Management

• Jira
• Kanboard
• OpenProject
• Planka
• Vikunja
• Wekan
• Taskcafe [external] - early stage, active development.
• YouTrack [external] - The project management tool designed for agile teams (from JetBrains).

Reverse proxy & SSO

• Authelia
• Traefik
• Caddy [external] - very good web server with reverse-proxy & automatic https.
• Nginx Proxy Manager [external] - another nice solution based on the battle-tested & probably the most popular web-server - nginx. It has a pretty UI that allows to manage the services.

RSS

• Miniflux
• Miniflux-filter
• FreshRSS [external] - second best :-)

RSS Tools

• PolitePol [external] - Create RSS where there was none
• FetchRSS [external] - Create RSS for FB, Twitter, YT, and websites
• rss-bridge [external] - The RSS feed for websites missing it
• rss2full [external] - Transform summary feeds into full-text

Search engines

• Searx
• Whoogle

Social

• Monica
• Etesync

Other untested

• HumHub [external] - Free social network software and framework.
• RocketChat [external] - The Ultimate Communication Hub.
• Snikket [external] - Chat that is simple, secure, and private.
• Jami [external] - Audio & video calls, screen sharing, IM.

Wiki

• Confluence
• Bookstack
• Wiki.js
• XWiki

Other

• Pepperminty Wiki [external] - wiki engine contained in a single file. Doesn't seem to have a structured navigation (tree-like menu). Subpages are supported though.
• Wreeto [external] - impossible to install
• Outline [external] (Original docker was impossible to use. This one allegedly works.) - It looks cool, but requires Slack to use...
• Gollum [external] - A simple, Git-powered wiki with a sweet API and local frontend.