From e323e24a380eaae20158ada01e7c4037c04c012e Mon Sep 17 00:00:00 2001 From: Kieran Wood Date: Fri, 5 May 2023 16:52:00 -0600 Subject: [PATCH] Added mising services to list and added docker network details --- README.md | 70 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 40 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index ddc6892..6589aa5 100644 --- a/README.md +++ b/README.md @@ -10,34 +10,34 @@ Create Docker server and start microservices in minutes with LMDS. What is currently a part of the LMDS Stack: - -
-Numbers after ":" identify a port that particular container will respond on, i.e. Portainer default port is :9000, point your browser it to your server IP adding :9000 at the end i.e. http://192.168.100.100:9000 you will see Portainer login page. +| name| Description | port/access | +|-----|-------------|-------------| +| [Portainer](https://www.portainer.io/)| Web UI Docker Manager | 9000| +| [Sonarr](https://sonarr.tv/)| Content Manager (TV Shows) | 8989 | +| [Medusa](https://pymedusa.com/) | Automatic Video Library Manager for TV Shows | 8081 | +| [Radarr](https://radarr.video/)| Content Manager (Movies) | 7878 | +| [Lidarr](https://lidarr.audio/)| Content Manager (Music) | 8686 | +| [Bazarr](https://www.bazarr.media/)| Subtitles Manager | 6767 | +| [Jackett](https://github.com/Jackett/Jackett)| Torrent Socket | 9117 | +| [Prowlarr](https://prowlarr.com/)| Jackett alternative (dev) | 9696 | +| [Deluge](https://deluge-torrent.org/)| Torrent Client | 8112 | +| [qBittorrent](https://www.qbittorrent.org/)| Torrent Client | 15080 | +| [Transmission](https://transmissionbt.com/)| Torrent Client | 9091 | +| [NZBGet](https://nzbget.net/)| Usenet Client | 6789 | +| [SABznbd](https://sabnzbd.org/)| Usenet Client | 8080 | +| [JellyFin](https://jellyfin.org/)| Media Manager OpenSource | 8096 | +| [Emby](https://emby.media/)| Media Manager | 8096 | +| [Plex](https://www.plex.tv/)| Media Manager | 32400 (go to `/web`) | +| [Ombi](https://github.com/Ombi-app/Ombi)| Plex Requests Server | 3579 | +| [Overseerr](https://github.com/sct/overseerr) | Plex Requests Server | 5055 | +| [EmbyStat](https://github.com/mregni/EmbyStat)| Statistics for emby | 6555 | +| [TVheadend](https://tvheadend.org/)| TV streaming server | 9981 | +| [Pi-Hole](https://pi-hole.net/)| Private DNS sinkhole | 8089 | +| [NPMP](https://greenfrognest.com/LMDSwebServ.php)| NGINX + PHP + riaDB + phpMyAdmin | (Instructions: https://greenfrognest.com/LMDSwebServ.php) | +| [VPN-Client](https://github.com/dperson/openvpn-client)| OpenVPN Gateway | (Instructions: https://greenfrognest.com/LMDSVPN.php) | +| [Traefik 2](https://traefik.io/traefik)| Reverse Proxy | (Instructions: https://greenfrognest.com/LMDSTraefikProxy.php) | + +A port is what you will use to access a given service that particular container will respond on, i.e. Portainer default port is :9000, point your browser it to your server IP adding :9000 at the end i.e. http://192.168.100.100:9000 you will see Portainer login page. ### Raspberry Pi LMDS Server Docker Edition @@ -53,16 +53,19 @@ Blog link: http://greenfrognest.com/lmdsondocker.php Static IP address is not absolutely necessary just to try the project to find out if you like it or not, but in case if you would like to properly utilize pi-hole in your network - you would have to point your router towards RPi IP for DNS resolution and having it static would be mandatory. - install git using a command: -
sudo apt-get install git
+ + 
sudo apt-get install git
- Clone the repository with: -
git clone https://github.com/GreenFrogSB/LMDS.git ~/LMDS
+ + 
git clone https://github.com/GreenFrogSB/LMDS.git ~/LMDS
Do not change name of the folder on your local system it should stay as is for the script to work properly - Enter the directory and run: 
cd ~/LMDS
+ 
./deploy.sh
## Menu @@ -96,3 +99,10 @@ Static IP address is not absolutely necessary just to try the project to find ou ### Backup and Restore LMDS

This option will let you backup LMDS config and store it locally or in the cloud. Local backup is great for small changes that you are not sure of, so you can recover from failure quickly. Backup can be also configured to go in to the cloud i.e. Google Drive, Amazon, DropBox etc. This is great in case you would like to migrate or completely wipeout current SD card but in the same time you would like easily recover LMDS in to new OS installation.

+ +## Notes about docker networking + +By default the script sets everything up with the default bridge networks in docker. So when configuring application communication you **should not** use `localhost`. You need to use different domain names to access the services: + +- Cross-service; Apps that are also part of LMDS that want to talk to other LMDS apps will connect using **the service name** not `localhost`. So when configuring a service that is running LMDS to talk to another LMDS use the service name (whatever it's called in `~/LMDS/docker-compose.yml`). For example to setup prowlarr to talk to sonarr you will need to use `http://prowlarr:9696` and `http://sonarr:8989` **not** `http://localhost:9696` and `http://localhost:8989`. +- Cross-network; Apps that want to communicate across network (on a different device) will need to use the IP or hostname of the raspberry pi to connect. So if you want to connect to prowlarr on port 9696 you can do either `http://:9696` or `http://:9696`