Cleanup + update README.md
This commit is contained in:
		
							parent
							
								
									4ca909ca06
								
							
						
					
					
						commit
						85095cdc79
					
				
							
								
								
									
										40
									
								
								README.md
								
								
								
								
							
							
						
						
									
										40
									
								
								README.md
								
								
								
								
							|  | @ -5,28 +5,19 @@ seedbox and personal media server. | ||||||
| ## Credits | ## Credits | ||||||
| Main credits go to [Kelvin Chen](https://github.com/Kelvin-Chen/seedbox) who started the development of its own seedbox using Docker. Mine was first a fork of Kelvin's one, but I made some serious changes in the code and plan to add even more tools and services that keeping this project as a fork started to have less sense as code diverged. | Main credits go to [Kelvin Chen](https://github.com/Kelvin-Chen/seedbox) who started the development of its own seedbox using Docker. Mine was first a fork of Kelvin's one, but I made some serious changes in the code and plan to add even more tools and services that keeping this project as a fork started to have less sense as code diverged. | ||||||
| 
 | 
 | ||||||
| ## Accessing a Service's Web Interface |  | ||||||
| Go to `x.hostname` where `x` is the service you want to access. |  | ||||||
| Included services are: |  | ||||||
| - deluge |  | ||||||
| - sonarr |  | ||||||
| - jackett |  | ||||||
| - plex |  | ||||||
| - h5ai (service accessible via `explore.hostname`) |  | ||||||
| - radarr |  | ||||||
| 
 |  | ||||||
| ## Included Applications | ## Included Applications | ||||||
| | Application          | Web Interface            | | | Application          | Web Interface              | | ||||||
| -----------------------|--------------------------| | -----------------------|----------------------------| | ||||||
| | Organizr             | yourdomain.com           | | | Plex                 | plex.yourdomain.com        | | ||||||
| | Plex                 | plex.yourdomain.com      | | | Deluge               | deluge.yourdomain.com      | | ||||||
| | Deluge               | deluge.yourdomain.com    | | | Sonarr               | sonarr.yourdomain.com      | | ||||||
| | Sonarr               | sonarr.yourdomain.com    | | | Radarr               | radarr.yourdomain.com      | | ||||||
| | Radarr               | radarr.yourdomain.com    | | | Bazaar               | bazaar.yourdomain.com      | | ||||||
| | Filerun              | explore.yourdomain.com   | | | Jackett              | jackett.yourdomain.com     | | ||||||
| | Tautulli  (plexPy)   | tautulli.yourdomain.com  | | | JDownloader          | jdownloader.yourdomain.com | | ||||||
| | Portainer            | portainer.yourdomain.com | | | Filerun              | explore.yourdomain.com     | | ||||||
| | Jackett              | jackett.yourdomain.co    | | | Tautulli (plexPy)    | tautulli.yourdomain.com    | | ||||||
|  | | Portainer            | portainer.yourdomain.com   | | ||||||
| 
 | 
 | ||||||
| The front-end reverse proxy (Traefik) routes based on the lowest level subdomain (e.g. | The front-end reverse proxy (Traefik) routes based on the lowest level subdomain (e.g. | ||||||
| `deluge.example.com` would route to deluge). Since this is how the router | `deluge.example.com` would route to deluge). Since this is how the router | ||||||
|  | @ -49,6 +40,7 @@ through the reverse proxy. | ||||||
| Before running, please create the volumes which will be statically mapped to the ones on the host: | Before running, please create the volumes which will be statically mapped to the ones on the host: | ||||||
| ```sh | ```sh | ||||||
| $ sudo su -c "cd /; mkdir data; cd data; mkdir config; mkdir torrents" | $ sudo su -c "cd /; mkdir data; cd data; mkdir config; mkdir torrents" | ||||||
|  | $ sudo ./init-traefik.sh | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| ## Running | ## Running | ||||||
|  | @ -61,12 +53,12 @@ does not, verify that your docker and docker-compose version is updated. | ||||||
| Make sure you install the dependencies and finish configuration before doing | Make sure you install the dependencies and finish configuration before doing | ||||||
| this. | this. | ||||||
| 
 | 
 | ||||||
| You may optionally build the images yourself instead of pulling by running |  | ||||||
| `./build-all.sh`. |  | ||||||
| 
 |  | ||||||
| ## Configuration | ## Configuration | ||||||
| Copy the `.env.sample` file to `.env` and change the variables as desired. | Copy the `.env.sample` file to `.env` and change the variables as desired. | ||||||
| The variables are all self-explanatory. | The variables are all self-explanatory. | ||||||
|  | Sames goes for `tunnel-options.sh.sample` which will enable the `open-tunnel.sh` | ||||||
|  | script to open a tunnel with port forwarding in order to access Plex Tools directly in | ||||||
|  | your browser. | ||||||
| 
 | 
 | ||||||
| ## PlexPass | ## PlexPass | ||||||
| More info soon. | More info soon. | ||||||
|  |  | ||||||
|  | @ -26,7 +26,6 @@ services: | ||||||
|             - torrents:/torrents |             - torrents:/torrents | ||||||
|             - configdeluge:/config |             - configdeluge:/config | ||||||
|             - downloads:/downloads |             - downloads:/downloads | ||||||
|             - flooddl:/downloads |  | ||||||
|         environment: |         environment: | ||||||
|             - PGID=0 |             - PGID=0 | ||||||
|             - PUID=0 |             - PUID=0 | ||||||
|  | @ -145,7 +144,6 @@ services: | ||||||
|         volumes: |         volumes: | ||||||
|             - configsonarr:/config |             - configsonarr:/config | ||||||
|             - torrents:/torrents |             - torrents:/torrents | ||||||
|             - flooddl:/downloads |  | ||||||
|             - /etc/localtime:/etc/localtime:ro |             - /etc/localtime:/etc/localtime:ro | ||||||
|         environment: |         environment: | ||||||
|             - PGID=0 |             - PGID=0 | ||||||
|  | @ -165,7 +163,6 @@ services: | ||||||
|             - web |             - web | ||||||
|         volumes: |         volumes: | ||||||
|             - config:/config |             - config:/config | ||||||
|             - flooddl:/downloads |  | ||||||
|             - movies:/movies |             - movies:/movies | ||||||
|             - torrents:/torrents |             - torrents:/torrents | ||||||
|             - /etc/localtime:/etc/localtime:ro |             - /etc/localtime:/etc/localtime:ro | ||||||
|  | @ -198,36 +195,6 @@ services: | ||||||
|             - 'traefik.frontend.auth.basic.users=${HTTP_USER}:${HTTP_PASSWORD}' |             - 'traefik.frontend.auth.basic.users=${HTTP_USER}:${HTTP_PASSWORD}' | ||||||
|             - 'traefik.enable=true' |             - 'traefik.enable=true' | ||||||
| 
 | 
 | ||||||
|     # flood: |  | ||||||
|     #     image: romancin/rutorrent-flood |  | ||||||
|     #     restart: always |  | ||||||
|     #     tty: true |  | ||||||
|     #     networks: |  | ||||||
|     #         - web |  | ||||||
|     #     ports: |  | ||||||
|     #         - "51415:51415" |  | ||||||
|     #         - "6881:6881" |  | ||||||
|     #     volumes: |  | ||||||
|     #         - configflood:/config |  | ||||||
|     #         - flooddl:/downloads |  | ||||||
|     #         - torrents:/torrents |  | ||||||
|     #     environment: |  | ||||||
|     #         - PGID=0 |  | ||||||
|     #         - PUID=0 |  | ||||||
|     #         - TZ=Europe/Paris |  | ||||||
|     #     labels: |  | ||||||
|     #         - 'traefik.enable=true' |  | ||||||
|     #         - 'traefik.flood.frontend.backend=flood' |  | ||||||
|     #         - 'traefik.flood.port=3000' |  | ||||||
|     #         - 'traefik.flood.frontend.rule=Host:flood.${TRAEFIK_DOMAIN}' |  | ||||||
|     #         - 'traefik.flood.frontend.auth.basic.users=${HTTP_USER}:${HTTP_PASSWORD}' |  | ||||||
|     #         - 'traefik.flood.protocol=https' |  | ||||||
|     #         - 'traefik.rutorrent.frontend.backend=flood' |  | ||||||
|     #         - 'traefik.rutorrent.port=443' |  | ||||||
|     #         - 'traefik.rutorrent.frontend.rule=Host:rutorrent.${TRAEFIK_DOMAIN}' |  | ||||||
|     #         - 'traefik.rutorrent.frontend.auth.basic.users=${HTTP_USER}:${HTTP_PASSWORD}' |  | ||||||
|     #         - 'traefik.rutorrent.protocol=https' |  | ||||||
| 
 |  | ||||||
|     tautulli: |     tautulli: | ||||||
|         image: linuxserver/tautulli |         image: linuxserver/tautulli | ||||||
|         restart: always |         restart: always | ||||||
|  | @ -305,18 +272,10 @@ volumes: | ||||||
|         driver: local-persist |         driver: local-persist | ||||||
|         driver_opts: |         driver_opts: | ||||||
|             mountpoint: /data/config/tautulli |             mountpoint: /data/config/tautulli | ||||||
|     configflood: |  | ||||||
|         driver: local-persist |  | ||||||
|         driver_opts: |  | ||||||
|             mountpoint: /data/config/flood |  | ||||||
|     configjdownloader: |     configjdownloader: | ||||||
|         driver: local-persist |         driver: local-persist | ||||||
|         driver_opts: |         driver_opts: | ||||||
|             mountpoint: /data/config/jdownloader |             mountpoint: /data/config/jdownloader | ||||||
|     flooddl: |  | ||||||
|         driver: local-persist |  | ||||||
|         driver_opts: |  | ||||||
|             mountpoint: /data/torrents/flood |  | ||||||
|     torrents: |     torrents: | ||||||
|         driver: local-persist |         driver: local-persist | ||||||
|         driver_opts: |         driver_opts: | ||||||
|  |  | ||||||
		Loading…
	
		Reference in New Issue