Skip to content

Commit

Permalink
Updates Zero quickstart (#1463)
Browse files Browse the repository at this point in the history
* updates quickstart

* runs prettier
  • Loading branch information
ZPain8464 committed Jun 21, 2024
1 parent 6032e73 commit fbd819a
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 16 deletions.
Binary file modified content/docs/img/quickstart/pz-quickstart-policy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 20 additions & 7 deletions content/docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Replace the following values:
- **Line 8**: Replace `CLUSTER_TOKEN` with the cluster token generated for you in the onboarding config
- **Line 15**: Replace `CLUSTER_STARTER_SUBDOMAIN` with your generated starter subdomain

:::tip Where's my **Starter Domain?**
:::info Where's my **Starter Domain?**

You can find your **Starter Domain** at the top of the Zero Console navigation bar:

Expand Down Expand Up @@ -116,6 +116,12 @@ You should land on the Verify page:

![The homepage of the Verify app after the user is redirected](./img/quickstart/pz-identity-verified.png)

:::info Build your own route

Check out [**Pomerium Fundamentals: Build Routes**](/docs/courses/fundamentals/build-routes) to learn how to create a route to your own service behind Pomerium.

:::

### Connect to SSH

The demo SSH route connects to a remote server that you can use to test SSH connections in Pomerium Zero.
Expand Down Expand Up @@ -145,22 +151,29 @@ Warning: Permanently added 'ssh-demo.pomerium.com' (ED25519) to the list of know
This is an SSH honeypot. Everything is logged and monitored.
```

## Review authorization policy
## Review starter policy and certificates

Select the **Policies** tab. In the policies table, you'll notice the **Any Authenticated User** policy.
Select the **Policies** tab. In the policies table, you'll notice a default policy that only grants access if the user's email matches the one associated with your Pomerium Zero account:

![Reviewing the starter policy in the Zero Console](./img/quickstart/pz-quickstart-policy.png)

This is a simple policy that instructs Pomerium to allow all requests for authenticated users or service accounts. Because you authenticated successfully against our hosted identity provider, Pomerium granted you access to both the SSH and Verify services.
:::info Update policy

## Review certificates
This **Starter Policy** is assigned to both of the demo routes. You can remove this policy and create your own at any time.

- Go to the [**PPL page**](/docs/capabilities/ppl) to learn about Pomerium Policy Language
- Go to [**Build Policies**](/docs/courses/fundamentals/zero-build-policies) to learn how to create and assign policies using the Zero PPL builder

:::

Pomerium automatically provisions and manages TLS certificates issued by ZeroSSL to secure the starter routes in your cluster, and any routes you may build that use your cluster's starter domain.

To see certificates in your cluster, go to the **Certificates** tab:

![View cluster certificates from ZeroSSL](./img/quickstart/cluster-certs.png)
![View cluster certificates from ZeroSSL](./img/quickstart/pz-starter-certificates.png)

## Next Steps

### Add a [**Custom Domain**](/docs/capabilities/custom-domains)
### [**Build your First Route**](/docs/courses/fundamentals/zero-build-routes)

### [**Add a Custom Domain**](/docs/capabilities/custom-domains)
18 changes: 9 additions & 9 deletions content/docs/zero.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,23 @@ Welcome to **Pomerium Zero**, a hybrid-cloud zero-trust solution that provides c

## Get started

If you're new to Pomerium Zero, complete the **Zero Quickstart** first. The Zero Quickstart guides you through installing Pomerium Zero as a Docker container.
[**Zero Quickstart**](/docs/quickstart): If you're new to Pomerium Zero, complete the **Zero Quickstart** first. It guides you through installing Pomerium Zero as a Docker container and provides example routes, policies, and certificates to get you started.

Next, complete the **Pomerium Zero Fundamentals** courses. These courses are designed to teach you the basics of Pomerium so you can secure your services with confidence.
[**Pomerium Zero Fundamentals Courses**](/docs/courses): Next, complete our fundamentals courses. These courses are designed to teach you the basics of Pomerium so you can secure your apps and services with confidence.

## Learn

If you want to learn more about how Pomerium Zero works, see the following docs:

- Clusters in Pomerium Zero
- [Pomerium Policy Language](/docs/capabilities/ppl)
- [Routing](/docs/capabilities/routing)
- [Certificates](/docs/guides/certificates)
- [**What are Clusters?**](/docs/concepts/clusters)
- [**Pomerium Policy Language**](/docs/capabilities/ppl)
- [**Routing**](/docs/capabilities/routing)
- [**Certificates**](/docs/guides/certificates)

## Popular use cases

Check out these guides for real-world examples:

- [Jenkins](/docs/guides/jenkins)
- [Grafana](/docs/guides/grafana)
- [Code-server](/docs/guides/code-server)
- [**Jenkins**](/docs/guides/jenkins)
- [**Grafana**](/docs/guides/grafana)
- [**Code-server**](/docs/guides/code-server)

0 comments on commit fbd819a

Please sign in to comment.