linuxserver/docker-documentation

The repo behind...

Introduction

Welcome to the home of the LinuxServer.io documentation! It is our goal to ensure that all of our images are properly documented with all of the relevant information, in order to help our users get started. In addition to individual set up guides for each image, there is also general information, and best practices, pertaining to running Docker containers.

Want to get hold of the team?

The team resides primarily in our Discord server. We also have a forum if chat isn't your thing.

Where	Link
Discord	https://discord.gg/YWrKVTn
Forum	https://discourse.linuxserver.io

For those interested in our CI environment via Jenkins: https://ci.linuxserver.io/

docker-documentation's Issues

Add documentation about rootless use

I searched for "rootless" in the documentation but didn't find anything:
https://docs.linuxserver.io/?q=rootless

I see that using rootless Podman or rootless Docker is not supported.

containers/podman#15313 (comment)

containers/podman#15313 (comment)

Could you add a note to documentation (https://docs.linuxserver.io)
that using rootless Podman and rootless Docker is not supported?

Swag documentation's list of supported dns providers is outdated

The SWAG documentation page has one paragraph listing dns-provider plugins, but the list is outdated in relation to what providers are actually possible to use.

The paragraph could for example be reworded to end with "..., and many others (see docker-swag repo for an up to date list)"

500 error when creating container

When i try to add a new container, it gives me a 500 error. I tried also other images, but it still gives the same error.

Jellyfin Display Language

I am using QNAP Container Station for Jellyfin runnig. In general everything works fine except language changing doesnt work. I am choosing my native language but english still exist. How can I change display language?

Document / support mongodb replicaset mode for unifi-network-application

I would like to use an existing mongodb replicaset running in kubernetes, is there an existing method for connecting to a mongo replicaset or would this be new feature? Thank you for all the work that goes in to maintaining this container image!

SWAG missing `lsio` network example from docker-compose examples

The CLI examples mostly use --net=lsio to demonstrate an existing bridge network, but none of the docker-compose files have it. Was that intentional? I believe this is the correct syntax for that if you wish to include it. If not, no worries.

---
version: "2.1"
services:
  swag:
    image: ghcr.io/linuxserver/swag
    container_name: swag
    cap_add:
      - NET_ADMIN
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
      - URL=linuxserver-test.com
      - SUBDOMAINS=www,ombi
      - VALIDATION=http
    volumes:
      - /home/aptalca/appdata/swag:/config
    networks:
      lsio:
    ports:
      - 443:443
      - 80:80
    restart: unless-stopped

networks:
  lsio:
    external: true

nvidia no longer maintains nvidia-docker

Perhaps you need to update your documentation to use the latest way of calling the nvidia card.
https://github.com/NVIDIA/nvidia-docker

Booksonic Documentation should have Java options added.

Like the airsonic documentation, booksonic should have the Java options included in the docs.

This part from the application setup...

Extra java options can be passed with the JAVA_OPTS environment variable, eg -e JAVA_OPTS="-Xmx256m -Xms256m". For some reverse proxies, you may need to pass JAVA_OPTS=-Dserver.use-forward-headers=true for airsonic to generate the proper URL schemes.

as well as the compose and CLI examples.

- JAVA_OPTS=<options> #optional

Inconsistent use of PUID and PGID in environment section of docker-compose

"Understanding PUID and PGID" describes it as:
environment: PUID: 1000 PGID: 1000
Whereas all other pages I checked describes it as:
`environment:

• PUID=1000
• PGID=1000`
  There's the = vs : and the starting dash.
  The second is the correct use I have found.