linuxserver/wps-office

The https://linuxserver.io team brings you another container release featuring:

• regular and timely application updates
• easy user mappings (PGID, PUID)
• custom base image with s6 overlay
• weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
• regular security updates

Find us at:

• https://blog.linuxserver.io - all the things you can do with our containers including How-To guides, opinions and much more!
• https://linuxserver.io/*** - realtime support / chat with the community and the team.
• https://discourse.linuxserver.io - post on our community forum.
• https://github.com/linuxserver - view the source for all of our repositories.
• https://opencollective.com/linuxserver - please *** helping us by either donating or contributing to our budget

https://github.com/linuxserver/docker-wps-office

WPS Office is a lightweight, feature-rich comprehensive office suite with high compatibility. As a handy and professional office software, WPS Office allows you to edit files in Writer, Presentation, Spreadsheet, and PDF to improve your work efficiency.

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list and our announcement https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/.

Simply pulling lscr.io/linuxserver/wps-office: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:

Application Setup

The application can be accessed at:

• [***]

Strict reverse proxies

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 https://docs.linuxserver.io/faq#strict-proxy.

This container is based on https://github.com/linuxserver/docker-baseimage-selkies, which streams a desktop or single application to your web browser. Only the essentials are covered below, the full platform documentation lives at https://docs.linuxserver.io/selkies/.

Start Minimal

Most support issues we see stem from large run configurations assembled from years of forum posts. These containers are designed to work with almost nothing. Start with the minimal command below, confirm it works, then add your options (volumes, env vars, GPU flags) one at a time:

bash
docker run --rm -it \
  --shm-size=1gb \
  -p 3001:3001 \
  lscr.io/linuxserver/wps-office:latest bash

Open https://localhost:3001 (note the https) and accept the self signed certificate warning. The trailing bash gives you a shell inside the container, ctrl+d exits and cleans everything up. If a bigger setup misbehaves, return to this command to isolate the problem, see the https://docs.linuxserver.io/selkies/user-guide/quickstart/ and https://docs.linuxserver.io/selkies/user-guide/troubleshooting/ guides.

GPU Acceleration

A GPU is optional, the CPU pipeline is fast enough for smooth sessions on modest hardware. When a GPU is mounted into the container it is automatically detected and configured for zero copy rendering and encoding, set AUTO_GPU=false to disable this behavior.

Intel / AMD (open source drivers), one flag is all it takes:

bash
docker run --rm -it \
  --shm-size=1gb \
  -p 3001:3001 \
  --device /dev/dri \
  lscr.io/linuxserver/wps-office:latest bash

Nvidia (proprietary drivers, not available on Alpine based images):

Requires host driver 580 or newer installed from the .run file downloaded directly from Nvidia. On drivers older than 595.80 you may also need kernel parameters and a dummy plug, see https://docs.linuxserver.io/selkies/user-guide/gpu/ before opening an issue.

bash
docker run --rm -it \
  --shm-size=1gb \
  -p 3001:3001 \
  --runtime nvidia \
  --gpus all \
  --device /dev/nvidia-modeset \
  lscr.io/linuxserver/wps-office:latest bash

Compose examples, multi GPU selection (DRINODE/DRI_NODE), Unraid notes, and a step by step debugging loop are in the https://docs.linuxserver.io/selkies/user-guide/gpu/ guide.

Security

[!WARNING] This container provides privileged access to the host system. Do not expose it to the Internet unless you have secured it properly.

HTTPS is required. Modern browser features used for video and audio (WebCodecs) only work in a secure context. Port 3001 serves HTTPS directly, the HTTP port exists only to sit behind a reverse proxy.

By default there is no authentication. Setting the CUSTOM_USER and PASSWORD environment variables enables HTTP basic auth, which is suitable only for a trusted local network. For internet exposure, place the container behind a reverse proxy with robust authentication, such as https://github.com/linuxserver/docker-swag. Keep in mind the web interface includes a terminal with passwordless sudo, anyone who can reach the GUI can gain root inside the container.

