Skip to content

Commit

Permalink
Updated Template install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
bhillkeyfactor committed Oct 31, 2023
1 parent 1179682 commit 3ae46f9
Showing 1 changed file with 26 additions and 6 deletions.
32 changes: 26 additions & 6 deletions readme_source.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,12 +137,32 @@ the CA. Without the imported configuration, the service will fail to start.

### Template Installation

1) Command Server - Copy and Unzip the Template Setup Files located [Here](https://github.com/Keyfactor/hydrantid-cagateway/raw/main/TemplateSetup.zip)
2) Command Server - Change the Security Settings in the CaTemplateUserSecurity.csv file to the appropriate settings for Test or Production
3) Command Server - Run the CreateTemplate.ps1 file and choose option 1 to create the templates in active directory.
*Note if you get errors the URL to the API or Security is likely wrong. Make sure the API calls are run with an administrator user in KF Command*
4) Command Server - Use the Keyfactor Portal to Import the Templates created in Active Directory in step #3 above
*Note there are default values for the API Url, UserId, and Password. You will have to override the default API Questions to the appropriate values.*
The Template section will map the CA's products to an AD template.
* ```ProductID```
This is the ID of the HydrantId product to map to the specified template. If you don't know the available product IDs in your Hydrant account, put a placeholder value here and run the Set-KeyfactorGatewayConfig cmdlet according to the AnyGateway documentation. The list of available product IDs will be returned.
* ```ValidityPeriod```
REQUIRED: The period to use when requesting certs. It could be, Days, Months, Years depending on the Template.
* ```ValidityUnits```
REQUIRED: The numeric value corresponding to the ValidityPeriod. For years 1 would be 1 year, for days 7 would be 7 days.

```json
"Templates": {
"AutoEnrollment - RSA": {
"ProductID": "AutoEnrollment - RSA",
"Parameters": {
"ValidityPeriod": "Years",
"ValidityUnits": 1
}
},
"AutoEnrollment - RSA - 7 Day": {
"ProductID": "AutoEnrollment - RSA - 7 Day",
"Parameters": {
"ValidityPeriod": "Days",
"ValidityUnits": 7
}
}
}
```

### Certificate Authority Installation
1) Gateway Server - Start the Keyfactor Gateway Service
Expand Down

0 comments on commit 3ae46f9

Please sign in to comment.