LinuxServer.io

https://docs.linuxserver.io/
Admin
LinuxServer.io provides pre-built Docker container images for a wide range of applications, along...
Tokens:837,966
Snippets:12,554
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install ffmpeg using a Custom Init Script

Source: https://docs.linuxserver.io/general/container-customization

A custom script example to install ffmpeg within a container. Ensure the script is executable and owned by root.

```bash
#!/bin/bash

echo "**** installing ffmpeg ****"
apk add --no-cache ffmpeg

```

--------------------------------

### Configure and Start Screen Capture

Source: https://docs.linuxserver.io/selkies/components/pixelflux

Initializes capture settings and starts the screen capture process with a frame callback function.

```python
from pixelflux import CaptureSettings, ScreenCapture, ensure_wayland_display

settings = CaptureSettings()
settings.capture_width = 1920
settings.capture_height = 1080
settings.target_fps = 60.0
settings.output_mode = 1          # 0 = JPEG, 1 = H.264
settings.video_crf = 25
settings.use_paint_over_quality = True

def on_frame(frame):
    # frame is a StripeFrame: zero copy buffer protocol object
    # frame.data_type: 1 = JPEG, 2 = H.264
    # bytes(frame) or memoryview(frame) for the payload
    ws.send(bytes(frame))

capture = ScreenCapture()
capture.start_capture(on_frame, settings)
```

--------------------------------

### Install Pixelflux from source

Source: https://docs.linuxserver.io/selkies/components/pixelflux

Use this command to build and install the package using setuptools-rust.

```bash
pip install .
```

--------------------------------

### Nextcloud Docker CLI Setup

Source: https://docs.linuxserver.io/general/swag

Use these Docker CLI commands to create Nextcloud containers. This example assumes a user-defined bridge network 'lsio' is already set up.

```bash
docker create \
  --name=nextcloud \
  --net=lsio
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -v /home/aptalca/appdata/nextcloud/config:/config \
  -v /home/aptalca/appdata/nextcloud/data:/data \
  --restart unless-stopped \
  lscr.io/linuxserver/nextcloud


```

--------------------------------

### Install Application with PRoot Apps

Source: https://docs.linuxserver.io/images/docker-altus?q=

Use this command inside the container to install applications that will persist across container recreations.

```bash
proot-apps install filezilla

```

--------------------------------

### Start SWAG Container with Docker CLI

Source: https://docs.linuxserver.io/general/swag?q=

Command to start the previously created SWAG container.

```bash
docker start swag
```

--------------------------------

### Autostart Script Command Example

Source: https://docs.linuxserver.io/selkies/components/sealskin-apps

A sample command line used within an autostart script to handle file or URL inputs via environment variables.

```bash
/usr/bin/firefox ${FIREFOX_CLI} ${SEALSKIN_FILE:+"$SEALSKIN_FILE"} ${SEALSKIN_URL:+"$SEALSKIN_URL"}
```

--------------------------------

### Install Native Apps using Universal Package Install Mod

Source: https://docs.linuxserver.io/images/docker-altus?q=

Configure your compose.yaml to use the universal-package-install mod for installing system packages. Note that these installations are not persistent and may increase container start time.

```yaml
  environment:
    - DOCKER_MODS=linuxserver/mods:universal-package-install
    - INSTALL_PACKAGES=libfuse2|git|gdb

```

--------------------------------

### Install Native Packages with Universal Package Install Mod

Source: https://docs.linuxserver.io/images/docker-boinc

Configure your compose.yaml to use the universal-package-install mod for installing system packages. Note that this method increases container start time and is not persistent.

```yaml
environment:
    - DOCKER_MODS=linuxserver/mods:universal-package-install
    - INSTALL_PACKAGES=libfuse2|git|gdb

```

--------------------------------

### Run Minimal Webtop Container

Source: https://docs.linuxserver.io/selkies/user-guide/quickstart?q=

Starts a temporary Ubuntu KDE desktop container.

```bash
docker run --rm -it \
  --shm-size=1gb \
  -p 3001:3001 \
  lscr.io/linuxserver/webtop:ubuntu-kde bash

```

--------------------------------

### Build Selkies Desktop from Source

Source: https://docs.linuxserver.io/selkies/components/selkies-desktop

Install necessary dependencies and compile the binary using the provided Makefile.

```bash
sudo apt install libcairo2-dev libwayland-dev wayland-protocols curl build-essential
make
```

--------------------------------

### Nvidia Docker Compose Configuration

Source: https://docs.linuxserver.io/images/docker-chrome?q=

Example Docker Compose setup for Nvidia GPU acceleration.

