pomerium / pomerium/documentation

Could we amend documentation for Synology please?

Open
#20 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
MDX
Stars
13
Forks
23
Avg merge
1d 5h
Merged PRs (30d)
11

Description

Synology UI configuration is difficult to follow.

Synology config doesn't mention folder mapping is required:

  • /volume1/docker/pomerium:/pomerium:ro
  • /volume1/docker/pomerium/data:/pomerium:/data:rw

I'll take screenshots and post them here.

The documentation shows snippet of policy.yaml but doesn't mention where to place it for a newbie users.

The documentation requires output of base64 -i policy.yaml but doesn't mention how to obtain it. Does the user need to SSH to the Synology and run the command in the folder (e.g.: /volume1/docker/pomerium/)?

Is there any CONFIG environmental var required with base64 output?

Finally, could a sample config.yaml be inserted on the Synology page?

My idea there would be to get the user started without reading the rest of documentation and once they have the example they can read what they need.

Thanks very much in advance.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start with the Synology page and review its existing UI configuration, policy.yaml, and base64 instructions. Clarify the required folder mappings, where to place policy.yaml, how and where to run base64 -i policy.yaml, whether a CONFIG environment variable is needed, and add a sample config.yaml. Done means a new Synology user can follow the page without guessing these steps.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.