Skip to content

docs(readme): document bind-mount UID requirement in Docker quickstart#1525

Open
benfrank241 wants to merge 1 commit into
mainfrom
fix/readme-bind-mount-uid
Open

docs(readme): document bind-mount UID requirement in Docker quickstart#1525
benfrank241 wants to merge 1 commit into
mainfrom
fix/readme-bind-mount-uid

Conversation

@benfrank241
Copy link
Copy Markdown
Contributor

Summary

  • Adds a callout under the Docker quickstart explaining that the container runs as UID 1000 and the bind-mounted host directory must be writable by UID 1000, otherwise embedded PostgreSQL fails to start with Permission denied (os error 13).
  • Documents both fixes contributors are most likely to reach for: pre-creating the host dir and chown -R 1000:1000, or running the container as the host user via --user $(id -u):$(id -g). The --user path already works thanks to fix(docker): chmod 755 /home/hindsight for --user UID:GID support #1493 (chmod 755 /home/hindsight).
  • Mentions named volumes (-v hindsight-data:/home/hindsight/.pg0) as a no-chown option for users who don't need data on a host path.
  • Keeps the existing bind-mount default in the example so existing users copy-pasting the README continue to work.

Closes #1483

Test plan

  • Fresh macOS Docker Desktop run with chown 1000:1000 \$HOME/.hindsight-docker succeeds and serves http://localhost:8888
  • Fresh run with --user \$(id -u):\$(id -g) and host-UID-owned dir succeeds
  • Fresh run with named volume (-v hindsight-data:/home/hindsight/.pg0) succeeds
  • Without any of the above, the original failure (Permission denied (os error 13)) reproduces — confirming the callout addresses a real foot-gun

Adds a callout explaining that the container runs as UID 1000 and the
bind-mounted host directory must be writable by that UID, otherwise
embedded PostgreSQL fails with 'Permission denied (os error 13)'.
Documents both the chown 1000:1000 fix and the --user host-UID
alternative, and notes named volumes as a no-chown option.

Closes #1483
Copy link
Copy Markdown
Collaborator

@nicoloboschi nicoloboschi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd add a small note in the Docker installation section in the docs, not here - it's a very advanced details, doesn't fit well into readme

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README: document persistent volume host-uid ownership requirement

2 participants