From 2697d808486cc9b369869c5605a8018c3d38f862 Mon Sep 17 00:00:00 2001 From: Adrian Machado Date: Wed, 27 Dec 2023 17:40:34 -0800 Subject: [PATCH] Document the enabled setting for DP (#301) * Document the enabled setting for DP * Add link to auth * Fix bolding on auth page --- docs/articles/dev-portal-auth.md | 6 +++--- docs/articles/dev-portal-json.md | 7 +++++-- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/articles/dev-portal-auth.md b/docs/articles/dev-portal-auth.md index 27b33b7a..d8d08677 100644 --- a/docs/articles/dev-portal-auth.md +++ b/docs/articles/dev-portal-auth.md @@ -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 @@ -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` -** Refresh Token Expiration** +**Refresh Token Expiration** - **Absolute Expiration**: Enabled - **Absolute Lifetime**: Can be whatever time you want, default is `2592000` diff --git a/docs/articles/dev-portal-json.md b/docs/articles/dev-portal-json.md index b623e663..78922411 100644 --- a/docs/articles/dev-portal-json.md +++ b/docs/articles/dev-portal-json.md @@ -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 @@ -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 @@ -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