Pelorus
Container
Pelorus is an AI navigator for Selkies-powered Linux desktops. Pelorus runs a FastAPI server that gives an LLM agent (Ollama, OpenAI-compatible, or Gemini) control over mouse, keyboard, screenshot, and window management via the Pixelflux computer-use backend, a Linux accessibility tree (AT-SPI), and optional KWin D-Bus integration.
Image details
Configuration
TypeContainerlinuxlinuxserver/pelorus:latest3001:3001/tcp/config : /srv/lsio/pelorus/configPUID=1000PGID=1000TZ=Etc/UTCunless-stoppedTemplate by technorabilia
Notes
Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.
mkdir -p /srv/lsio/pelorus/config
Standalone Install
Select an install method, to see config/commands for deploying Pelorus
Install on Portainer
Import all app templates into your Portainer instance, for easy 1-click deploys
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select Pelorus, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
More install options in our documentation.
linuxserver/pelorus
This readme has been truncated from the full version found HERE
Pelorus is an AI navigator for Selkies-powered Linux desktops. Pelorus runs a FastAPI server that gives an LLM agent (Ollama, OpenAI-compatible, or Gemini) control over mouse, keyboard, screenshot, and window management via the Pixelflux computer-use backend, a Linux accessibility tree (AT-SPI), and optional KWin D-Bus integration.Application Setup
https://github.com/user-attachments/assets/226bf96f-a6d6-46c2-95f4-677334dddd03Split Plane View
Pelorus ships with a split plane landing page served over HTTPS on port 3001. The left pane loads the raw Pelorus chat UI and the right pane loads your Selkies desktop session in an iframe. Both are also available directly via their subfolders:- Pelorus UI -
https://yourhost:3001/pelorus/ - Selkies Session -
https://yourhost:3001/selkies/
HTTP on port 3000 serves only the Selkies desktop session (no Pelorus UI).
LLM Provider
By default the agent is configured to use opencode big-pickle for demo purposes. Users are encouraged to link up their own paid providers or a locally hosted endpoint.If you would like to support opencode, you can sign up for opencode Go.
Provider Environment Variables
Set these to setup a provider on first boot:| Variable | Default | Description |
|---|---|---|
PELORUSPROVIDER | ollama | Provider type (ollama, openai, gemini) |
PELORUSENDPOINT | http://host:11434 | LLM API endpoint |
PELORUSMODEL | gemma4:12b | Model name |
PELORUSAPIKEY | (empty) | API key for the provider |
Example API Call
Use-k with curl to skip certificate verification (the container uses a self-signed cert by default):curl -k -s https://localhost:3001/pelorus/api/run \
-H 'Content-Type: application/json' \
-d '{"prompt":"open kate please","response_format":"minimal","stream":true}'Usage
docker run -d \
--name=pelorus \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-p 3001:3001 \
-v /path/to/pelorus/config:/config \
--shm-size="1gb" \
--restart unless-stopped \
lscr.io/linuxserver/pelorus:latestServe Pelorus on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.
Proxying pelorus.example.com to http://Pelorus:3001
Add this to your Caddyfile
pelorus.example.com {
reverse_proxy http://Pelorus:3001
}Check the logs first
Nine times out of ten the logs tell you exactly what went wrong.
- In Portainer, go to Containers, click the container, then Logs. Or run
docker logs Pelorus - Exit codes help too:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Port already in use
If deployment fails with "Bind for 0.0.0.0:3001 failed: port is already allocated", something else on your server is using that port.
- Find what's using it:
sudo ss -tlnp | grep :3001 - Stop the other service, or pick a different host port. In
3001:3001only the left number is yours to change, the right one belongs to the app.
Running but the page won't load
The container is up but nothing appears in your browser.
- Use your server's real IP:
http://your-server-ip:3001. The 0.0.0.0 link Portainer shows isn't a real address. - Give it a minute after first deploy, Pelorus can take a while to initialise.
- Make sure your firewall allows the port, e.g.
sudo ufw allow 3001
Permission denied on volumes
If the logs show "permission denied", the app can't write to its data folder on the host.
- Fix the ownership:
sudo chown -R 1000:1000 /srv/lsio/pelorus/config - Or set the
PUIDandPGIDvariables (defaults 1000:1000) to match your own user, found withid $USER
Image won't pull
Test the pull directly on the host: docker pull linuxserver/pelorus:latest
- "manifest unknown" means the tag no longer exists. This template uses
latest, so try pinning a specific version instead. - "toomanyrequests" is the Docker Hub rate limit. Log in with
docker loginto raise it. - "no space left on device" means a full disk. Reclaim space with
docker system prune
"exec format error"
This means the image was built for a different CPU architecture than your server.
- This image supports:
amd64 - Check yours with
uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.
Container keeps restarting
The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.
- Check the logs right after a restart, the last few lines before it died are the useful ones.
- Get the exit code with
docker inspect Pelorus --format '{{.State.ExitCode}}' - Still stuck? Redeploy once with the restart policy set to
noso the failure stays visible.
Raise an issue
Found something which isn't working as it should? Here's how to report it.
- Bug within the app: Open an issue within Pelorus's repo
- Template not working: Open an issue on technorabilia/portainer-templates
- This website not working: Open an issue on lissy93/portainer-templates
A single container
Pelorus runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.
The app image
An image is the app packed up ready to go, everything Pelorus needs bundled into one download. This template pulls linuxserver/pelorus:latest, which Docker fetches once (about 2.5 GB) and then starts your own copy from.
Where the image comes from
Docker pulls its images from registries, public libraries of ready-built apps. Pelorus's comes from Docker Hub, published by linuxserver.
Version tags
The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 0.2.3. Pin a specific tag if you would rather stay on one version.
Which machines it runs on
Every image is built for particular CPU types. This one ships for amd64, so it runs on regular x86 PCs and servers, though not ARM boards like a Raspberry Pi.
Ports
A port is the door the app answers on. A mapping like 3001:3001 means it's reachable on port 3001 of your server, where the left number is yours to change and the right one belongs to the app. It opens:
3001:3001
Volumes
A volume is where Pelorus keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:
/configfrom/srv/lsio/pelorus/configon the host
Environment variables
Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Pelorus takes 3 of them, all with defaults you can leave alone or tweak:
PUID, defaults to1000. Run 'id [USER]' for the owner of the host volume directories to get the UID to use here.PGID, defaults to1000. Run 'id [USER]' for the owner of the host volume directories to get the GID to use here.TZ, defaults toEtc/UTC. Specify a timezone to use, see this list.
Restart policy
The restart policy here is unless-stopped, so Docker restarts Pelorus after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).
Users and permissions
The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.
Networking
Nothing custom is set, so Pelorus sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.
Container name
Once it's deployed, Portainer names the container Pelorus. That's what you'll spot in the containers list and use in commands like docker logs Pelorus.
Platform
The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.
Portainer app templates
Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Pelorus up. Add the template list to Portainer once, then deploying Pelorus is a click rather than a wall of config.