Search…
⌃K

linuxserver/chromium

Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all users to experience the web.

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

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

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)

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
---
version: "2.1"
services:
chromium:
image: lscr.io/linuxserver/chromium:latest
container_name: chromium
security_opt:
- seccomp:unconfined #optional
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
volumes:
- /path/to/config:/config
ports:
- 3000:3000
- 3001:3001
shm_size: "1gb"
restart: unless-stopped
docker run -d \
--name=chromium \
--security-opt seccomp=unconfined `#optional` \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-p 3000:3000 \
-p 3001:3001 \
-v /path/to/config:/config \
--shm-size="1gb" \
--restart unless-stopped \
lscr.io/linuxserver/chromium:latest

Parameters

Docker images 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
3000
Chromium desktop gui.
3001
HTTPS Chromium desktop gui.

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
Users home directory in the container, stores local files and settings

Miscellaneous Options

Parameter
Function
--shm-size=
This is needed for any modern website to function like youtube.
--security-opt seccomp=unconfined
For Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker. Chromium runs in no-sandbox test mode without it.

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__PASSWORD=/run/secrets/mysecretpassword
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword 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 user as below:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker 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

  • Shell access whilst the container is running:
    • docker exec -it chromium /bin/bash
  • To monitor the logs of the container in realtime:
    • docker logs -f chromium
  • Container version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' chromium
  • Image version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/chromium:latest

Versions

  • 18.03.23: - Initial release.