```yaml
---
services:
  chrome:
    image: lscr.io/linuxserver/chrome:latest
    environment:
      - PIXELFLUX_WAYLAND=true
      # Ensure these point to the rendered node injected by the runtime (usually renderD128)
      - DRINODE=/dev/dri/renderD128
      - DRI_NODE=/dev/dri/renderD128
    deploy:
      resources:
        reservations:
          devices:
            - driver: nvidia
              count: 1
              capabilities: [compute,video,graphics,utility]
```

--------------------------------

### Run Minimal Webtop Container

Source: https://docs.linuxserver.io/selkies/user-guide/quickstart

Starts a temporary Ubuntu KDE desktop container with a shell.

```bash
docker run --rm -it \
  --shm-size=1gb \
  -p 3001:3001 \
  lscr.io/linuxserver/webtop:ubuntu-kde bash
```

--------------------------------

### Nvidia Compose Configuration

Source: https://docs.linuxserver.io/images/docker-ardour?q=

Example Docker Compose setup for Ardour utilizing Nvidia GPU resources.

```yaml
---
services:
  ardour:
    image: lscr.io/linuxserver/ardour:latest
    environment:
      - PIXELFLUX_WAYLAND=true
      # Ensure these point to the rendered node injected by the runtime (usually renderD128)
      - DRINODE=/dev/dri/renderD128
      - DRI_NODE=/dev/dri/renderD128
    deploy:
      resources:
        reservations:
          devices:
            - driver: nvidia
              count: 1
              capabilities: [compute,video,graphics,utility]
```

--------------------------------

### Run Selkies server and web client in development mode

Source: https://docs.linuxserver.io/selkies/developer-guide/development?q=

Clones the repository and launches a container with the source mounted at /config/src for live development.

```bash
git clone https://github.com/selkies-project/selkies.git
cd selkies
git checkout -f lsio
docker run --rm -it \
  --shm-size=1gb \
  -e DEV_MODE=selkies-dashboard \
  -e PUID=1000 \
  -e PGID=1000 \
  -v $(pwd):/config/src \
  -p 3001:3001 ghcr.io/linuxserver/webtop:ubuntu-kde bash
```

--------------------------------

### Configure Native App Installation in Docker Compose

Source: https://docs.linuxserver.io/images/docker-audacity

Add these environment variables to your compose.yaml to install packages from the system's native repository using the universal-package-install mod. Note that this method increases container start time and is not persistent.

```yaml
environment:
  - DOCKER_MODS=linuxserver/mods:universal-package-install
  - INSTALL_PACKAGES=libfuse2|git|gdb
```

--------------------------------

### Control Docker-in-Docker (DinD) Startup

Source: https://docs.linuxserver.io/images/docker-azahar

Set START_DOCKER to false to prevent a container with privilege from automatically starting the DinD Docker setup.

```bash
-e START_DOCKER=false
```

--------------------------------

### Expose Port Example

Source: https://docs.linuxserver.io/images/docker-adguardhome-sync

Demonstrates the syntax for mapping host ports to container ports.

```bash
-p 8080:80
```

--------------------------------

### Run the 'hello-world' Docker container

Source: https://docs.linuxserver.io/general/containers-101?q=

This command downloads and runs the 'hello-world' container, demonstrating the basic usage of Docker to execute a containerized application without needing to know its dependencies.

```bash
docker run hello-world

```

--------------------------------

### Nginx Container with Cloudflared Docker Mod

Source: https://docs.linuxserver.io/general/container-customization

This example demonstrates how to configure an Nginx container to use the universal cloudflared Docker Mod for enhanced functionality. It includes environment variables for Cloudflare tunnel setup.

```yaml
  nginx:
    image: lscr.io/linuxserver/nginx
    container_name: nginx
    environment:
      PUID: 1000
      PGID: 1000
      TZ: Europe/London
      DOCKER_MODS: lscr.io/linuxserver/mods:universal-cloudflared
      CF_ZONE_ID: zone_id
      CF_ACCOUNT_ID: acct_id
      CF_API_TOKEN: token
      CF_TUNNEL_NAME: example
      CF_TUNNEL_PASSWORD: pleasedontusethisexamplepassword
      CF_TUNNEL_CONFIG: |
        ingress:
          - hostname: test.example.com
            service: http://localhost:80
          - service: http_status:404
    volumes:
      - /path/to/appdata/config:/config
    restart: unless-stopped

```

--------------------------------

### Run Docker-in-Docker with GPU Mount

Source: https://docs.linuxserver.io/images/docker-bitcoin-knots?q=

