From c4018c7b6e52df4b9333ce4878627ac1f39ee028 Mon Sep 17 00:00:00 2001 From: <> Date: Wed, 22 May 2024 19:18:25 +0000 Subject: [PATCH] Deployed f07c313e with MkDocs version: 1.6.0 --- images/docker-netbox/index.html | 4 ++-- images/docker-overseerr/index.html | 4 ++-- images/docker-pidgin/index.html | 4 ++-- images/docker-your_spotify/index.html | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/images/docker-netbox/index.html b/images/docker-netbox/index.html index 73f6d735b0..cef78287c4 100644 --- a/images/docker-netbox/index.html +++ b/images/docker-netbox/index.html @@ -1,4 +1,4 @@ - netbox - LinuxServer.io
Skip to content

linuxserver/netbox

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

Netbox is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at DigitalOcean, NetBox was developed specifically to address the needs of network and infrastructure engineers. It is intended to function as a domain-specific source of truth for network operations.

netbox

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/netbox: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

Netbox requires a postgres database and a redis instance.

Access the WebUI at :8000. For more information, check out NetBox.

Usage

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

---
+ netbox - LinuxServer.io      

linuxserver/netbox

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

Netbox is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at DigitalOcean, NetBox was developed specifically to address the needs of network and infrastructure engineers. It is intended to function as a domain-specific source of truth for network operations.

netbox

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/netbox: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

Netbox requires a postgres database and a redis instance.

Access the WebUI at :8000. For more information, check out NetBox.

Usage

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

---
 services:
   netbox:
     image: lscr.io/linuxserver/netbox:latest
@@ -84,4 +84,4 @@
   --pull \
   -t lscr.io/linuxserver/netbox: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

  • 23.12.23: - Rebase to Alpine 3.19.
  • 11.06.23: - Rebase to Alpine 3.18, deprecate armhf.
  • 14.05.23: - Build local docs on first run.
  • 05.03.23: - Rebase to Alpine 3.17.
  • 02.11.22: - Rebase to Alpine 3.16, migrate to s6v3.
  • 01.08.22: - Remove py3-pillow, add tiff to fix deps.
  • 26.07.22: - Add py3-pillow package back on arm to fix build issue.
  • 10.12.21: - Remove py3-pillow package to fix dependency issue with 3.2.0.
  • 10.12.21: - Rebase to Alpine 3.15.
  • 26.04.21: - Added Redis database environment variables.
  • 03.02.21: - Added remote authentication environment variables.
  • 02.01.21: - Added BASE_PATH environment variable.
  • 23.08.20: - Initial Release.
\ No newline at end of file +

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

Versions

  • 23.12.23: - Rebase to Alpine 3.19.
  • 11.06.23: - Rebase to Alpine 3.18, deprecate armhf.
  • 14.05.23: - Build local docs on first run.
  • 05.03.23: - Rebase to Alpine 3.17.
  • 02.11.22: - Rebase to Alpine 3.16, migrate to s6v3.
  • 01.08.22: - Remove py3-pillow, add tiff to fix deps.
  • 26.07.22: - Add py3-pillow package back on arm to fix build issue.
  • 10.12.21: - Remove py3-pillow package to fix dependency issue with 3.2.0.
  • 10.12.21: - Rebase to Alpine 3.15.
  • 26.04.21: - Added Redis database environment variables.
  • 03.02.21: - Added remote authentication environment variables.
  • 02.01.21: - Added BASE_PATH environment variable.
  • 23.08.20: - Initial Release.
\ No newline at end of file diff --git a/images/docker-overseerr/index.html b/images/docker-overseerr/index.html index 667cac3c25..98e7beac71 100644 --- a/images/docker-overseerr/index.html +++ b/images/docker-overseerr/index.html @@ -1,4 +1,4 @@ - overseerr - LinuxServer.io
Skip to content

linuxserver/overseerr

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

Overseerr is a request management and media discovery tool built to work with your existing Plex ecosystem.

overseerr

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/overseerr: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 releases from GitHub
develop Development releases from commits in upstream develop branch

Application Setup

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

Usage

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

---
+ overseerr - LinuxServer.io      

linuxserver/overseerr

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

Overseerr is a request management and media discovery tool built to work with your existing Plex ecosystem.

overseerr

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/overseerr: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 releases from GitHub
develop Development releases from commits in upstream develop branch

Application Setup

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

Usage

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

---
 services:
   overseerr:
     image: lscr.io/linuxserver/overseerr:latest
@@ -44,4 +44,4 @@
   --pull \
   -t lscr.io/linuxserver/overseerr: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

  • 23.12.23: - Rebase to Alpine 3.19.
  • 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
  • 18.12.22: - Rebase main to 3.17.
  • 27.10.22: - Rebase main to 3.16, migrate to s6v3.
  • 20.08.22: - Don't install cypress.
  • 01.04.22: - Rebase main branch to Alpine 3.15.
  • 27.01.22: - Rebase develop branch to Alpine 3.15.
  • 04.01.22: - Remove cached files.
  • 10.10.21: - Add additional post-build cleanup.
  • 19.09.21: - Rebase to alpine 3.14. Update code formatting. Increase js mem limit.
  • 05.04.21: - Initial Release.
