Skip to content
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

Closed
wants to merge 8 commits into from
Closed

Updates quickstart #1234

wants to merge 8 commits into from

Conversation

ZPain8464
Copy link
Contributor

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.

@ZPain8464 ZPain8464 requested a review from a team as a code owner February 7, 2024 16:21
Copy link

netlify bot commented Feb 7, 2024

Deploy Preview for pomerium-docs ready!

Name Link
🔨 Latest commit cd72057
🔍 Latest deploy log https://app.netlify.com/sites/pomerium-docs/deploys/65d3b9c797921c000894d0fe
😎 Deploy Preview https://deploy-preview-1234--pomerium-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.


# Run Pomerium Core With Docker
1. Configure Pomerium Core and the Verify web app to run in Docker containers
Copy link
Collaborator

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.


[Docker] and [Docker Compose]
Install [Docker] and [Docker Compose].
Copy link
Collaborator

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=
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this accurate?

Copy link
Contributor Author

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.

@ZPain8464 ZPain8464 requested a review from desimone February 13, 2024 19:24

:::

## Set up Docker Compose
Copy link
Contributor

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?

Suggested change
## Set up Docker Compose
## Run Pomerium and the Verify application

@@ -1,4 +1,4 @@
```yaml
```yaml title="docker-compose.yaml"
version: "3"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


If you want to try connecting Pomerium with other services, see some of our [Guides](/docs/guides).
![Accessing the Verify web app behind Pomerium](./img/quickstart/identity-verified.png)
Copy link
Contributor

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.

ZPain8464 and others added 2 commits February 14, 2024 15:41

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.
Copy link
Contributor

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

@ZPain8464 ZPain8464 requested a review from kenjenkins February 19, 2024 20:23
@ZPain8464 ZPain8464 closed this Feb 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants