Skip to content

Commit 45ee178

Browse files
author
codewec
committed
docs: run docker container
1 parent d23fdd6 commit 45ee178

2 files changed

Lines changed: 8 additions & 33 deletions

File tree

.env.example

Lines changed: 0 additions & 2 deletions
This file was deleted.

README.md

Lines changed: 8 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,11 @@
3434
Run a prebuilt image from GHCR:
3535

3636
```bash
37+
PUID="$(id -u 2>/dev/null || echo 1000)"
38+
PGID="$(id -g 2>/dev/null || echo 1000)"
39+
3740
docker run --name editoro \
38-
--user 1000:1000 \
41+
--user "${PUID}:${PGID}" \
3942
-p 3000:3000 \
4043
-v $(pwd)/data:/app/data \
4144
ghcr.io/codewec/editoro:latest
@@ -47,34 +50,6 @@ Run with Docker Compose:
4750

4851
Minimal `docker-compose.yml` (no `.env`):
4952

50-
```yaml
51-
services:
52-
editoro:
53-
image: ghcr.io/codewec/editoro:latest
54-
container_name: editoro
55-
restart: unless-stopped
56-
ports:
57-
- "3000:3000"
58-
volumes:
59-
- ./data:/app/data
60-
```
61-
62-
```bash
63-
mkdir -p data
64-
docker compose up -d
65-
```
66-
67-
If you need custom file ownership inside `./data`, use `.env` + full compose config:
68-
69-
`.env`
70-
71-
```env
72-
PUID=1000
73-
PGID=1000
74-
```
75-
76-
`docker-compose.yml`
77-
7853
```yaml
7954
services:
8055
editoro:
@@ -90,17 +65,19 @@ services:
9065
9166
```bash
9267
mkdir -p data
68+
export PUID="$(id -u 2>/dev/null || echo 1000)"
69+
export PGID="$(id -g 2>/dev/null || echo 1000)"
9370
docker compose pull
9471
docker compose up -d
9572
docker compose logs -f
9673
```
9774

98-
`PUID` and `PGID` define which host user/group owns newly created files in `./data` (default `1000:1000`).
75+
Always set `user` in compose config. Without it, new files and folders in `./data` will be created by `root`.
9976
If needed, align host directory permissions before startup:
10077

10178
```bash
10279
mkdir -p data
103-
sudo chown -R 1000:1000 data
80+
sudo chown -R "$(id -u 2>/dev/null || echo 1000):$(id -g 2>/dev/null || echo 1000)" data
10481
```
10582

10683
LXD quick start (example):

0 commit comments

Comments
 (0)