\ No newline at end of file +

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

Versions

  • 23.12.23: - Rebase to Alpine 3.19.
  • 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
  • 18.12.22: - Rebase main to 3.17.
  • 27.10.22: - Rebase main to 3.16, migrate to s6v3.
  • 20.08.22: - Don't install cypress.
  • 01.04.22: - Rebase main branch to Alpine 3.15.
  • 27.01.22: - Rebase develop branch to Alpine 3.15.
  • 04.01.22: - Remove cached files.
  • 10.10.21: - Add additional post-build cleanup.
  • 19.09.21: - Rebase to alpine 3.14. Update code formatting. Increase js mem limit.
  • 05.04.21: - Initial Release.
\ No newline at end of file diff --git a/images/docker-pidgin/index.html b/images/docker-pidgin/index.html index f77e988eda..9f36511e6f 100644 --- a/images/docker-pidgin/index.html +++ b/images/docker-pidgin/index.html @@ -1,4 +1,4 @@ - pidgin - LinuxServer.io
Skip to content

linuxserver/pidgin

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

Pidgin is a chat program which lets you log into accounts on multiple chat networks simultaneously. This means that you can be chatting with friends on XMPP and sitting in an IRC channel at the same time.

pidgin

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/pidgin: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

The application can be accessed at:

  • http://yourhost:3000/
  • https://yourhost:3001/

This Pidgin installation comes with default chat plugins plus a series of third party ones. Please note that the third party plugins for the most part are not simply plug and play, you will need to reference their documentation and possibly generate oauth tokens along with other workarounds. Third party plugins are always in a state of constant development do not expect every single native feature to work flawlessly. To ease integration with some third party plugins we include Firefox in this image to allow you to fill out captchas or pre-auth before loading your credentials into the program, simply right click the desktop to launch it.

Options in all KasmVNC based GUI containers

This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.

Optional environment variables

Variable Description
CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000.
CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001.
CUSTOM_USER HTTP Basic auth username, abc is default.
PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth
SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/
TITLE The page title displayed on the web browser, default "KasmVNC Client".
FM_HOME This is the home directory (landing) for the file manager, default "/config".
START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup.
DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
LC_ALL Set the Language for the container to run as IE fr_FR.UTF-8 ar_AE.UTF-8
NO_DECOR If set the application will run without window borders for use as a PWA.
NO_FULL Do not autmatically fullscreen applications when using openbox.

Optional run configurations

Variable Description
--privileged Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker.
-v /var/run/docker.sock:/var/run/docker.sock Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications.
--device /dev/dri:/dev/dri Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)

Language Support - Internationalization

The environment variable LC_ALL can be used to start this image in a different language than English simply pass for example to launch the Desktop session in French LC_ALL=fr_FR.UTF-8. Some languages like Chinese, Japanese, or Korean will be missing fonts needed to render properly known as cjk fonts, but others may exist and not be installed. We only ensure fonts for Latin characters are present. Fonts can be installed with a mod on startup.

To install cjk fonts on startup as an example pass the environment variables:

-e DOCKER_MODS=linuxserver/mods:universal-package-install
+ pidgin - LinuxServer.io      

linuxserver/pidgin

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

Pidgin is a chat program which lets you log into accounts on multiple chat networks simultaneously. This means that you can be chatting with friends on XMPP and sitting in an IRC channel at the same time.

pidgin

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/pidgin: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

The application can be accessed at:

  • http://yourhost:3000/
  • https://yourhost:3001/

This Pidgin installation comes with default chat plugins plus a series of third party ones. Please note that the third party plugins for the most part are not simply plug and play, you will need to reference their documentation and possibly generate oauth tokens along with other workarounds. Third party plugins are always in a state of constant development do not expect every single native feature to work flawlessly. To ease integration with some third party plugins we include Firefox in this image to allow you to fill out captchas or pre-auth before loading your credentials into the program, simply right click the desktop to launch it.

Options in all KasmVNC based GUI containers

This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.

Optional environment variables

Variable Description
CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000.
CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001.
CUSTOM_USER HTTP Basic auth username, abc is default.
PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth
SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/
TITLE The page title displayed on the web browser, default "KasmVNC Client".
FM_HOME This is the home directory (landing) for the file manager, default "/config".
START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup.
DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
LC_ALL Set the Language for the container to run as IE fr_FR.UTF-8 ar_AE.UTF-8
NO_DECOR If set the application will run without window borders for use as a PWA.
NO_FULL Do not autmatically fullscreen applications when using openbox.

Optional run configurations

Variable Description
--privileged Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker.
-v /var/run/docker.sock:/var/run/docker.sock Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications.
--device /dev/dri:/dev/dri Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)

Language Support - Internationalization

