--- title: librewolf --- # [linuxserver/librewolf](https://github.com/linuxserver/docker-librewolf) [![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Flibrewolf?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Flibrewolf) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-librewolf.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-librewolf) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-librewolf.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-librewolf/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-librewolf/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-librewolf/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/librewolf) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/librewolf.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/librewolf) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/librewolf.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/librewolf) [![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-librewolf%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-librewolf/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%2Flibrewolf%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/librewolf/latest/index.html) [LibreWolf](https://librewolf.net/) is a custom and independent version of Firefox, with the primary goals of privacy, security and user freedom. LibreWolf also aims to remove all the telemetry, data collection and annoyances, as well as disabling anti-freedom features like DRM. [![librewolf](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/librewolf-logo.png)](https://librewolf.net/) ## Supported Architectures 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/). Simply pulling `lscr.io/linuxserver/librewolf: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-\ | | arm64 | ❌ | | | 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](https://github.com/linuxserver/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](https://www.kasmweb.com/kasmvnc/docs/master/gpu_acceleration.html) allows you to specify the device to use IE `/dev/dri/renderD128` | | 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) | ### 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](https://www.kasmweb.com/docs/latest/how_to/lossless.html#technical-background). 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](https://github.com/linuxserver/docker-baseimage-kasmvnc#lossless). ## Usage To help you get started creating a container from this image you can either use docker-compose or the docker cli. ### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) ```yaml --- services: librewolf: image: lscr.io/linuxserver/librewolf:latest container_name: librewolf security_opt: - seccomp:unconfined #optional environment: - PUID=1000 - PGID=1000 - TZ=Etc/UTC - LIBREWOLF_CLI=https://www.linuxserver.io/ #optional volumes: - /path/to/config:/config 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=librewolf \ --security-opt seccomp=unconfined `#optional` \ -e PUID=1000 \ -e PGID=1000 \ -e TZ=Etc/UTC \ -e LIBREWOLF_CLI=https://www.linuxserver.io/ `#optional` \ -p 3000:3000 \ -p 3001:3001 \ -v /path/to/config:/config \ --shm-size="1gb" \ --restart unless-stopped \ lscr.io/linuxserver/librewolf:latest ``` ## Parameters Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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` | LibreWolf desktop gui. | | `3001` | LibreWolf desktop gui HTTPS. | ### 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). | | `LIBREWOLF_CLI=https://www.linuxserver.io/` | Specify one or multiple LibreWolf CLI flags, this string will be passed to the application in full. | ### 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. | ## 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 -e FILE__MYVAR=/run/secrets/mysecretvariable ``` Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` 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](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. In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below: ```bash id your_user ``` Example output: ```text uid=1000(your_user) gid=1000(your_user) groups=1000(your_user) ``` ## Docker Mods [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=librewolf&query=%24.mods%5B%27librewolf%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=librewolf "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: ```bash docker exec -it librewolf /bin/bash ``` * To monitor the logs of the container in realtime: ```bash docker logs -f librewolf ``` * Container version number: ```bash docker inspect -f '{{ index .Config.Labels "build_version" }}' librewolf ``` * Image version number: ```bash docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/librewolf:latest ``` ## Updating Info 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. Below are the instructions for updating containers: ### Via Docker Compose * Update images: * All images: ```bash docker-compose pull ``` * Single image: ```bash docker-compose pull librewolf ``` * Update containers: * All containers: ```bash docker-compose up -d ``` * Single container: ```bash docker-compose up -d librewolf ``` * You can also remove the old dangling images: ```bash docker image prune ``` ### Via Docker Run * Update the image: ```bash docker pull lscr.io/linuxserver/librewolf:latest ``` * Stop the running container: ```bash docker stop librewolf ``` * Delete the container: ```bash docker rm librewolf ``` * 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) !!! tip 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-librewolf.git cd docker-librewolf docker build \ --no-cache \ --pull \ -t lscr.io/linuxserver/librewolf:latest . ``` The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static` ```bash docker run --rm --privileged multiarch/qemu-user-static:register --reset ``` Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`. ## Versions * **09.04.24:** - Initial release.