Skip to content

feat: add Unraid XML template with masked password fields #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Inch-high merged 1 commit into from
Apr 1, 2026
Merged

feat: add Unraid XML template with masked password fields #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,14 +89,23 @@ Available for `linux/amd64` and `linux/arm64`.

## Unraid

### Using the template (recommended)

1. Copy `unraid/my-plexgeo.xml` to `/boot/config/plugins/dockerMan/templates-user/` on your Unraid server
2. In the Docker tab, click **Add Container** and select **plexgeo** from the template dropdown
3. Fill in your Plex URL, token, and encryption key — sensitive fields are masked
4. Click **Apply**

### Manual setup

1. In the Unraid Docker tab, click **Add Container**
2. Set **Repository** to `ghcr.io/inch-high/plexgeo:latest`
3. Add a **Port** mapping: host `7842` → container `7842`
4. Add a **Path** mapping: host `/mnt/user/appdata/plexgeo` → container `/data`
5. Add **Variables**:
- `PLEX_URL` = your Plex server URL
- `PLEX_TOKEN` = your Plex token
- `ENCRYPTION_KEY` = your generated Fernet key
- `ENCRYPTION_KEY` = your generated key
6. Click **Apply**

---
Expand Down
26 changes: 26 additions & 0 deletions unraid/my-plexgeo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?xml version="1.0"?>
<Container version="2">
<Name>plexgeo</Name>
<Repository>ghcr.io/inch-high/plexgeo:latest</Repository>
<Registry>https://github.com/Inch-high/plexgeo/pkgs/container/plexgeo</Registry>
<Branch>
<Tag>latest</Tag>
<TagDescription>Latest stable release</TagDescription>
</Branch>
<Network>bridge</Network>
<Privileged>false</Privileged>
<Support>https://github.com/Inch-high/plexgeo/issues</Support>
<Project>https://github.com/Inch-high/plexgeo</Project>
<Overview>Stream intelligence dashboard for Plex — live world map, session logs, and anomaly alerts when users stream from unusual locations.</Overview>
<Category>MediaServer:Other</Category>
<Icon>https://raw.githubusercontent.com/Inch-high/plexgeo/main/unraid/plexgeo-icon.png</Icon>
<Description>PlexGeo monitors your Plex server, logs every user stream by IP and country, graphs trends over time, and raises anomaly alerts when a user streams from an unusual location.</Description>
<Config Name="Web UI" Target="7842" Default="7842" Mode="tcp" Type="Port" Display="always">7842</Config>
<Config Name="Data" Target="/data" Default="/mnt/user/appdata/plexgeo" Mode="rw" Type="Path" Display="always">/mnt/user/appdata/plexgeo</Config>
<Config Name="Plex URL" Target="PLEX_URL" Default="" Type="Variable" Display="always" Required="true" Description="URL of your Plex server, e.g. http://192.168.1.50:32400"></Config>
<Config Name="Plex Token" Target="PLEX_TOKEN" Default="" Type="Variable" Display="password" Required="true" Description="Your Plex authentication token (X-Plex-Token)"></Config>
<Config Name="Encryption Key" Target="ENCRYPTION_KEY" Default="" Type="Variable" Display="password" Required="true" Description="Encryption key for sensitive settings. Generate with: openssl rand -base64 32"></Config>
<Config Name="Poll Interval" Target="POLL_INTERVAL" Default="30" Type="Variable" Display="always" Description="Seconds between Plex polls">30</Config>
<Config Name="Outlier Threshold" Target="OUTLIER_THRESHOLD" Default="0.10" Type="Variable" Display="always" Description="A country must account for less than this fraction of sessions to be flagged">0.10</Config>
<Config Name="Outlier Min Sessions" Target="OUTLIER_MIN_SESSIONS" Default="5" Type="Variable" Display="always" Description="Minimum sessions before outlier detection kicks in">5</Config>
</Container>
Loading