Skip to content

Commit 4035f31

Browse files
committed
docs: de-emphasize env var, try to sell gui config of PAT
1 parent eba436b commit 4035f31

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,17 +56,18 @@ example of managing the service.
5656

5757
## Docker Installation
5858

59-
```shell
59+
```shell { name=docker }
6060
docker run -d \
6161
--name elly \
6262
--restart unless-stopped \
63-
-e GITHUB_PAT=ghp_your_token_here \
6463
-v elly-data:/data \
6564
-p 9876:9876 \
6665
ghcr.io/chelmertz/elly:latest
6766
```
6867

69-
If you have `gh` CLI installed and authenticated, you can use `$(gh auth token)` instead of a PAT:
68+
You can provide `GITHUB_PAT` via an environment variable. If you have `gh` CLI
69+
installed and authenticated, you can use `$(gh auth token)` instead of a PAT
70+
you stashed away somewhere:
7071

7172
```shell
7273
docker run -d \
@@ -79,6 +80,7 @@ docker run -d \
7980
```
8081

8182
This creates a named volume `elly-data` for the SQLite database (Docker manages it automatically).
83+
8284
The `--restart unless-stopped` flag ensures elly starts automatically on boot.
8385

8486
**Useful commands:**

dev.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,6 @@ make release
3939

4040
Requires a `.env` file with `GITHUB_PAT=...` (no `export` prefix).
4141

42-
```sh { name=docker }
42+
```sh { name=docker-compose }
4343
docker compose up --build
4444
```

0 commit comments

Comments
 (0)