The environment variable LC_ALL can be used to start this image in a different language than English simply pass for example to launch the Desktop session in French LC_ALL=fr_FR.UTF-8. Some languages like Chinese, Japanese, or Korean will be missing fonts needed to render properly known as cjk fonts, but others may exist and not be installed. We only ensure fonts for Latin characters are present. Fonts can be installed with a mod on startup.

To install cjk fonts on startup as an example pass the environment variables:

-e DOCKER_MODS=linuxserver/mods:universal-package-install
 -e INSTALL_PACKAGES=font-noto-cjk
 -e LC_ALL=zh_CN.UTF-8
 

The web interface has the option for "IME Input Mode" in Settings which will allow non english characters to be used from a non en_US keyboard on the client. Once enabled it will perform the same as a local Linux installation set to your locale.

Lossless mode

This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.

Usage

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

---
@@ -52,4 +52,4 @@
   --pull \
   -t lscr.io/linuxserver/pidgin: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.02.24: - Update Readme with new env vars and ingest proper PWA icon.
  • 17.01.24: - Switch from Chromium to Firefox.
  • 02.01.24: - Rebase to Alpine 3.19.
  • 13.05.23: - Rebase to Alpine 3.18.
  • 18.03.23: - Rebase to KasmVNC base image.
  • 21.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
  • 15.02.22: - Add build deps for discord.
  • 23.12.21: - Rebase to Alpine 3.15.
  • 26.09.21: - Rebase to Alpine 3.14.
  • 14.05.21: - Initial release.
\ No newline at end of file +

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

Versions

  • 10.02.24: - Update Readme with new env vars and ingest proper PWA icon.
  • 17.01.24: - Switch from Chromium to Firefox.
  • 02.01.24: - Rebase to Alpine 3.19.
  • 13.05.23: - Rebase to Alpine 3.18.
  • 18.03.23: - Rebase to KasmVNC base image.
  • 21.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
  • 15.02.22: - Add build deps for discord.
  • 23.12.21: - Rebase to Alpine 3.15.
  • 26.09.21: - Rebase to Alpine 3.14.
  • 14.05.21: - Initial release.
\ No newline at end of file diff --git a/images/docker-your_spotify/index.html b/images/docker-your_spotify/index.html index 8de7cb4c15..9afa1b59fc 100644 --- a/images/docker-your_spotify/index.html +++ b/images/docker-your_spotify/index.html @@ -1,4 +1,4 @@ - your_spotify - LinuxServer.io
Skip to content

linuxserver/your_spotify

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

Your_spotify is a self-hosted application that tracks what you listen and offers you a dashboard to explore statistics about it! It's composed of a web server which polls the Spotify API every now and then and a web application on which you can explore your statistics.

your_spotify

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/your_spotify: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

You have to create a Spotify application through their developer dashboard to get your Client ID and secret. Set the Redirect URI to match your APP_URL address with /api/oauth/spotify/callback included after the domain (i.e., http://localhost/api/oauth/spotify/callback).

The application requires an external mongodb database, supported versions are 4.x, 5.x, and 6.x.

This ia an all-in-one container which includes both the server and client components. If you require these to be separate then please use the releases from the your_spotify repo.

Usage

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

---
+ your_spotify - LinuxServer.io      

linuxserver/your_spotify

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

Your_spotify is a self-hosted application that tracks what you listen and offers you a dashboard to explore statistics about it! It's composed of a web server which polls the Spotify API every now and then and a web application on which you can explore your statistics.

your_spotify

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/your_spotify: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

You have to create a Spotify application through their developer dashboard to get your Client ID and secret. Set the Redirect URI to match your APP_URL address with /api/oauth/spotify/callback included after the domain (i.e., http://localhost/api/oauth/spotify/callback).

The application requires an external mongodb database, supported versions are 4.x, 5.x, and 6.x.

This ia an all-in-one container which includes both the server and client components. If you require these to be separate then please use the releases from the your_spotify repo.

Usage

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

---
 services:
   your_spotify:
     image: lscr.io/linuxserver/your_spotify:latest
@@ -53,4 +53,4 @@
   --pull \
   -t lscr.io/linuxserver/your_spotify: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

  • 02.03.24: - Updates for changes in 1.8.0. Initial DB migration may take several minutes.
  • 24.01.24: - Existing users should update: site-confs/default.conf - Cleanup default site conf.
  • 23.12.23: - Rebase to Alpine 3.19 with php 8.3.
  • 23.01.23: - Rebase to Alpine 3.18, standardize nginx default site conf.
  • 23.01.23: - Initial Release.
\ No newline at end of file +

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

Versions

  • 02.03.24: - Updates for changes in 1.8.0. Initial DB migration may take several minutes.
  • 24.01.24: - Existing users should update: site-confs/default.conf - Cleanup default site conf.
  • 23.12.23: - Rebase to Alpine 3.19 with php 8.3.
  • 23.01.23: - Rebase to Alpine 3.18, standardize nginx default site conf.
  • 23.01.23: - Initial Release.
\ No newline at end of file