Authentication options, sharing link behavior, container isolation, and the lockdown variables for kiosk style deployments are covered in https://docs.linuxserver.io/selkies/user-guide/security/.

Language Support - Internationalization

To launch the session in a different language, set the LC_ALL environment variable, e.g. -e LC_ALL=zh_CN.UTF-8 (Chinese), ja_JP.UTF-8 (Japanese), ko_KR.UTF-8 (Korean), ar_AE.UTF-8 (Arabic), ru_RU.UTF-8 (***), es_MX.UTF-8 (Spanish Latin America), de_DE.UTF-8 (German), fr_FR.UTF-8 (French), nl_NL.UTF-8 (Dutch), it_IT.UTF-8 (Italian).

Beyond Running the App

This image inherits every capability of the Selkies platform, all documented in depth on the docs site:

• https://docs.linuxserver.io/selkies/user-guide/configuration/ - every environment variable: ports, subfolder reverse proxy, custom dashboards, watermarking, and the full set of SELKIES_* stream, feature, and UI settings with their |locked syntax.
• https://docs.linuxserver.io/selkies/user-guide/web-client/ - file transfer, clipboard sync, audio and microphone, up to four gamepads, session sharing, and mobile touch support.
• https://docs.linuxserver.io/selkies/user-guide/installing-apps/ - persistent user installed apps with https://github.com/linuxserver/proot-apps (proot-apps install filezilla) or native packages at boot with Docker mods.
• https://docs.linuxserver.io/selkies/user-guide/configuration/#optional-run-configurations - run --privileged for an isolated DinD setup, or mount /var/run/docker.sock to manage the host.
• https://docs.linuxserver.io/selkies/user-guide/reverse-proxy/ - proxying websockets and subfolders correctly.
• https://docs.linuxserver.io/selkies/components/sealskin/ - turnkey multi user VDI orchestration with browser extension and mobile apps, this image is fully compatible.
• https://docs.linuxserver.io/selkies/components/pelorus/ - expose the session to AI agents via a computer use API and accessibility stack.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

[!NOTE] Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided.

docker-compose (recommended, https://docs.linuxserver.io/general/docker-compose)

yaml
---
services:
  wps-office:
    image: lscr.io/linuxserver/wps-office:latest
    container_name: wps-office
    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 cli (https://docs.docker.com/engine/reference/commandline/cli/)

bash
docker run -d \
  --name=wps-office \
  -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/wps-office:latest

Parameters

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.

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 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

We publish various 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 wps-office /bin/bash
  

• To monitor the logs of the container in realtime:

  bash
  docker logs -f wps-office
  

• Container version number:

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' wps-office
  

• Image version number:

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/wps-office: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 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 wps-office
    

• Update containers:

  • All containers:

    bash
    docker-compose up -d
    

  • Single container:

    bash
    docker-compose up -d wps-office
    

• You can also remove the old dangling images:

  bash
  docker image prune
  

Via Docker Run

• Update the image:

  bash
  docker pull lscr.io/linuxserver/wps-office:latest
  

• Stop the running container:

  bash
  docker stop wps-office
  

• Delete the container:

  bash
  docker rm wps-office
  

• 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 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-wps-office.git
cd docker-wps-office
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/wps-office:latest .

The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static

bash
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

• 11.04.26: - Make Wayland default disable with PIXELFLUX_WAYLAND=false.
• 21.03.26: - Use Wayland ozone platform for chromium fixes scaling and acceleration.
• 28.12.25: - Add Wayland init logic.
• 10.07.25: - Rebase to Selkies HTTPS IS NOW REQUIRED, merge chinese and english image.
• 10.02.24: - Update Readme with new env vars and ingest proper PWA icon.
• 06.01.24: - Rebase to Debian Bookworm.
• 17.01.24: - Update Chromium wrapper.
• 21.04.23: - Initial release.