diff --git a/Docker.md b/Docker.md new file mode 100644 index 0000000..b3837b4 --- /dev/null +++ b/Docker.md @@ -0,0 +1,55 @@ +To get up and running with Lidarr docker you can use the https://github.com/linuxserver/docker-lidarr image (alternatives also exist). + +Example: + +```bash +docker create \ + --name=lidarr \ + -v :/config \ + -v :/downloads \ + -v :/music \ + -e PGID= -e PUID= \ + -p 8686:8686 \ + linuxserver/lidarr +``` + +## Parameters + +The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. +For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. +So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 +http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80. + + + +| Parameter | Function | +| :---: | --- | +| `-p 8686` | the port(s) | +| `-v /config` | Contains your config files| +| `-v /downloads` | Path to your download folder for music | +| `-v /music` | Path to your music library | +| `-e PGID` | for GroupID, see below for explanation | +| `-e PUID` | for UserID, see below for explanation | + + +(These parameters may be out of date if the image is updated, see the current version on the Docker github README: https://github.com/linuxserver/docker-lidarr/blob/master/README.md) + +## docker-compose + +Example `docker-compose.yml` file: + +```yml +version: '2' +services: + lidarr: + container_name: lidarr + image: linuxserver/docker-lidarr + environment: + - TZ= + ports: + - "8686:8686" + volumes: + - ./config:/config + - ./music:/music + - ./downloads:/downloads +``` \ No newline at end of file