Documentation about CLI

This commit is contained in:
Luc Timmerman
2022-11-23 14:59:42 +01:00
parent b964a8b012
commit 133c367103
2 changed files with 88 additions and 9 deletions

View File

@@ -31,6 +31,12 @@ crash*. It doesn't necessarily mean it will run well on your system ;) It featur
of preference, and you *could* even use both, although this is probably a waste of resources.
## Using
### Using the CLI
To make things easier, a CLI has been developed. First, clone the repository in a directory of your
choosing. You can run it by entering `python main.py` and the CLI will guide you through the
process.
### Manually
1. To get started, clone the repository in a directory of your choosing. **Note: this will be where
your installation and media will be as well, so think about this a bit.**
2. Copy `.env.sample` to a real `.env` by running `$ cp .env.sample .env`.

View File

@@ -10,8 +10,8 @@ services:
- UMASK=002
- TZ=Europe/Amsterdam
volumes:
- /home/luctia/detering/config/sonarr-config:/config
- /home/luctia/detering/data:/data
- /home/user/ezarr/config/sonarr-config:/config
- /home/user/ezarr/data:/data
ports:
- "8989:8989"
restart: unless-stopped
@@ -25,12 +25,56 @@ services:
- UMASK=002
- TZ=Europe/Amsterdam
volumes:
- /home/luctia/detering/config/radarr-config:/config
- /home/luctia/detering/data:/data
- /home/user/ezarr/config/radarr-config:/config
- /home/user/ezarr/data:/data
ports:
- "7878:7878"
restart: unless-stopped
lidarr:
image: lscr.io/linuxserver/lidarr:latest
container_name: lidarr
environment:
- PUID=13003
- PGID=13000
- UMASK=002
- TZ=Europe/Amsterdam
volumes:
- /home/user/ezarr/config/lidarr-config:/config
- /home/user/ezarr/data:/data
ports:
- "8686:8686"
restart: unless-stopped
readarr:
image: lscr.io/linuxserver/readarr:develop
container_name: readarr
environment:
- PUID=13004
- PGID=13000
- UMASK=002
- TZ=Europe/Amsterdam
volumes:
- /home/user/ezarr/config/readarr-config:/config
- /home/user/ezarr/data:/data
ports:
- "8787:8787"
restart: unless-stopped
mylar3:
image: lscr.io/linuxserver/mylar3:latest
container_name: mylar3
environment:
- PUID=13005
- PGID=13000
- UMASK=002
volumes:
- /home/user/ezarr/config/mylar-config:/config
- /home/user/ezarr/data:/data
ports:
- "8090:8090"
restart: unless-stopped
prowlarr:
image: lscr.io/linuxserver/prowlarr:develop
container_name: prowlarr
@@ -40,11 +84,40 @@ services:
- UMASK=002
- TZ=Europe/Amsterdam
volumes:
- /home/luctia/detering/config/prowlarr-config:/config
- /home/user/ezarr/config/prowlarr-config:/config
ports:
- "9696:9696"
restart: unless-stopped
plex:
image: lscr.io/linuxserver/plex:latest
container_name: plex
network_mode: host
environment:
- PUID=${UID}
- PGID=13000
- VERSION=docker
- PLEX_CLAIM=
volumes:
- /home/user/ezarr/config/plex-config:/config
- /home/user/ezarr/data/media:/media
restart: unless-stopped
tautulli:
image: lscr.io/linuxserver/tautulli:latest
container_name: tautulli
depends_on:
- plex
environment:
- PUID=${UID}
- PGID=13000
- TZ=Europe/Amsterdam
volumes:
- /home/user/ezarr/config/tautulli-config:/config
ports:
- "8181:8181"
restart: unless-stopped
jellyfin:
image: lscr.io/linuxserver/jellyfin:latest
container_name: jellyfin
@@ -54,8 +127,8 @@ services:
- UMASK=002
- TZ=Europe/Amsterdam
volumes:
- /home/luctia/detering/config/jellyfin-config:/config
- /home/luctia/detering/data/media:/data
- /home/user/ezarr/config/jellyfin-config:/config
- /home/user/ezarr/data/media:/data
ports:
- "8096:8096"
restart: unless-stopped
@@ -70,8 +143,8 @@ services:
- TZ=Europe/Amsterdam
- WEBUI_PORT=8080
volumes:
- /home/luctia/detering/config/qbittorrent-config:/config
- /home/luctia/detering/data/torrents:/data/torrents
- /home/user/ezarr/config/qbittorrent-config:/config
- /home/user/ezarr/data/torrents:/data/torrents
ports:
- "8080:8080"
- "6881:6881"