pellu-home
Docker app from Pellu Home Server's Repository
Pellu Home Server shares the videos (and their subtitles) in the folders you choose with the Pellu apps on your phones, tablets and TV at home.
Requirements
Overview
Readme
View on GitHubPellu Home Server for Linux and NAS
Pellu Home Server shares the videos in the folders you choose with the Pellu apps on your phones, tablets and TV at home. Files play as they are: nothing is converted, and nothing is uploaded to Pellu. You set it up from a settings page in your browser.
This repository holds this README and an example docker-compose.yml for the container image
ghcr.io/yonikrispil/pellu-home. The full guide, with steps for each NAS, is at
https://pellu.co/home-server/linux.
What's in the image
pellu-home, the server: one native binary (no runtime to install), serving the Pellu apps' API, the videos themselves (with seeking) and their subtitles on port 8484.- Its settings page, at
http://<address>:8484/admin: folders, linking to your Pellu account, the network and a password. - Bonjour (
_pellu-home._tcp), so the apps find the server on the home network by themselves. - A health check (
pellu-home --health) and an entrypoint that runs the server asPUID:PGID, never as root. - Built on
debian:trixie-slim, forlinux/amd64andlinux/arm64(a Raspberry Pi 4 or 5 with a 64-bit OS works).
Quick start
You need a NAS or a Linux computer with Docker that stays on while you watch, on the same home network as your devices, and a free Pellu account.
Save
docker-compose.ymlin a folder of its own. Change/path/to/mediato your media folder, andPUIDandPGIDto the user and group that own it (idshows them).Start it there:
docker compose up -dFind the setup code in the log:
docker logs pellu-homeIt's a line like
Pellu Home Server: open http://192.168.1.50:8484/admin and enter the setup code ABCD-EFGH.Open that address on a computer or phone at home, enter the code and choose a password.
Add your media folders (with Docker, they are the ones under
/media), then choose Link to account and type the code it shows in your account at https://pellu.co.Open Pellu on a phone, tablet or TV at home: the server's folders show up by themselves.
More folders? Add a line for each under volumes, inside /media, for example
/volume1/shows:/media/shows:ro.
Without host networking
Some systems don't allow network_mode: host. Then publish the port and give the server its
address on your home network, or your devices won't reach it:
ports:
- "8484:8484"
environment:
- PELLU_ADVERTISE_ADDRESS=192.168.1.50:8484
Bonjour doesn't work this way, so the apps find the server through your account.
To use the NAS's own Avahi for Bonjour instead of the server's built-in responder, also mount
/run/dbus/system_bus_socket:/run/dbus/system_bus_socket.
Settings
| Path or variable | What it is |
|---|---|
/config |
The settings (settings.json). Keep it on a volume. |
/media |
Your media folders, mounted read-only. Folders are picked in the settings page from under here. |
8484/tcp |
The settings page and the apps. |
PUID, PGID |
The user and group the server runs as (1000 unless set). |
PELLU_NAME |
The name the Pellu apps show. |
PELLU_ADMIN_PASSWORD |
The settings page's password, at least 8 characters (1.0.1 and newer). Used on the first start only, instead of the setup code in the log; change it later in the page. PELLU_ADMIN_PASSWORD_FILE reads it from a file and deletes the file. |
PELLU_ADVERTISE_ADDRESS |
Addresses sent to your account (ip or ip:port, comma-separated), for a bridge network. |
PELLU_PORT |
Another port instead of 8484. |
PELLU_SCAN_MINUTES |
A full scan every so many minutes (at least 15; 0: only at start and on demand). |
PELLU_LANG |
en or he: the log's language and the settings page's first language. |
PELLU_MDNS |
Bonjour: auto, avahi, builtin or off. |
PELLU_LOG_LEVEL |
debug, info, warn or error. |
TZ |
Your time zone. |
What's set in the environment is shown in the settings page but can't be changed there. Everything else is set in the page.
Unraid
templates/pellu-home.xml is the Unraid template (Community Applications), with this repository's
icon.png and ca_profile.xml. To add it by hand: in the Docker tab, Template repositories, add
https://github.com/yonikrispil/pellu-home, then Add Container and pick pellu-home.
TerraMaster
The TOS 7 packages (pellu-home_x86_64.deb, pellu-home_aarch64.deb, each with its .sha256) are in
this repository's Releases, where TerraMaster's
App Center picks them up. After install, the setup code for the settings page is in the public
shared folder, in Pellu Home Server setup code.txt, until a password is chosen.
Updating
docker compose pull && docker compose up -d
The settings in /config are kept.
Help
Questions or problems: choose Support in your account at https://pellu.co.
License
The files in this repository (the Unraid template, ca_profile.xml, docker-compose.yml, this
README and icon.png) are under the MIT license (LICENSE). Pellu Home Server itself, the
software in the image and in the Release packages, is free to use and proprietary: the MIT license
does not cover it.
Categories
Related apps
Explore more like this
Explore allLinks
Details
ghcr.io/yonikrispil/pellu-home:latestRuntime arguments
- Web UI
http://[IP]:[PORT:8484]/admin- Network
host- Shell
sh- Privileged
- false
Template configuration
The server's settings, kept between updates.
- Target
- /config
- Default
- /mnt/user/appdata/pellu-home
- Value
- /mnt/user/appdata/pellu-home
A media share, such as /mnt/user/media. More folders: add a path for each, inside /media (for example /media/Shows), read-only.
- Target
- /media/Media
The password for the WebUI, at least 8 characters. Used on the first start only: change it later in the WebUI. Empty: the WebUI asks for the setup code from the container's log.
- Target
- PELLU_ADMIN_PASSWORD
Optional: the name the Pellu apps show. Empty: the server's own name, which can then be changed in the WebUI (a name set here can't be).
- Target
- PELLU_NAME
The user the server runs as; it needs to read the media (99 is nobody).
- Default
- 99
- Value
- 99
The group the server runs as (100 is users).
- Default
- 100
- Value
- 100
The settings page and the Pellu apps. Used only on a bridge network; with host networking the server listens on 8484.
- Target
- 8484
- Default
- 8484
- Value
- 8484
Only on a bridge network: the server's address at home with the port, such as 192.168.1.50:8484, so the Pellu apps can reach it. Leave it empty with host networking.
- Target
- PELLU_ADVERTISE_ADDRESS