Skip to content

Commit

Permalink
Document the enabled setting for DP (#301)
Browse files Browse the repository at this point in the history
* Document the enabled setting for DP

* Add link to auth

* Fix bolding on auth page
  • Loading branch information
AdrianMachado authored Dec 28, 2023
1 parent e0d9f3e commit 2697d80
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs/articles/dev-portal-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Web Applications"

You must set the following fields in the Auth0 application:

** Application URIs**
**Application URIs**

- **Allowed Callback URLs**: Add your docs site url (i.e.
`https://my-app.zuplo.app/docs/`). Note, you should include the trailing
Expand All @@ -48,14 +48,14 @@ You must set the following fields in the Auth0 application:
- **Allowed Web Origins**: Add your docs site url without the path (i.e.
`https://my-app.zuplo.app`)

** Refresh Token Rotation**
**Refresh Token Rotation**

- **Rotation**: Enabled
- **Reuse Interval**: Leave at `0`

<Screenshot src="https://cdn.zuplo.com/assets/359f4a6c-4dd9-48c9-b8a3-27e70aa459c0.png" size="md" />

** Refresh Token Expiration**
**Refresh Token Expiration**

- **Absolute Expiration**: Enabled
- **Absolute Lifetime**: Can be whatever time you want, default is `2592000`
Expand Down
7 changes: 5 additions & 2 deletions docs/articles/dev-portal-json.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Config (dev-portal.json)
The `dev-portal.json` file is the code that drives most of the configuration of
your Zuplo Gateway. The primary uses of the `dev-portal.json` file are:

- Enabling or disabling features of the Gateway
- Enabling or disabling features of the Developer Portal
- Setting custom values to various configuration
- Mapping environment variables to settings

Expand Down Expand Up @@ -37,6 +37,8 @@ authentication to the [Developer Portal](../articles/developer-portal).

## Properties

- **enabled** - Determines whether the Developer Portal is enabled or disabled.
Default: true
- **pageTitle** - The title of the Developer Portal as seen in the tabs of most
browsers. Default: Zuplo Dev Portal.
- **faviconUrl** - The icon or 'favicon' for your Developer Portal, as seen in
Expand All @@ -53,7 +55,8 @@ authentication to the [Developer Portal](../articles/developer-portal).
Portal? This is required to enable self-serve of API keys. You must select an
Auth Provider if this is enabled - by default we give you a demo Auth0
configuration (you should not use this in production).
- **authentication** - Authentication settings
- **authentication** - Authentication settings. Checkout the
[setup guide](./dev-portal-auth.md) to get started.
- **provider** - Choose your preferred identity provider (Auth0, Okta, etc.).
Note, we provide you with a demonstration identity provider - this is fine
for learning how Zuplo works but should not be used in production or on real
Expand Down

1 comment on commit 2697d80

@vercel
Copy link

@vercel vercel bot commented on 2697d80 Dec 28, 2023

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

docs – ./

docs.zuplopreview.net
docs-git-main.zuplopreview.net
docs.zuplo.site

Please sign in to comment.