From 1b116aa8c2e2b38b4cde235f87d8445f09c3413f Mon Sep 17 00:00:00 2001 From: Jean Froment Date: Thu, 30 Apr 2020 10:43:43 +0200 Subject: [PATCH] Improve README, cleanup details --- README.md | 37 +++++++++++++++++++------------------ clean-fs.sh | 2 ++ docker-compose.yml | 1 - 3 files changed, 21 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 0945422..23f6694 100644 --- a/README.md +++ b/README.md @@ -5,24 +5,25 @@ seedbox and personal media server. ## Included Applications -| Application | Web Interface | ------------------------|----------------------------| -| Plex | plex.yourdomain.com | -| Deluge | deluge.yourdomain.com | -| Sonarr | sonarr.yourdomain.com | -| Radarr | radarr.yourdomain.com | -| Bazarr | bazarr.yourdomain.com | -| Lidarr | lidarr.yourdomain.com | -| Jackett | jackett.yourdomain.com | -| JDownloader | jdownloader.yourdomain.com | -| Tautulli (plexPy) | tautulli.yourdomain.com | -| NextCloud | nextcloud.yourdomain.com | -| Portainer | portainer.yourdomain.com | -| Netdata | netdata.yourdomain.com | -| Duplicati | duplicati.yourdomain.com | +| Application | Web Interface | Docker image | Version (image tag) | Notes | +-----------------------|----------------------------|------------------------------------------------------------------------|-------------------------|---------------------| +| Plex | plex.yourdomain.com | [linuxserver/plex](https://hub.docker.com/r/linuxserver/plex) | *latest* | Media Streaming | +| Deluge | deluge.yourdomain.com | [linuxserver/deluge](https://hub.docker.com/r/linuxserver/deluge) | *latest* | Torrents downloader | +| Sonarr | sonarr.yourdomain.com | [linuxserver/sonarr](https://hub.docker.com/r/linuxserver/sonarr) | *develop* | TV Shows monitor | +| Radarr | radarr.yourdomain.com | [linuxserver/radarr](https://hub.docker.com/r/linuxserver/radarr) | *latest* | Movies monitor | +| Bazarr | bazarr.yourdomain.com | [linuxserver/bazarr](https://hub.docker.com/r/linuxserver/bazarr) | *latest* | Subtitles monitor | +| Lidarr | lidarr.yourdomain.com | [linuxserver/lidarr](https://hub.docker.com/r/linuxserver/lidarr) | *preview* | Music monitor | +| Jackett | jackett.yourdomain.com | [linuxserver/jackett](https://hub.docker.com/r/linuxserver/jackett) | *latest* | Tracker indexer | +| JDownloader | jdownloader.yourdomain.com | [jlesage/jdownloader-2](https://hub.docker.com/r/jlesage/jdownloader-2)| *latest* | Direct downloader | +| Tautulli (plexPy) | tautulli.yourdomain.com | [linuxserver/tautulli](https://hub.docker.com/r/linuxserver/tautulli) | *latest* | Plex stats and admin| +| NextCloud | nextcloud.yourdomain.com | [wonderfall/nextcloud](https://hub.docker.com/r/wonderfall/nextcloud) | *latest* | Files management | +| Portainer | portainer.yourdomain.com | [portainer/portainer](https://hub.docker.com/r/portainer/portainer) | *latest* | Container management| +| Netdata | netdata.yourdomain.com | [netdata/netdata](https://hub.docker.com/r/netdata/netdata) | *latest* | Server monitoring | +| Duplicati | duplicati.yourdomain.com | [linuxserver/duplicati](https://hub.docker.com/r/linuxserver/duplicati)| *latest* | Backups | +| Attestation COVID-19 | attestation.yourdomain.com | [fromenje/attestation-covid-19](https://hub.docker.com/r/fromenje/attestation-covid-19) | *latest* | (France) Attestation de déplacement, mémorise les champs dans le navigateur | -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 +The front-end reverse proxy (Traefik - *version1 **v1.7-alpine***) routes based on the lowest level subdomain + (e.g. `deluge.example.com` would route to deluge). Since this is how the router works, it is recommended for you to get a top level domain. If you do not have one, you can edit your domains locally by changing your hosts file or use a browser plugin that changes the host header. @@ -38,7 +39,7 @@ through the reverse proxy. + Install guidelines for Ubuntu 16.04: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-16-04 - [Docker Compose](https://github.com/docker/compose) >=v1.10.0 + Install guidelines for Ubuntu 16.04: https://www.digitalocean.com/community/tutorials/how-to-install-docker-compose-on-ubuntu-16-04 -- [local-persist Docker plugin](https://github.com/CWSpear/local-persist): installed directly on host (not in container). This is a volume plugin that extends the default local driver’s functionality by allowing you specify a mountpoint anywhere on the host, which enables the files to always persist, even if the volume is removed via `docker volume rm. Use *systemd* install for Ubuntu 16.04. +- [local-persist Docker plugin](https://github.com/CWSpear/local-persist): installed directly on host (not in container). This is a volume plugin that extends the default local driver’s functionality by allowing you specify a mountpoint anywhere on the host, which enables the files to always persist, even if the volume is removed via `docker volume rm`. Use *systemd* install for Ubuntu 16.04. ## Configuration diff --git a/clean-fs.sh b/clean-fs.sh index 2bcf587..cd850a8 100755 --- a/clean-fs.sh +++ b/clean-fs.sh @@ -3,6 +3,8 @@ # Usage: ./clean-fs.sh DIRECTORY # Where DIRECTORY is the path of the directory to clean +##### THIS IS STILL WIP + if [ -z "${1}" ] ;then echo "[$0] Missing DIRECTORY parameter. Exiting..." exit 1 diff --git a/docker-compose.yml b/docker-compose.yml index 4e3a778..3f14f9b 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -42,7 +42,6 @@ services: - 'traefik.enable=true' plex: - #image: linuxserver/plex:1.14.1.5488-cc260c476-ls8 image: linuxserver/plex container_name: plex restart: always