diff --git a/images/docker-booksonic-air/index.html b/images/docker-booksonic-air/index.html index a92aa01838..a971f61acd 100644 --- a/images/docker-booksonic-air/index.html +++ b/images/docker-booksonic-air/index.html @@ -1,4 +1,4 @@ - booksonic-air - LinuxServer.io
Skip to content

linuxserver/booksonic-air

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

Booksonic-air is a platform for accessing the audiobooks you own wherever you are. At the moment the platform consists of: * Booksonic Air - A server for streaming your audiobooks, successor to the original Booksonic server and based on Airsonic. * Booksonic App - An DSub based Android app for connection to Booksonic-Air servers.

booksonic-air

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/booksonic-air:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture Available Tag
x86-64 ✅ amd64-<version tag>
arm64 ✅ arm64v8-<version tag>
armhf ❌

Application Setup

Whilst this is a more up to date rebase of the original Booksonic server, upgrading in place is not supported and a fresh install has been recommended. Default user/pass is admin/admin

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

---
+ booksonic-air - LinuxServer.io      
 
 
  
 
  
 
 
 
 
  
 
 
 
 
 
  
 
 
 
 
   
linuxserver/booksonic-air
 
Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
 
Booksonic-air is a platform for accessing the audiobooks you own wherever you are. At the moment the platform consists of: * Booksonic Air - A server for streaming your audiobooks, successor to the original Booksonic server and based on Airsonic. * Booksonic App - An DSub based Android app for connection to Booksonic-Air servers.
 
booksonic-air
 
Supported Architectures
 
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
 
Simply pulling lscr.io/linuxserver/booksonic-air:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
 
The architectures supported by this image are:
 
  
 Architecture Available Tag 
   
 x86-64 ✅ amd64-<version tag> 
 
 arm64 ✅ arm64v8-<version tag> 
 
 armhf ❌  
  
 
Application Setup
 
While this is a more up to date rebase of the original Booksonic server, upgrading in place is not supported and a fresh install has been recommended. Default user/pass is admin/admin
 
Usage
 
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
  
---
 services:
   booksonic-air:
     image: lscr.io/linuxserver/booksonic-air:latest
@@ -9,7 +9,7 @@
       - TZ=Etc/UTC
       - CONTEXT_PATH=url-base #optional
     volumes:
-      - /path/to/appdata/config:/config
+      - /path/to/booksonic-air/config:/config
       - /path/to/audiobooks:/audiobooks
       - /path/to/podcasts:/podcasts
       - /path/to/othermedia:/othermedia
@@ -23,7 +23,7 @@
   -e TZ=Etc/UTC \
   -e CONTEXT_PATH=url-base `#optional` \
   -p 4040:4040 \
-  -v /path/to/appdata/config:/config \
+  -v /path/to/booksonic-air/config:/config \
   -v /path/to/audiobooks:/audiobooks \
   -v /path/to/podcasts:/podcasts \
   -v /path/to/othermedia:/othermedia \
@@ -52,4 +52,4 @@
   --pull \
   -t lscr.io/linuxserver/booksonic-air:latest .
 
 
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
 
docker run --rm --privileged multiarch/qemu-user-static:register --reset
-
 
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
 
Versions
 
     
  • 10.07.23: - Rebase to Alpine 3.18.
    •  
  • 25.12.22: - Rebase to Alpine 3.17, migrate to s6v3, bump jre to 11, deprecate armhf.
    •  
  • 18.04.22: - Rebase to Alpine 3.15.
    •  
  • 15.09.20: - Initial Release.
    •  
  
 
  
  
  
 
 
 
      
\ No newline at end of file
+

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 20.03.24: - Rebase to Alpine 3.19.
  • 10.07.23: - Rebase to Alpine 3.18.
  • 25.12.22: - Rebase to Alpine 3.17, migrate to s6v3, bump jre to 11, deprecate armhf.
  • 18.04.22: - Rebase to Alpine 3.15.
  • 15.09.20: - Initial Release.
\ No newline at end of file diff --git a/images/docker-fleet/index.html b/images/docker-fleet/index.html index 902b607e86..9ebbd8b341 100644 --- a/images/docker-fleet/index.html +++ b/images/docker-fleet/index.html @@ -13,7 +13,7 @@ - fleet_database_password=dbuserpassword - fleet_admin_secret=randomstring #optional volumes: - - /path/to/appdata/config:/config + - /path/to/fleet/config:/config ports: - 8080:8080 restart: unless-stopped @@ -28,7 +28,7 @@ -e fleet_database_password=dbuserpassword \ -e fleet_admin_secret=randomstring `#optional` \ -p 8080:8080 \ - -v /path/to/appdata/config:/config \ + -v /path/to/fleet/config:/config \ --restart unless-stopped \ lscr.io/linuxserver/fleet:latest

