docker-documentation/docs/images/docker-chromium.md

422 wiersze
16 KiB
Markdown
Czysty Zwykły widok Historia

2023-03-18 22:48:51 +00:00
---
title: chromium
2025-01-29 09:26:39 +00:00
tags:
- Web Browser
description: "[Chromium](https://www.chromium.org/chromium-projects/) is an open-source browser project that aims to build a safer, faster, and more stable way for all users to experience the web."
2023-03-18 22:48:51 +00:00
---
2023-10-11 09:22:58 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read https://github.com/linuxserver/docker-chromium/blob/master/.github/CONTRIBUTING.md -->
2023-03-18 22:48:51 +00:00
# [linuxserver/chromium](https://github.com/linuxserver/docker-chromium)
2024-05-22 09:26:52 +00:00
[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fchromium?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh)
2023-03-18 22:48:51 +00:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-chromium.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-chromium)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-chromium.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-chromium/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-chromium/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-chromium/container_registry)
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/chromium)
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/chromium.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/chromium)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/chromium.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/chromium)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-chromium%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-chromium/job/master/)
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fchromium%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/chromium/latest/index.html)
[Chromium](https://www.chromium.org/chromium-projects/) is an open-source browser project that aims to build a safer, faster, and more stable way for all users to experience the web.
2023-10-11 09:22:58 +00:00
[![chromium](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/chromium-logo.png)](https://www.chromium.org/chromium-projects/)
2023-03-18 22:48:51 +00:00
## Supported Architectures
2023-11-22 09:22:26 +00:00
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
2023-03-18 22:48:51 +00:00
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 | ❌ | |
2025-07-01 14:22:38 +00:00
## 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 | ✅ | Latest releases using the selkies base |
| kasm | ✅ | Latest releases using the kasmvnc base |
2023-03-18 22:48:51 +00:00
## Application Setup
The application can be accessed at:
* https://yourhost:3001/
2024-11-09 20:42:01 +00:00
### Security
2025-06-26 19:05:28 +00:00
>[!WARNING]
>Do not put this on the Internet if you do not know what you are doing.
2024-11-09 20:42:01 +00:00
By default this container has no authentication and the optional environment variables `CUSTOM_USER` and `PASSWORD` to enable basic http auth via the embedded NGINX server should only be used to locally secure the container from unwanted access on a local network. If exposing this to the Internet we recommend putting it behind a reverse proxy, such as [SWAG](https://github.com/linuxserver/docker-swag), and ensuring a secure authentication solution is in place. From the web interface a terminal can be launched and it is configured for passwordless sudo, so anyone with access to it can install and run whatever they want along with probing your local network.
2025-06-26 19:05:28 +00:00
### Nvidia GPU Support
2024-11-09 20:42:01 +00:00
**Nvidia support is not compatible with Alpine based images as Alpine lacks Nvidia drivers**
Nvidia support is available by leveraging Zink for OpenGL support. This can be enabled with the following run flags:
| Variable | Description |
| :----: | --- |
| --gpus all | This can be filtered down but for most setups this will pass the one Nvidia GPU on the system |
| --runtime nvidia | Specify the Nvidia runtime which mounts drivers and tools in from the host |
The compose syntax is slightly different for this as you will need to set nvidia as the default runtime:
```
sudo nvidia-ctk runtime configure --runtime=docker --set-as-default
sudo service docker restart
```
And to assign the GPU in compose:
```
services:
chromium:
image: lscr.io/linuxserver/chromium:latest
deploy:
resources:
reservations:
devices:
- driver: nvidia
count: 1
capabilities: [compute,video,graphics,utility]
```
2025-06-26 19:05:28 +00:00
### Strict reverse proxies
2024-11-09 20:42:01 +00:00
2025-06-26 19:05:28 +00:00
This image uses a self-signed certificate by default. This naturally means the scheme is `https`.
If you are using a reverse proxy which validates certificates, you need to [disable this check for the container](https://docs.linuxserver.io/faq#strict-proxy).
2024-11-09 20:42:01 +00:00
2023-03-18 22:48:51 +00:00
## Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2024-12-04 09:35:02 +00:00
!!! info
Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided.
2023-03-18 22:48:51 +00:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
```yaml
---
services:
chromium:
image: lscr.io/linuxserver/chromium:latest
container_name: chromium
security_opt:
- seccomp:unconfined #optional
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
2023-04-06 17:15:19 +00:00
- CHROME_CLI=https://www.linuxserver.io/ #optional
2023-03-18 22:48:51 +00:00
volumes:
2025-07-01 14:22:38 +00:00
- /path/to/chromium/config:/config
2023-03-18 22:48:51 +00:00
ports:
- 3000:3000
- 3001:3001
shm_size: "1gb"
restart: unless-stopped
```
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
```bash
docker run -d \
--name=chromium \
--security-opt seccomp=unconfined `#optional` \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
2023-04-06 17:15:19 +00:00
-e CHROME_CLI=https://www.linuxserver.io/ `#optional` \
2023-03-18 22:48:51 +00:00
-p 3000:3000 \
-p 3001:3001 \
2025-07-01 14:22:38 +00:00
-v /path/to/chromium/config:/config \
2023-03-18 22:48:51 +00:00
--shm-size="1gb" \
--restart unless-stopped \
lscr.io/linuxserver/chromium:latest
```
## Parameters
2023-10-11 09:22:58 +00:00
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.
2023-03-18 22:48:51 +00:00
### Ports (`-p`)
| Parameter | Function |
| :----: | --- |
2025-06-26 19:05:28 +00:00
| `3000:3000` | HTTP Chromium desktop gui, must be proxied. |
2024-12-04 09:35:02 +00:00
| `3001:3001` | HTTPS Chromium desktop gui. |
2023-03-18 22:48:51 +00:00
### 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](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
2023-04-06 17:15:19 +00:00
| `CHROME_CLI=https://www.linuxserver.io/` | Specify one or multiple Chromium CLI flags, this string will be passed to the application in full. |
2023-03-18 22:48:51 +00:00
### 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:
```bash
2023-10-11 09:22:58 +00:00
-e FILE__MYVAR=/run/secrets/mysecretvariable
2023-03-18 22:48:51 +00:00
```
2023-10-11 09:22:58 +00:00
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
2023-03-18 22:48:51 +00:00
## 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](https://en.wikipedia.org/wiki/Umask) 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.
2023-10-11 09:22:58 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
2023-03-18 22:48:51 +00:00
```bash
2023-10-11 09:22:58 +00:00
id your_user
```
Example output:
```text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
2023-03-18 22:48:51 +00:00
```
## Docker Mods
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=chromium&query=%24.mods%5B%27chromium%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=chromium "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
We publish various [Docker Mods](https://github.com/linuxserver/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:
2023-10-11 09:22:58 +00:00
```bash
docker exec -it chromium /bin/bash
```
2023-03-18 22:48:51 +00:00
* To monitor the logs of the container in realtime:
2023-10-11 09:22:58 +00:00
```bash
docker logs -f chromium
```
* Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' chromium
```
* Image version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/chromium:latest
```
## Updating Info
2024-01-10 09:23:40 +00:00
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
2023-10-11 09:22:58 +00:00
Below are the instructions for updating containers:
### Via Docker Compose
* Update images:
* All images:
```bash
docker-compose pull
```
* Single image:
```bash
docker-compose pull chromium
```
* Update containers:
* All containers:
```bash
docker-compose up -d
```
* Single container:
```bash
docker-compose up -d chromium
```
* You can also remove the old dangling images:
```bash
docker image prune
```
### Via Docker Run
* Update the image:
```bash
docker pull lscr.io/linuxserver/chromium:latest
```
* Stop the running container:
```bash
docker stop chromium
```
* Delete the container:
```bash
docker rm chromium
```
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
* You can also remove the old dangling images:
```bash
docker image prune
```
### Image Update Notifications - Diun (Docker Image Update Notifier)
2024-10-02 09:30:54 +00:00
!!! tip
2023-10-11 09:22:58 +00:00
We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
## Building locally
If you want to make local modifications to these images for development purposes or just to customize the logic:
```bash
git clone https://github.com/linuxserver/docker-chromium.git
cd docker-chromium
docker build \
--no-cache \
--pull \
-t lscr.io/linuxserver/chromium:latest .
```
2024-11-09 20:42:01 +00:00
The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static`
2023-10-11 09:22:58 +00:00
```bash
2024-11-09 20:42:01 +00:00
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
2023-10-11 09:22:58 +00:00
```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
2023-03-18 22:48:51 +00:00
2024-12-18 09:30:15 +00:00
To help with development, we generate this dependency graph.
??? info "Init dependency graph"
```d2
"chromium:latest": {
docker-mods
base {
fix-attr +\nlegacy cont-init
}
docker-mods -> base
legacy-services
custom services
init-services -> legacy-services
init-services -> custom services
custom services -> legacy-services
legacy-services -> ci-service-check
init-migrations -> init-adduser
init-os-end -> init-config
2025-06-26 19:05:28 +00:00
init-selkies-end -> init-config
2024-12-18 09:30:15 +00:00
init-config -> init-config-end
init-crontab-config -> init-config-end
init-config -> init-crontab-config
init-mods-end -> init-custom-files
2025-05-21 09:32:08 +00:00
init-adduser -> init-device-perms
2024-12-18 09:30:15 +00:00
base -> init-envfile
base -> init-migrations
init-config-end -> init-mods
init-mods-package-install -> init-mods-end
init-mods -> init-mods-package-install
2025-06-26 19:05:28 +00:00
init-selkies -> init-nginx
2024-12-18 09:30:15 +00:00
init-adduser -> init-os-end
2025-05-21 09:32:08 +00:00
init-device-perms -> init-os-end
2024-12-18 09:30:15 +00:00
init-envfile -> init-os-end
2025-06-26 19:05:28 +00:00
init-os-end -> init-selkies
init-nginx -> init-selkies-config
init-video -> init-selkies-end
2024-12-18 09:30:15 +00:00
init-custom-files -> init-services
2025-06-26 19:05:28 +00:00
init-selkies-config -> init-video
2024-12-18 09:30:15 +00:00
init-services -> svc-cron
svc-cron -> legacy-services
init-services -> svc-de
svc-nginx -> svc-de
2025-06-26 19:05:28 +00:00
svc-xorg -> svc-de
2024-12-18 09:30:15 +00:00
svc-de -> legacy-services
init-services -> svc-docker
svc-de -> svc-docker
svc-docker -> legacy-services
init-services -> svc-nginx
svc-nginx -> legacy-services
init-services -> svc-pulseaudio
svc-pulseaudio -> legacy-services
2025-06-26 19:05:28 +00:00
init-services -> svc-selkies
svc-nginx -> svc-selkies
svc-pulseaudio -> svc-selkies
svc-xorg -> svc-selkies
svc-selkies -> legacy-services
init-services -> svc-xorg
svc-xorg -> legacy-services
2024-12-18 09:30:15 +00:00
}
Base Images: {
2025-06-26 19:05:28 +00:00
"baseimage-selkies:debianbookworm" <- "baseimage-debian:bookworm"
2024-12-18 09:30:15 +00:00
}
"chromium:latest" <- Base Images
```
2023-03-18 22:48:51 +00:00
## Versions
2025-07-01 14:22:38 +00:00
* **01.07.25:** - Add Kasm branch.
2025-06-26 19:05:28 +00:00
* **24.06.25:** - Rebase to Selkies.
2025-04-04 21:45:43 +00:00
* **03.04.25:** - Update chromium launch options to improve performance.
2024-02-11 00:37:45 +00:00
* **10.02.24:** - Update Readme with new env vars and ingest proper PWA icon.
2024-01-08 22:33:29 +00:00
* **08.01.24:** - Fix re-launch issue for chromium by purging temp files on launch.
* **29.12.23:** - Rebase to Debian Bookworm.
2023-05-14 15:37:28 +00:00
* **13.05.23:** - Rebase to Alpine 3.18.
2023-04-06 17:15:19 +00:00
* **01.04.23:** - Preserve arguments passed to Chromium and restructure to use wrapper.
2023-03-18 22:48:51 +00:00
* **18.03.23:** - Initial release.