-
Notifications
You must be signed in to change notification settings - Fork 18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updates quickstart #1234
Updates quickstart #1234
Conversation
✅ Deploy Preview for pomerium-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
content/docs/quickstart.mdx
Outdated
|
||
# Run Pomerium Core With Docker | ||
1. Configure Pomerium Core and the Verify web app to run in Docker containers |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Links to pomerium core and verify would be nice.
content/docs/quickstart.mdx
Outdated
|
||
[Docker] and [Docker Compose] | ||
Install [Docker] and [Docker Compose]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe mention we of course support many other architectures and deployment styles (with a link) but for the quickstart we are going to bootstrap with docker.
```yaml | ||
# See detailed configuration settings: https://www.pomerium.com/docs/reference/ | ||
```yaml title="config.yaml" | ||
signing_key: LS0tLS1CRUdJTiBFQyBQUklWQVRFIEtFWS0tLS0tCk1IY0NBUUVFSURMV3Q3ZkczV2ZkYjk5elFHQTJObEJXcCt3d0c1aGJoR3MzY29JUlo2SjRvQW9HQ0NxR1NNNDkKQXdFSG9VUURRZ0FFcGtRRktLUUdqcVdzbDlYYkUwWmZLL2ZhbHJ2NENWSWtqSTlydXlCbHdOeDYzNmhZRnBtKwpNM0llTXNUKzRreExidVlZSGZDeUtjQzFnZ1BjSWpCYktRPT0KLS0tLS1FTkQgRUMgUFJJVkFURSBLRVktLS0tLQo= |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this accurate?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I used the command in our signing key reference page to generate this key. We also did something similar in our Enterprise Quickstart.
content/docs/quickstart.mdx
Outdated
|
||
::: | ||
|
||
## Set up Docker Compose |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: "Set up Docker Compose" gives me the impression that this is about installing Docker Compose; what about this instead?
## Set up Docker Compose | |
## Run Pomerium and the Verify application |
@@ -1,4 +1,4 @@ | |||
```yaml | |||
```yaml title="docker-compose.yaml" | |||
version: "3" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe version
is deprecated (https://forums.docker.com/t/do-you-need-to-put-the-version-at-the-top-of-docker-compose-yml-file/135863).
version: "3" |
|
||
If you want to try connecting Pomerium with other services, see some of our [Guides](/docs/guides). | ||
 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately this won't work with the latest version of the Verify app (since pomerium/verify@b8ce8e4). The Verify app will now correctly show a TLS error because Pomerium does not have a trusted certificate.
Co-authored-by: Kenneth Jenkins <[email protected]>
Co-authored-by: Kenneth Jenkins <[email protected]>
|
||
The Core quickstart uses Pomerium's [**Hosted Authenticate Service**](/docs/capabilities/hosted-authenticate-service), but you can also configure a [**self-hosted authenticate service**](/docs/capabilities/self-hosted-authenticate-service) to integrate with Pomerium. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
removing the self hosted callout was going to be my PR, but then I saw this. Excellent
This PR adds changes proposed in Content Review to the Quickstart guide.
TODO: Once we agree on the changes, we should have @ssveta7ak test to make sure it works.