Parameters

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter Function
8080 Http port

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
TZ=Etc/UTC specify a timezone to use, see this list.
fleet_admin_authentication_type=DATABASE A switch to define how Fleet manages user logins. If set to DATABASE, see the related optional params. Can be set to either DATABASE or PROPERTIES.
fleet_database_url=jdbc:mariadb://<url>:3306/fleet The full JDBC connection string to the Fleet database
fleet_database_username=fleet_user The username with the relevant GRANT permissions for the database
fleet_database_password=dbuserpassword The database user's password.
fleet_admin_secret=randomstring A string used as part of the password key derivation process.

Volume Mappings (-v)

Volume Function
/config The primary config file and rolling log files.

Miscellaneous Options

Parameter Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable
@@ -54,4 +54,4 @@
   --pull \
   -t lscr.io/linuxserver/fleet:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset
-

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

\ No newline at end of file +

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

\ No newline at end of file diff --git a/images/docker-flexget/index.html b/images/docker-flexget/index.html index 6ac84f7d29..d323803884 100644 --- a/images/docker-flexget/index.html +++ b/images/docker-flexget/index.html @@ -1,4 +1,4 @@ - flexget - LinuxServer.io
Skip to content

linuxserver/flexget

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

Flexget is a multipurpose automation tool for all of your media.

flexget

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/flexget:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture Available Tag
x86-64 ✅ amd64-<version tag>
arm64 ✅ arm64v8-<version tag>
armhf ❌

Application Setup

Default config file is /config/.flexget

See the FlexGet website for more information.

Download folders

We have set /data as an optional path, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.

Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.

The folks over at servarr.com wrote a good write-up on how to get started with this.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

---
+ flexget - LinuxServer.io      
 
 
  
 
  
 
 
 
 
  
 
 
 
 
 
  
 
 
 
 
   
linuxserver/flexget
 
Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
 
Flexget is a multipurpose automation tool for all of your media.
 
flexget
 
Supported Architectures
 
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
 
Simply pulling lscr.io/linuxserver/flexget:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
 
The architectures supported by this image are:
 
  
 Architecture Available Tag 
   
 x86-64 ✅ amd64-<version tag> 
 
 arm64 ✅ arm64v8-<version tag> 
 
 armhf ❌  
  
 
Application Setup
 
Default config file is /config/.flexget
 
See the FlexGet website for more information.
 
Download folders
 
We have set /data as an optional path, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
 
Use the optional paths if you don't understand, or don't want hardlinks/atomic moves.
 
The folks over at servarr.com wrote a good write-up on how to get started with this.
 
Usage
 
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
  
---
 services:
   flexget:
     image: lscr.io/linuxserver/flexget:latest
@@ -12,7 +12,7 @@
       - FG_CONFIG_FILE=/config/.flexget/config.yml
       - FG_WEBUI_PASSWORD=info #optional
     volumes:
-      - /path/to/data:/config
+      - /path/to/flexget/data:/config
       - /path/to/downloads:/data #optional
     ports:
       - 5050:5050
@@ -27,7 +27,7 @@
   -e FG_CONFIG_FILE=/config/.flexget/config.yml \
   -e FG_WEBUI_PASSWORD=info `#optional` \
   -p 5050:5050 \
-  -v /path/to/data:/config \
+  -v /path/to/flexget/data:/config \
   -v /path/to/downloads:/data `#optional` \
   --restart unless-stopped \
   lscr.io/linuxserver/flexget:latest
@@ -54,4 +54,4 @@
   --pull \
   -t lscr.io/linuxserver/flexget:latest .
 
 
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
 
docker run --rm --privileged multiarch/qemu-user-static:register --reset
-
 
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
 
Versions
 
     
  • 07.10.23: - Install unrar from linuxserver repo.
    •  
  • 10.08.23: - Bump unrar to 6.2.10.
    •  
  • 03.07.23: - Initial Release.
    •  
  
 
  
  
  
 
 
 
      
\ No newline at end of file
+

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 20.03.24: - Rebase to Alpine 3.19.
  • 07.10.23: - Install unrar from linuxserver repo.
  • 10.08.23: - Bump unrar to 6.2.10.
  • 03.07.23: - Initial Release.
\ No newline at end of file diff --git a/images/docker-lidarr/index.html b/images/docker-lidarr/index.html index 472248b534..38e7b90c99 100644 --- a/images/docker-lidarr/index.html +++ b/images/docker-lidarr/index.html @@ -1,4 +1,4 @@ - lidarr - LinuxServer.io
Skip to content

