added hedgedoc guide #141
Closed
added hedgedoc guide #141
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
✅ Deploy Preview for pomerium-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
cmo-pomerium
approved these changes
Oct 19, 2022
calebdoxsey
reviewed
Oct 24, 2022
calebdoxsey
reviewed
Oct 24, 2022
calebdoxsey
reviewed
Oct 24, 2022
calebdoxsey
reviewed
Oct 24, 2022
desimone
reviewed
Oct 24, 2022
content/docs/guides/hedgedoc.md
Outdated
|
|
||
| ### Pomerium configuration | ||
|
|
||
| Your Pomerium configuration file must include a [Cookie Secret](https://www.pomerium.com/docs/reference/cookie-secret) and a [Secret Key](https://www.pomerium.com/docs/reference/signing-key). |
There was a problem hiding this comment.
Ideally, we could use relative urls here so docusaurus can detect any broken links.
content/docs/guides/hedgedoc.md
Outdated
| - [Docker](https://www.docker.com/) | ||
| - [Docker Compose](https://docs.docker.com/compose/install/) | ||
| - A running Pomerium instance | ||
| - A [preconfigured IdP](https://www.pomerium.com/docs/identity-providers) |
There was a problem hiding this comment.
Can we use relative urls here and point to the markdown file so docusaurus can detect any broken inks?
content/docs/guides/hedgedoc.md
Outdated
|
|
||
| ## Integrate Pomerium with HedgeDoc | ||
|
|
||
| HedgeDoc is open-source, self-hosted software that allows you to configure authentication and authorization with a [reverse proxy](https://docs.hedgedoc.org/guides/reverse-proxy/). |
There was a problem hiding this comment.
Suggested change
| HedgeDoc is open-source, self-hosted software that allows you to configure authentication and authorization with a [reverse proxy](https://docs.hedgedoc.org/guides/reverse-proxy/). | |
| HedgeDoc is open-source, self-hosted software that allows you to configure authentication and authorization with a [reverse proxy](https://docs.hedgedoc.org/guides/reverse-proxy/). |
Not sure if the pre-pended spaces here are intentional.
content/docs/guides/hedgedoc.md
Outdated
|
|
||
|  | ||
|
|
||
| ### Set up your environment |
There was a problem hiding this comment.
Thoughts on linking to the docker-based quick start instead, and just referencing that we assume users have a completed version of the quick-start (docker based) as a starting point?
content/docs/guides/hedgedoc.md
Outdated
| In your `docker-compose.yaml` file, add the following code under your Pomerium services: | ||
|
|
||
| ```yaml | ||
| # verify: |
There was a problem hiding this comment.
This seems accidentally left behind?
content/docs/guides/hedgedoc.md
Outdated
| Lastly, you must enable your Pomerium proxy to enable [Websocket Connections](https://www.pomerium.com/docs/reference/routes/websocket-connections): | ||
|
|
||
| ```yaml | ||
| allow_websockets: true |
There was a problem hiding this comment.
Ideally, we could have a minimal but complete config.yaml that includes a route and policy pointing to hedgedoc here.
There was a problem hiding this comment.
we'd want a route:
routes:
- from: https://verify.localhost.pomerium.io
to: http://verify:8000
pass_identity_headers: true
allow_any_authenticated_user: true
- from: https://hedgedoc.localhost.pomerium.io
to: http://hedgedoc:3000
pass_identity_headers: true
allow_any_authenticated_user: true
Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
Co-authored-by: cmo-pomerium <91488121+cmo-pomerium@users.noreply.github.com>
Co-authored-by: cmo-pomerium <91488121+cmo-pomerium@users.noreply.github.com>
Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
calebdoxsey
requested changes
Nov 8, 2022
content/docs/guides/hedgedoc.md
Outdated
| environment: | ||
| - CMD_DB_URL=postgres://hedgedoc:password@database:5432/hedgedoc | ||
| - CMD_DOMAIN=localhost | ||
| - CMD_URL_ADDPORT=true |
There was a problem hiding this comment.
Suggested change
| - CMD_URL_ADDPORT=true | |
| - CMD_URL_ADDPORT=false |
content/docs/guides/hedgedoc.md
Outdated
| Lastly, you must enable your Pomerium proxy to enable [Websocket Connections](https://www.pomerium.com/docs/reference/routes/websocket-connections): | ||
|
|
||
| ```yaml | ||
| allow_websockets: true |
There was a problem hiding this comment.
we'd want a route:
routes:
- from: https://verify.localhost.pomerium.io
to: http://verify:8000
pass_identity_headers: true
allow_any_authenticated_user: true
- from: https://hedgedoc.localhost.pomerium.io
to: http://hedgedoc:3000
pass_identity_headers: true
allow_any_authenticated_user: trueCo-authored-by: Caleb Doxsey <caleb@doxsey.net>
deleted hedgedoc img
deleted pomerium auth flow img for hedgedoc guide
deleted gh idp img for hedgedoc guide
deleted user details img for hedgedoc guide
deleted hedgedoc guide
deleted sign-in-prompt for hedgedoc guide
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a HedgeDoc integration guide with screenshots and a diagram illustrating the auth flow with Pomerium's IAP services, the IdP, and the secured app.