pomerium / pomerium/documentation

Better document Pomerium as standalone solution.

Open
#21 1 comment 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

Many new Pomerium users begin by setting us up with Traefik or Ingress as the major traffic controller, using us in forward auth mode. Pomerium is a first class proxy and works best independently of competing services.

We want to better highlight that our Proxy service is build on Envoy, why it's production ready, and possibly why it's not a great idea to use us just for forwardAuth.

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

The issue names no files or tests; start by reviewing the existing documentation for Pomerium's Proxy service and forward-auth mode. Document the Envoy foundation, production-readiness rationale, standalone use case, and why using Pomerium only for forward auth may be unsuitable.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.