linuxserver/lidarr

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.

lidarr

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/lidarr:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture Available Tag
x86-64 ✅ amd64-<version tag>
arm64 ✅ arm64v8-<version tag>
armhf ❌

Version Tags

This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.

Tag Available Description
latest ✅ Stable Lidarr releases.
develop ✅ Develop Lidarr Releases.
nightly ✅ Nightly Lidarr Releases.

Application Setup

Access the webui at <your-ip>:8686, for more information check out Lidarr.

Special Note: Following our current folder structure will result in an inability to hardlink from your downloads to your Music folder because they are on seperate volumes. To support hardlinking, simply ensure that the Music and downloads data are on a single volume. For example, if you have /mnt/storage/Music and /mnt/storage/downloads/completed/Music, you would want something like /mnt/storage:/media for your volume. Then you can hardlink from /media/downloads/completed to /media/Music.

Another item to keep in mind, is that within lidarr itself, you should then map your download client folder to your lidarr folder: Settings -> Download Client -> advanced -> remote path mappings. I input the host of my download client (matches the download client defined) remote path is /downloads/Music (relative to the internal container path) and local path is /media/downloads/completed/Music, assuming you have folders to seperate your downloaded data types.

Media folders

We have set /music and /downloads as optional paths, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.

Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.

The folks over at servarr.com wrote a good write-up on how to get started with this.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

---
+ lidarr - LinuxServer.io      
 
 
  
 
  
 
 
 
 
  
 
 
 
 
 
  
 
 
 
 
   
linuxserver/lidarr
 
Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
 
Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
 
lidarr
 
Supported Architectures
 
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
 
Simply pulling lscr.io/linuxserver/lidarr:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
 
The architectures supported by this image are:
 
  
 Architecture Available Tag 
   
 x86-64 ✅ amd64-<version tag> 
 
 arm64 ✅ arm64v8-<version tag> 
 
 armhf ❌  
  
 
Version Tags
 
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
 
  
 Tag Available Description 
   
 latest ✅ Stable Lidarr releases. 
 
 develop ✅ Develop Lidarr Releases. 
 
 nightly ✅ Nightly Lidarr Releases. 
  
 
Application Setup
 
Access the webui at <your-ip>:8686, for more information check out Lidarr.
 
Special Note: Following our current folder structure will result in an inability to hardlink from your downloads to your Music folder because they are on separate volumes. To support hardlinking, simply ensure that the Music and downloads data are on a single volume. For example, if you have /mnt/storage/Music and /mnt/storage/downloads/completed/Music, you would want something like /mnt/storage:/media for your volume. Then you can hardlink from /media/downloads/completed to /media/Music.
 
Another item to keep in mind, is that within Lidarr itself, you should then map your download client folder to your Lidarr folder: Settings -> Download Client -> advanced -> remote path mappings. I input the host of my download client (matches the download client defined) remote path is /downloads/Music (relative to the internal container path) and local path is /media/downloads/completed/Music, assuming you have folders to separate your downloaded data types.
 
Media folders
 
We have set /music and /downloads as optional paths, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
 
Use the optional paths if you don't understand, or don't want hardlinks/atomic moves.
 
The folks over at servarr.com wrote a good write-up on how to get started with this.
 
Usage
 
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
  
---
 services:
   lidarr:
     image: lscr.io/linuxserver/lidarr:latest
@@ -8,7 +8,7 @@
       - PGID=1000
       - TZ=Etc/UTC
     volumes:
-      - /path/to/appdata/config:/config
+      - /path/to/lidarr/config:/config
       - /path/to/music:/music #optional
       - /path/to/downloads:/downloads #optional
     ports:
@@ -20,7 +20,7 @@
   -e PGID=1000 \
   -e TZ=Etc/UTC \
   -p 8686:8686 \
-  -v /path/to/appdata/config:/config \
+  -v /path/to/lidarr/config:/config \
   -v /path/to/music:/music `#optional` \
   -v /path/to/downloads:/downloads `#optional` \
   --restart unless-stopped \
@@ -48,4 +48,4 @@
   --pull \
   -t lscr.io/linuxserver/lidarr:latest .
 
 
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
 
docker run --rm --privileged multiarch/qemu-user-static:register --reset
-
 
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
 
