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.

Sign up for GitHub

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

Document the enabled setting for DP #301

Merged
merged 3 commits into from
Dec 28, 2023
Merged

Document the enabled setting for DP #301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7eb4b49
Document the enabled setting for DP
AdrianMachado Dec 28, 2023
b4fc9ca
Add link to auth
AdrianMachado Dec 28, 2023
6adfd12
Fix bolding on auth page
AdrianMachado Dec 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/articles/dev-portal-auth.md
View file
Open in desktop
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
View file
Open in desktop
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