Skip to content

Commit 8cf80b2

Browse files
Document PingData extension installation (#389)
BRASS-126
1 parent e5edaa5 commit 8cf80b2

File tree

3 files changed

+27
-0
lines changed

3 files changed

+27
-0
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Including Extensions in PingData Server Profiles
3+
---
4+
# Including Extensions in PingData Server Profiles
5+
Server SDK extension zip files can be included in your server profile for PingData products (PingAuthorize, PingDataSync, PingDirectory, and PingDirectoryProxy). The zip files can be included directly, or can be pulled from a remote URL when the container starts up.
6+
7+
# The pd.profile/server-sdk-extensions/ directory
8+
Any desired extension zip files should be included in the pd.profile/server-sdk-extensions/ directory of your server profile. Extension zip files in this directory will be installed during the setup process.
9+
10+
# Pulling extension zip files from an external URL
11+
The hook scripts support pulling down extension zip files from a defined URL, to avoid having to commit zip archives to a Git repository. To do this, a `remote.list` file should be included in the extensions/ directory of your server profile. Any file with a name ending in `remote.list` in the extensions/ directory will be treated as a list of extensions.
12+
13+
!!! note "Ensure extensions are in the right folder"
14+
When listing extensions to pull down via curl, the list must be placed in the extensions/ directory of the server profile. When directly including extension zip files, the zip files must be placed in the pd.profile/server-sdk-extensions/ directory of the server profile.
15+
16+
For an example, see the extension list included in our [baseline PingDirectory server profile](https://github.com/pingidentity/pingidentity-server-profiles/blob/master/baseline/pingdirectory/extensions/baseline.remote.list).
17+
18+
Separate multiple extensions with line breaks.
19+
20+
A URL can also be specified in the downloaded zip file. To do this, add a space between the extension zip URL and the URL that will provide the SHA1 hash. For example:
21+
```
22+
https://example.com/extension.zip https://example.com/extension/sha1
23+
```
24+
25+
Set the `ENABLE_INSECURE_REMOTE_EXTENSIONS` environment variable to `true` to allow installing extensions without the SHA1 hash check. By default the SHA1 check will be required. If a SHA1 URL is provided and the SHA does not match or the URL cannot be reached, the extension will not be installed.

docs/reference/profileStructures.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ Example at [getting-started/pingdirectory](https://github.com/pingidentity/pingi
106106
| pd.profile | Server profile matching the structure as defined by [PingDirectory Server Profiles](https://docs.pingidentity.com/bundle/pingdirectory-80/page/eae1564011467693.html) |
107107
| instance | Directories and files that you want to be used at product runtime, in accordance with the layout of the product. In general, this should be **non existing or empty**. |
108108
| env-vars | You can set environment variables used during deployment. See [Variables and Scope](variableScoping.md) for more info. In general, this should be **non existing or empty**. |
109+
| extensions | You can provide URLs to download Server SDK extensions in a remote.list file. See [Including Extensions in PingData Server Profiles](../how-to/profilesPingDataExtensions.md) for more info. |
109110

110111
!!! note "Ping Data Server Profile Best Practices"
111112
* In most circumstances, the `pd.profile` directory should be the only directory in the server profile.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ nav:
127127
- PingDirectory Profile: "how-to/buildPingDirectoryProfile.md"
128128
- Layering: "how-to/profilesLayered.md"
129129
- ENV Substitution: "how-to/profilesSubstitution.md"
130+
- Installing Extensions with PingData Profiles: "how-to/profilesPingDataExtensions.md"
130131
- Private Github Repos: "how-to/privateRepos.md"
131132
- Vault/Secrets: "how-to/usingVault.md"
132133
- Securing the Containers: "how-to/secureContainers.md"

0 commit comments

Comments
 (0)