Starts a Docker-in-Docker (DinD) environment with privileged access. For better performance, mount the Docker data directory from the host. This example also mounts a GPU into the container for accelerated applications.

```bash
--privileged -v /path/to/docker-data:/var/lib/docker
-v /var/run/docker.sock:/var/run/docker.sock
--device /dev/dri:/dev/dri
```

--------------------------------

### Repository layout for Selkies images

Source: https://docs.linuxserver.io/selkies/developer-guide/building-images?q=

The expected directory structure for autostart configuration files.

```text
root/
└── defaults/
    ├── autostart_wayland    # what to run in Wayland mode
    └── autostart            # what to run in X11 fallback mode
```

--------------------------------

### Nvidia GPU Setup for Hardware Acceleration

Source: https://docs.linuxserver.io/images/docker-boinc?q=

For Nvidia GPUs, install the nvidia-container-toolkit on the host. Recreate the container using the nvidia runtime and set the NVIDIA_VISIBLE_DEVICES environment variable. This allows the container to utilize host GPU features.

```bash
--runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=all
```

--------------------------------

### Deploy qBittorrent with Docker CLI

Source: https://docs.linuxserver.io/images/docker-qbittorrent?q=

Alternative method for deploying the container directly via the command line interface.

```bash
docker run -d \
  --name=qbittorrent \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e WEBUI_PORT=8080 \
  -e TORRENTING_PORT=6881 \
  -p 8080:8080 \
  -p 6881:6881 \
  -p 6881:6881/udp \
  -v /path/to/qbittorrent/appdata:/config \
  -v /path/to/downloads:/downloads `#optional` \
  --stop-timeout="10s" `#optional` \
  --restart unless-stopped \
  lscr.io/linuxserver/qbittorrent:latest
```

--------------------------------

### Bootstrap SQL Initialization

Source: https://docs.linuxserver.io/images/docker-mariadb

Place custom SQL files in this directory to execute them during the container's first boot.

```text
/config/initdb.d/
```

--------------------------------

### Install Plugin Requirements

Source: https://docs.linuxserver.io/images/docker-limnoria

Manually install requirements for a plugin by executing a pip install command within the container's shell. This is an alternative to restarting the container.

```bash
pip install /config/plugins/ThePlugin/requirements.txt
```

--------------------------------

### Installing Certbot plugins via Docker Mods

Source: https://docs.linuxserver.io/images/docker-swag

Environment variables required to install additional Certbot plugins using the Universal Package Install Docker Mod.

```bash
DOCKER_MODS=linuxserver/mods:universal-package-install
INSTALL_PIP_PACKAGES=certbot-dns-<plugin>
```

--------------------------------

### Deploy qBittorrent with Docker Compose

Source: https://docs.linuxserver.io/images/docker-qbittorrent?q=

Recommended method for deploying the container using a YAML configuration file.

```yaml
---
services:
  qbittorrent:
    image: lscr.io/linuxserver/qbittorrent:latest
    container_name: qbittorrent
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - WEBUI_PORT=8080
      - TORRENTING_PORT=6881
    volumes:
      - /path/to/qbittorrent/appdata:/config
      - /path/to/downloads:/downloads #optional
    ports:
      - 8080:8080
      - 6881:6881
      - 6881:6881/udp
    stop_grace_period: "10s" #optional
    restart: unless-stopped
```

--------------------------------

### Install Docker Compose Manually

Source: https://docs.linuxserver.io/general/docker-compose

Installs the Docker Compose CLI plugin to the user's home directory. Ensure Docker is installed prior to running this command.

```bash
mkdir -p "$HOME/.docker/cli-plugins" && \
curl -sL "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" -o "$HOME/.docker/cli-plugins/docker-compose" && \
chmod +x $HOME/.docker/cli-plugins/docker-compose
```

--------------------------------

### MariaDB Docker Container Setup

Source: https://docs.linuxserver.io/general/swag

This snippet shows the docker create command for setting up a MariaDB container. It includes environment variables for user, password, database, and volume mapping for configuration.

```bash
docker create \
  --name=mariadb \
  --net=lsio \
  -e PUID=1000 \
  -e PGID=1000 \
  -e MYSQL_ROOT_PASSWORD=mariadbpassword \
  -e TZ=Europe/London \
  -e MYSQL_DATABASE=nextcloud \
  -e MYSQL_USER=ncuser \
  -e MYSQL_PASSWORD=ncpassword \
  -v /home/aptalca/appdata/mariadb:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/mariadb