Versions
 
     
  • 06.06.23: - Rebase master to Alpine 3.18, deprecate armhf as per https://www.linuxserver.io/armhf.
    •  
  • 17.01.23: - Rebase master branch to Alpine 3.17, migrate to s6v3.
    •  
  • 06.06.22: - Rebase master branch to Alpine 3.15.
    •  
  • 06.05.22: - Rebase master branch to Focal.
    •  
  • 06.05.22: - Rebase develop branch to Alpine.
    •  
  • 04.02.22: - Rebase nightly branch to Alpine, deprecate nightly-alpine branch.
    •  
  • 30.12.21: - Add nightly-alpine branch.
    •  
  • 01.08.21: - Add libchromaprint-tools.
    •  
  • 11.07.21: - Make the paths clearer to the user.
    •  
  • 18.04.21: - Switch latest tag to net core.
    •  
  • 25.01.21: - Publish develop tag.
    •  
  • 20.01.21: - Deprecate UMASK_SET in favor of UMASK in baseimage, see above for more information.
    •  
  • 18.04.20: - Removed /downloads and /music volumes from Dockerfiles.
    •  
  • 05.04.20: - Move app to /app.
    •  
  • 01.08.19: - Rebase to Linuxserver LTS mono version.
    •  
  • 13.06.19: - Add env variable for setting umask.
    •  
  • 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
    •  
  • 08.03.19: - Rebase to Bionic, use proposed endpoint for libchromaprint.
    •  
  • 26.01.19: - Add pipeline logic and multi arch.
    •  
  • 22.04.18: - Switch to beta builds.
    •  
  • 17.03.18: - Add ENV XDG_CONFIG_HOME="/config/xdg" to Dockerfile for signalr fix.
    •  
  • 27.02.18: - Use json to query for new version.
    •  
  • 23.02.18: - Initial Release.
    •  
  
 
  
  
  
 
 
 
      
\ No newline at end of file
+

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 20.03.24: - Rebase Alpine 3.19.
  • 06.06.23: - Rebase master to Alpine 3.18, deprecate armhf as per https://www.linuxserver.io/armhf.
  • 17.01.23: - Rebase master branch to Alpine 3.17, migrate to s6v3.
  • 06.06.22: - Rebase master branch to Alpine 3.15.
  • 06.05.22: - Rebase master branch to Focal.
  • 06.05.22: - Rebase develop branch to Alpine.
  • 04.02.22: - Rebase nightly branch to Alpine, deprecate nightly-alpine branch.
  • 30.12.21: - Add nightly-alpine branch.
  • 01.08.21: - Add libchromaprint-tools.
  • 11.07.21: - Make the paths clearer to the user.
  • 18.04.21: - Switch latest tag to net core.
  • 25.01.21: - Publish develop tag.
  • 20.01.21: - Deprecate UMASK_SET in favor of UMASK in baseimage, see above for more information.
  • 18.04.20: - Removed /downloads and /music volumes from Dockerfiles.
  • 05.04.20: - Move app to /app.
  • 01.08.19: - Rebase to Linuxserver LTS mono version.
  • 13.06.19: - Add env variable for setting umask.
  • 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
  • 08.03.19: - Rebase to Bionic, use proposed endpoint for libchromaprint.
  • 26.01.19: - Add pipeline logic and multi arch.
  • 22.04.18: - Switch to beta builds.
  • 17.03.18: - Add ENV XDG_CONFIG_HOME="/config/xdg" to Dockerfile for signalr fix.
  • 27.02.18: - Use json to query for new version.
  • 23.02.18: - Initial Release.
\ No newline at end of file diff --git a/images/docker-prowlarr/index.html b/images/docker-prowlarr/index.html index 7a3dada1d7..5e8d21e553 100644 --- a/images/docker-prowlarr/index.html +++ b/images/docker-prowlarr/index.html @@ -8,7 +8,7 @@ - PGID=1000 - TZ=Etc/UTC volumes: - - /path/to/data:/config + - /path/to/prowlarr/data:/config ports: - 9696:9696 restart: unless-stopped @@ -18,10 +18,10 @@ -e PGID=1000 \ -e TZ=Etc/UTC \ -p 9696:9696 \ - -v /path/to/data:/config \ + -v /path/to/prowlarr/data:/config \ --restart unless-stopped \ lscr.io/linuxserver/prowlarr:latest -

Parameters

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter Function
9696 The port for the Prowlarr webinterface

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
TZ=Etc/UTC specify a timezone to use, see this list.

Volume Mappings (-v)

Volume Function
/config Database and Prowlarr configs

Miscellaneous Options

Parameter Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable
+

Parameters

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter Function
9696 The port for the Prowlarr web UI

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
TZ=Etc/UTC specify a timezone to use, see this list.

Volume Mappings (-v)

Volume Function
/config Database and Prowlarr configs

Miscellaneous Options

Parameter Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

Docker Mods Docker Universal Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info