Skip to content

Commit

Permalink
WIP [DOCU-2126] rm duplicate ref
Browse files Browse the repository at this point in the history
  • Loading branch information
@falondarville @mheap
falondarville authored and mheap committed May 24, 2022
1 parent 68c4c68 commit 7e53c74
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 216 deletions.
83 changes: 1 addition & 82 deletions app/gateway/2.8.x/developer-portal/administration/managing-developers.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,87 +61,6 @@ Each developer is bcc'd by default for privacy. You may choose to edit the messa

![Invite Developers](https://konghq.com/wp-content/uploads/2018/05/invite-developers.png)


## Developer Management Property Reference


### portal_auto_approve

**Default:** `off`

**Description:**
Dev Portal Auto Approve Access.

When set to `on`, a developer will automatically be marked as `approved` after
completing Dev Portal registration. Access can still be revoked through
Kong Manager or the API.

When set to `off`, a Kong admin will have to manually approve the Developer
using Kong Manager or the API.


### portal_invite_email

**Default:** `on`

**Description:**
When enabled, Kong admins can invite developers to a Dev Portal by using
the Invite button in Kong Manager.


### portal_access_request_email

**Default:** `on`

**Description:**
When enabled, Kong admins specified by `smtp_admin_emails` will receive an email
when a developer requests access to a Dev Portal.

When disabled, Kong admins will have to manually check the Kong Manager to view
any requests.


### portal_approved_email

**Default:** `on`

**Description:**
When enabled, developers will receive an email when access to a Dev Portal has
been approved.

When disabled, developers will receive no indication that they have been
approved. It is suggested to only disable this feature if `portal_auto_approve`
is enabled.


### portal_reset_email

**Default:** `on`

**Description:**
When enabled, developers will be able to use the Reset Password flow on a Dev
Portal and will receive an email with password reset instructions.

When disabled, developers will *not* be able to reset their account passwords.
Kong Admins will have to manually create new credentials for the Developer in
the Kong Manager.

### portal_token_exp

**Default:** `21600`

**Description:**
Duration in seconds for the expiration of the Dev Portal reset password token.
Default is `21600` (six hours).


### portal_reset_success_email

**Default:** `on`

**Description:**
When enabled, developers will receive an email after successfully resetting
their Dev Portal account password.

When disabled, developers will still be able to reset their account passwords,
but will not receive a confirmation email.
For comprehensive documentation on developer management properties, see [Default Developer Portal Authentication](/gateway/{{page.kong_version}}/reference/configuration/#default-developer-portal-authentication-section).
138 changes: 4 additions & 134 deletions app/gateway/2.8.x/developer-portal/configuration/smtp.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,147 +3,17 @@ title: Dev Portal SMTP Configuration
badge: enterprise
---

The following property reference outlines each email and email variable used by the Dev Portal to send emails to Kong admins and developers.
Dev Portal enables SMTP configuration via email variables, which are used by the Dev Portal to send emails to Kong admins and developers.

For comprehensive documentation on SMTP configuration properties, see [Default Portal SMTP Configuration](/gateway/{{page.kong_version}}/reference/configuration/#default-portal-smtp-configuration-section).

These settings can be modified in the `Kong Manager` under the Dev Portal `Settings / Email` tab, or by running the following command:

```
```bash
curl http://localhost:8001/workspaces/<WORKSPACE_NAME> \
--data "config.<PROPERTY_NAME>=off"
```

If they are not modified manually, the Dev Portal will use the default value defined in the Kong Configuration file.

Dev Portal email content and styling can be customized via [template files](/gateway/{{page.kong_version}}/developer-portal/theme-customization/emails/).

## portal_invite_email

**Default:** `on`

**Description:**
When enabled, Kong admins will be able to invite developers to a Dev Portal by using the Invite button in the Kong Manager.

**Email:**
```
Subject: Invite to access Dev Portal <WORKSPACE_NAME>
Hello Developer!
You have been invited to create a Dev Portal account at %s.
Please visit `<DEV_PORTAL_URL/register>` to create your account.
```


## portal_email_verification

**Default:** `off`

**Description:**
When enabled, developers will receive an email upon registration to verify their account. Developers will not be able to use the Dev Portal until their account is verified, even if auto-approve is enabled.


## portal_access_request_email

**Default:** `on`

**Description:**
When enabled, Kong Admins specified by `smtp_admin_emails` will receive an email when a Developer requests access to a Dev Portal.

```
Subject: Request to access Dev Portal <WORKSPACE NAME>
Hello Admin!
<DEVELOPER NAME> has requested Dev Portal access for <WORKSPACE_NAME>.
Please visit <KONG_MANAGER_URL/developers/requested> to review this request.
```


## portal_approved_email

**Default:** `on`

**Description:**
When enabled, developers will receive an email when access to a Dev Portal has been approved.

```
Subject: Dev Portal access approved
Hello Developer!
You have been approved to access <WORKSPACE_NAME>.
Please visit <DEV PORTAL URL/login> to login.
```

## portal_reset_email

**Default:** `on`

**Description:**
When enabled, developers will be able to use the Reset Password flow on a Dev Portal and will receive an email with password reset instructions.

When disabled, developers will *not* be able to reset their account passwords.

```
Subject: Password Reset Instructions for Dev Portal <WORKSPACE_NAME>.
Hello Developer,
Please click the link below to reset your Dev Portal password.
<DEV_PORTAL_URL/reset?token=12345>
This link will expire in <portal_reset_token_exp>
If you didn't make this request, keep your account secure by clicking
the link above to change your password.
```

## portal_reset_success_email

**Default:** `on`

**Description:**
When enabled, developers will receive an email after successfully resetting their Dev Portal account password.

When disabled, developers will still be able to reset their account passwords, but will not receive a confirmation email.

```
Subject: Dev Portal password change success
Hello Developer,
We are emailing you to let you know that your Dev Portal password at <DEV_PORTAL_URL> has been changed.
Click the link below to sign in with your new credentials.
<DEV_PORTAL_URL>
```


## portal_emails_from

**Default:** `nil`

**Description:**
The name and email address for the 'From' header included in all Dev Portal emails.

**Example :**

```
portal_emails_from = Your Name <example@example.com>
```


## portal_emails_reply_to

**Default:** `nil`

**Description:**
The email address for the 'Reply-To' header included in all Dev Portal emails.


**Example :**

```
portal_emails_reply_to: noreply@example.com
```

0 comments on commit 7e53c74

Please sign in to comment.