```

--------------------------------

### User Identifier Output Example

Source: https://docs.linuxserver.io/images/docker-dokuwiki

Example output showing UID and GID values.

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

--------------------------------

### Run container with GPU support

Source: https://docs.linuxserver.io/selkies/user-guide/gpu

Example command to launch a container with GPU device access enabled.

```bash
docker run --rm -it \
  --shm-size=1gb \
  -p 3001:3001 \
  --device /dev/dri \
  lscr.io/linuxserver/webtop:ubuntu-kde bash
```

--------------------------------

### Create First User

Source: https://docs.linuxserver.io/images/docker-kimai

Execute the console command inside the running container to create an initial administrator account.

```shell
docker exec -it kimai console kimai:user:create your_username admin@example.com ROLE_SUPER_ADMIN
```

--------------------------------

### Configure Selkies application settings

Source: https://docs.linuxserver.io/images/docker-ardour?q=

Examples of environment variable formats for configuring Selkies UI settings.

```bash
-e SELKIES_USE_CPU="true|locked"
```

```bash
-e SELKIES_ENCODER="jpeg"
```

```bash
-e SELKIES_FRAMERATE="60"
```

--------------------------------

### Check for SNAP Docker Installation

Source: https://docs.linuxserver.io/FAQ

This command helps to determine if the SNAP version of Docker is installed on your system. It should be removed if present.

```bash
snap list | grep docker
```

--------------------------------

### Example User/Group ID Output

Source: https://docs.linuxserver.io/images/docker-apprise-api

This is an example of the output from the `id your_user` command, showing the uid, gid, and groups for a user.

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

```

--------------------------------

### Run Nvidia-enabled Container

Source: https://docs.linuxserver.io/selkies/user-guide/gpu

Example command to launch a container with GPU access and Vulkan support.

```bash
docker run --rm -it \
  --shm-size=1gb \
  -p 3001:3001 \
  --runtime nvidia \
  --gpus all \
  --device /dev/nvidia-modeset \
  lscr.io/linuxserver/webtop:ubuntu-kde bash
```

--------------------------------

### Deploy Your_Spotify with Docker CLI

Source: https://docs.linuxserver.io/images/docker-your_spotify

Alternative method for deploying the container using a single command-line instruction.

```bash
docker run -d \
  --name=your_spotify \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e APP_URL=http://localhost \
  -e SPOTIFY_PUBLIC= \
  -e SPOTIFY_SECRET= \
  -e SPOTIFY_API_DELAY_MS=2000 \
  -e CORS=http://localhost:80,https://localhost:443 \
  -e MONGO_ENDPOINT=mongodb://mongo:27017/your_spotify \
  -p 80:80 \
  -p 443:443 \
  --restart unless-stopped \
  lscr.io/linuxserver/your_spotify:latest
```

--------------------------------

### Deploy Kimai and MariaDB with Docker CLI

Source: https://docs.linuxserver.io/images/docker-kimai

Use these commands to manually start the Kimai and MariaDB containers via the Docker command line interface.

```bash
docker run -d \
  --name=kimai \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e APP_SECRET= \
  -e DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset&serverVersion=your_db_version \
  -e TRUSTED_HOSTS=kimai.example.com \
  -e TRUSTED_PROXIES=127.0.0.1/32 `#optional` \
  -p 80:80 \
  -p 443:443 \
  -v /path/to/kimai/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/kimai:latest

# This container requires an external application to be run separately.
docker run -d \
  --name=mariadb \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD \
  -e MYSQL_DATABASE=your_db_name `#optional` \
  -e MYSQL_USER=your_db_user `#optional` \
  -e MYSQL_PASSWORD=your_db_pass `#optional` \
  -p 3306:3306 \
  -v path_to_data:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/mariadb:latest
```

--------------------------------

### Start Docker-in-Docker (DinD) Environment

Source: https://docs.linuxserver.io/images/docker-azahar?q=

Starts a Docker-in-Docker (DinD) environment. For optimal performance, mount the Docker data directory from the host.

```bash
--privileged
```

--------------------------------

### Check Docker and Docker Compose Versions

Source: https://docs.linuxserver.io/FAQ

Verify the installed versions of Docker and Docker Compose. This is useful for confirming a successful installation and compatibility.

```bash
docker --version && docker compose version
```

--------------------------------

### Run a Webtop container

Source: https://docs.linuxserver.io/selkies/user-guide/apps

Deploys a Webtop container instance with shared memory allocation and volume mapping for configuration.

```bash
docker run -d \
  --name=webtop \
  --shm-size=1gb \
  -p 3001:3001 \
  -v /path/to/config:/config \
  lscr.io/linuxserver/webtop:ubuntu-kde
```
Tokens:
Raw