Skip to content

Commit 76f20df

Browse files
author
Keyfactor
committed
Update generated docs
1 parent 911ec8e commit 76f20df

1 file changed

Lines changed: 11 additions & 76 deletions

File tree

README.md

Lines changed: 11 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<h1 align="center" style="border-bottom: none">
2-
Sectigo Metadata Sync Universal Orchestrator Extension
2+
Sectigo Metadata Sync
33
</h1>
44

55
<p align="center">
@@ -14,21 +14,23 @@
1414
<!-- TOC -->
1515
<a href="#support">
1616
<b>Support</b>
17-
</a>
18-
·
19-
<a href="#installation">
20-
<b>Installation</b>
21-
</a>
17+
</a>
2218
·
2319
<a href="#license">
2420
<b>License</b>
2521
</a>
2622
·
27-
<a href="https://github.com/orgs/Keyfactor/repositories?q=orchestrator">
23+
<a href="https://github.com/topics/keyfactor-integration">
2824
<b>Related Integrations</b>
2925
</a>
3026
</p>
3127

28+
## Support
29+
The Sectigo Metadata Sync is open source and there is **no SLA**. Keyfactor will address issues as resources become available. Keyfactor customers may request escalation by opening up a support ticket through their Keyfactor representative.
30+
31+
> To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)** tab.
32+
33+
3234
## Overview
3335

3436
This tool automates the synchronization of metadata fields between Sectigo and Keyfactor. It performs two primary operations:
@@ -41,74 +43,6 @@ Fields listed in `fields.json` that do not already exist in Keyfactor will be cr
4143
4244
---
4345

44-
45-
46-
## Compatibility
47-
48-
This integration is compatible with Keyfactor Universal Orchestrator version N/A and later.
49-
50-
## Support
51-
The Sectigo Metadata Sync Universal Orchestrator extension If you have a support issue, please open a support ticket by either contacting your Keyfactor representative or via the Keyfactor Support Portal at https://support.keyfactor.com.
52-
53-
> To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)** tab.
54-
55-
## Requirements & Prerequisites
56-
57-
Before installing the Sectigo Metadata Sync Universal Orchestrator extension, we recommend that you install [kfutil](https://github.com/Keyfactor/kfutil). Kfutil is a command-line tool that simplifies the process of creating store types, installing extensions, and instantiating certificate stores in Keyfactor Command.
58-
59-
60-
61-
## Certificate Store Type
62-
63-
To use the Sectigo Metadata Sync Universal Orchestrator extension, you **must** create the Certificate Store Type. This only needs to happen _once_ per Keyfactor Command instance.
64-
65-
66-
67-
## Installation
68-
69-
1. **Download the latest Sectigo Metadata Sync Universal Orchestrator extension from GitHub.**
70-
71-
Navigate to the [Sectigo Metadata Sync Universal Orchestrator extension GitHub version page](https://github.com/Keyfactor/sectigo-metadata-sync/releases/latest). Refer to the compatibility matrix below to determine whether the `net6.0` or `net8.0` asset should be downloaded. Then, click the corresponding asset to download the zip archive.
72-
73-
| Universal Orchestrator Version | Latest .NET version installed on the Universal Orchestrator server | `rollForward` condition in `Orchestrator.runtimeconfig.json` | `sectigo-metadata-sync` .NET version to download |
74-
| --------- | ----------- | ----------- | ----------- |
75-
| Older than `11.0.0` | | | `net6.0` |
76-
| Between `11.0.0` and `11.5.1` (inclusive) | `net6.0` | | `net6.0` |
77-
| Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `Disable` | `net6.0` |
78-
| Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `LatestMajor` | `net8.0` |
79-
| `11.6` _and_ newer | `net8.0` | | `net8.0` |
80-
81-
Unzip the archive containing extension assemblies to a known location.
82-
83-
> **Note** If you don't see an asset with a corresponding .NET version, you should always assume that it was compiled for `net6.0`.
84-
85-
2. **Locate the Universal Orchestrator extensions directory.**
86-
87-
* **Default on Windows** - `C:\Program Files\Keyfactor\Keyfactor Orchestrator\extensions`
88-
* **Default on Linux** - `/opt/keyfactor/orchestrator/extensions`
89-
90-
3. **Create a new directory for the Sectigo Metadata Sync Universal Orchestrator extension inside the extensions directory.**
91-
92-
Create a new directory called `sectigo-metadata-sync`.
93-
> The directory name does not need to match any names used elsewhere; it just has to be unique within the extensions directory.
94-
95-
4. **Copy the contents of the downloaded and unzipped assemblies from __step 2__ to the `sectigo-metadata-sync` directory.**
96-
97-
5. **Restart the Universal Orchestrator service.**
98-
99-
Refer to [Starting/Restarting the Universal Orchestrator service](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/StarttheService.htm).
100-
101-
102-
103-
> The above installation steps can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/CustomExtensions.htm?Highlight=extensions).
104-
105-
106-
107-
## Defining Certificate Stores
108-
109-
110-
111-
11246
## Installation and Usage
11347

11448
1. **Prerequisites**
@@ -448,10 +382,11 @@ Always restart the tool after modifying `NLog.config` to ensure changes take eff
448382
---
449383

450384

385+
451386
## License
452387

453388
Apache License 2.0, see [LICENSE](LICENSE).
454389

455390
## Related Integrations
456391

457-
See all [Keyfactor Universal Orchestrator extensions](https://github.com/orgs/Keyfactor/repositories?q=orchestrator).
392+
See all [Keyfactor integrations](https://github.com/topics/keyfactor-integration).

0 commit comments

Comments
 (0)