[Feature]: Document and improve setup flow for Cloud Page user root assignment

Open
#17 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
70/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
docker, docker-compose
Domain
devops, documentation

Research direction

Start with the repository’s main deploy/setup flow and Docker Compose setup to find where self-hosted configuration is explained. Document the per-user root path, host-versus-container paths, a safe folder and database update example, and the checklist for Cloud root, database, JWT secret, and reverse proxy access. Done means all acceptance criteria are covered without requiring a helper script.

Written by the indexing model from the issue text.

Description

docker documentation enhancement

Problem

New self-hosted setups still require an admin to manually update the Cloud Page database so each user gets a valid root_folder_path.

This is easy to miss and confusing for new users. Example: a user can log in to Vault Web, but Cloud Page does not work until an admin manually creates the storage folder and updates the DB path to /host-cloud/<username>.

Proposed solution

Document this setup step in a more visible place and consider a small setup helper or runbook flow.

Scope:

  • explain why Cloud Page needs a per-user root path
  • document host path vs container path clearly, e.g. /data/vault-users/alice vs /host-cloud/alice
  • provide a safe example command for updating the user record
  • add a checklist for DB reachable, cloud root configured, JWT secret matching, and reverse proxy access
  • optionally add a script later that creates the folder and updates the DB for a username

Acceptance criteria

  • The manual Cloud Page user root assignment is documented in the main deploy/setup flow.
  • The docs include a clear example for creating the host folder and setting the container-visible DB path.
  • The docs warn against using host paths inside the Cloud Page DB.
  • A setup checklist covers Cloud root, DB, JWT secret, and reverse proxy basics.
  • The issue leaves room for a future helper script without requiring a full installer.
Dominant language
Dockerfile
Stars
2
Forks
1
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Vault-Web/deploy

All issues in Vault-Web/deploy

Similar issues

More DevOps issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.