From daa53aca2b9bb1d7c461e3bf79b6eaf3809dc0e2 Mon Sep 17 00:00:00 2001 From: Inch-high Date: Wed, 1 Apr 2026 20:54:19 +0100 Subject: [PATCH] docs: update quick start to use GHCR image with docker run Lead with docker run using the published image so users don't need to clone the repo. Docker Compose kept as an alternative. Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 281b8e2..7e4babe 100644 --- a/README.md +++ b/README.md @@ -29,23 +29,32 @@ Or follow: https://support.plex.tv/articles/204059436-finding-an-authentication- python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())" ``` -Save the output — you'll need it for the `ENCRYPTION_KEY` variable. +Save the output — you'll need it for the `ENCRYPTION_KEY` variable below. -### 3. Configure +### 3. Run ```bash -cp .env.example .env -# Edit .env with your PLEX_URL, PLEX_TOKEN, and ENCRYPTION_KEY +docker run -d \ + --name plexgeo \ + --restart unless-stopped \ + -p 7842:7842 \ + -v plexgeo_data:/data \ + -e PLEX_URL=http://your-plex-ip:32400 \ + -e PLEX_TOKEN=your-plex-token \ + -e ENCRYPTION_KEY=your-generated-key \ + ghcr.io/inch-high/plexgeo:latest ``` -### 4. Run +Dashboard will be at **http://localhost:7842** + +Alternatively, using Docker Compose: ```bash +cp .env.example .env +# Edit .env with your PLEX_URL, PLEX_TOKEN, and ENCRYPTION_KEY docker compose up -d ``` -Dashboard will be at **http://localhost:7842** - --- ## Configuration