Skip to content

Commit fb3992a

Browse files
spbsolublespbsoluble
committed
chore(docs): Fix auth providers doc link
1 parent a0d2f2c commit fb3992a

File tree

2 files changed

+54
-45
lines changed

2 files changed

+54
-45
lines changed

‎README.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
- [Keyfactor Command Utility (kfutil)](#keyfactor-command-utility--kfutil-)
2-
- [Integration status: Production - Ready for use in production environments.](#integration-status--production---ready-for-use-in-production-environments)
3-
* [Support for Keyfactor Command Utility (kfutil)](#support-for-keyfactor-command-utility--kfutil-)
4-
* [Quickstart](#quickstart)
5-
+ [Prerequisites:](#prerequisites-)
6-
+ [Installation:](#installation-)
7-
+ [Environmental Variables](#environmental-variables)
8-
* [Authentication Providers](#authentication-providers)
9-
* [Commands](#commands)
10-
+ [Login](#login)
11-
+ [Logout](#logout)
12-
* [Commands](#commands-1)
13-
+ [Bulk operations](#bulk-operations)
14-
- [Bulk create cert stores](#bulk-create-cert-stores)
15-
- [Bulk create cert store types](#bulk-create-cert-store-types)
16-
+ [Root of Trust](#root-of-trust)
17-
+ [Root of Trust Quickstart](#root-of-trust-quickstart)
18-
- [Generate Certificate List Template](#generate-certificate-list-template)
19-
- [Generate Certificate Store List Template](#generate-certificate-store-list-template)
20-
- [Run Root of Trust Audit](#run-root-of-trust-audit)
21-
- [Run Root of Trust Reconcile](#run-root-of-trust-reconcile)
22-
+ [Certificate Store Inventory](#certificate-store-inventory)
23-
- [Show the inventory of a certificate store](#show-the-inventory-of-a-certificate-store)
24-
- [Add certificates to certificate stores](#add-certificates-to-certificate-stores)
25-
- [Remove certificates from certificate stores](#remove-certificates-from-certificate-stores)
26-
* [Development](#development)
27-
+ [Adding a new command](#adding-a-new-command)
28-
2+
- [Integration status: Production - Ready for use in production environments.](#integration-status--production---ready-for-use-in-production-environments)
3+
4+
* [Support for Keyfactor Command Utility (kfutil)](#support-for-keyfactor-command-utility--kfutil-)
5+
* [Quickstart](#quickstart)
6+
+ [Prerequisites:](#prerequisites-)
7+
+ [Installation:](#installation-)
8+
+ [Environmental Variables](#environmental-variables)
9+
* [Authentication Providers](#authentication-providers)
10+
* [Commands](#commands)
11+
+ [Login](#login)
12+
+ [Logout](#logout)
13+
* [Commands](#commands-1)
14+
+ [Bulk operations](#bulk-operations)
15+
- [Bulk create cert stores](#bulk-create-cert-stores)
16+
- [Bulk create cert store types](#bulk-create-cert-store-types)
17+
+ [Root of Trust](#root-of-trust)
18+
+ [Root of Trust Quickstart](#root-of-trust-quickstart)
19+
- [Generate Certificate List Template](#generate-certificate-list-template)
20+
- [Generate Certificate Store List Template](#generate-certificate-store-list-template)
21+
- [Run Root of Trust Audit](#run-root-of-trust-audit)
22+
- [Run Root of Trust Reconcile](#run-root-of-trust-reconcile)
23+
+ [Certificate Store Inventory](#certificate-store-inventory)
24+
- [Show the inventory of a certificate store](#show-the-inventory-of-a-certificate-store)
25+
- [Add certificates to certificate stores](#add-certificates-to-certificate-stores)
26+
- [Remove certificates from certificate stores](#remove-certificates-from-certificate-stores)
27+
* [Development](#development)
28+
+ [Adding a new command](#adding-a-new-command)
2929

3030
# Keyfactor Command Utility (kfutil)
3131

@@ -113,12 +113,12 @@ $env:KFUTIL_DEBUG=0 # Set to 1 or true to enable debug logging
113113

114114
`kfutil` supports the following authentication providers in order of precedence:
115115

116-
| Provider Type | Description |
117-
|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
118-
| Azure Key Vault via Azure ID | This provider will read the Keyfactor Command credentials from Azure Key Vault. For more info review the [auth providers](docs/auth_providers#azure-key-vault) docs. |
119-
| Environment | This provider will read the Keyfactor Command credentials from the environment variables listed above. |
120-
| File | This is the default provider. It will read the credentials from a file on disk at `$HOME/.keyfactor/command_config.json` |
121-
| User Interactive | This provider will prompt the user for their credentials. |
116+
| Provider Type | Description |
117+
|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
118+
| Azure Key Vault via Azure ID | This provider will read the Keyfactor Command credentials from Azure Key Vault. For more info review the [auth providers](docs/auth_providers.md#azure-key-vault) docs. |
119+
| Environment | This provider will read the Keyfactor Command credentials from the environment variables listed above. |
120+
| File | This is the default provider. It will read the credentials from a file on disk at `$HOME/.keyfactor/command_config.json` |
121+
| User Interactive | This provider will prompt the user for their credentials. |
122122

123123
## Commands
124124

‎readme_source.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
## Quickstart
22

33
### Prerequisites:
4+
45
- [Github CLI](https://cli.github.com/)
5-
- [zip](https://linuxize.com/post/how-to-unzip-files-in-linux/#installing-unzip) CLI tool, used to unzip the release files.
6+
- [zip](https://linuxize.com/post/how-to-unzip-files-in-linux/#installing-unzip) CLI tool, used to unzip the release
7+
files.
68
- `$HOME/.local/bin` in your `$PATH` and exists.
79

810
### Installation:
11+
912
```bash
1013
bash <(curl -s https://raw.githubusercontent.com/Keyfactor/kfutil/main/gh-dl-release.sh)
1114
````
@@ -26,28 +29,33 @@ and use them if they are set. If they are not set, the utility will fail to conn
2629
| KFUTIL_DEBUG | Set to `1` or `true` to enable debug logging. |
2730

2831
Linux/MacOS:
32+
2933
```bash
3034
export KEYFACTOR_HOSTNAME="<mykeyfactorhost.mydomain.com>"
3135
export KEYFACTOR_USERNAME="<myusername>" # Do not include domain
3236
export KEYFACTOR_PASSWORD="<mypassword>"
3337
export KEYFACTOR_DOMAIN="<mykeyfactordomain>"
3438
```
39+
3540
Additional variables:
41+
3642
```bash
3743
export KEYFACTOR_API_PATH="/KeyfactorAPI" # Defaults to /KeyfactorAPI if not set ex. my.domain.com/KeyfactorAPI
3844
export KFUTIL_EXP=0 # Set to 1 or true to enable experimental features
3945
export KFUTIL_DEBUG=0 # Set to 1 or true to enable debug logging
4046
```
4147

4248
Windows Powershell:
49+
4350
```powershell
44-
$env:KEYFACTOR_HOSTNAME="<mykeyfactorhost.mydomain.com>"
45-
$env:KEYFACTOR_USERNAME="<myusername>" # Do not include domain
46-
$env:KEYFACTOR_PASSWORD="<mypassword>"
47-
$env:KEYFACTOR_DOMAIN="<mykeyfactordomain>"
51+
$env:KEYFACTOR_HOSTNAME = "<mykeyfactorhost.mydomain.com>"
52+
$env:KEYFACTOR_USERNAME = "<myusername>" # Do not include domain
53+
$env:KEYFACTOR_PASSWORD = "<mypassword>"
54+
$env:KEYFACTOR_DOMAIN = "<mykeyfactordomain>"
4855
```
4956

5057
Additional variables:
58+
5159
```bash
5260
$env:KEYFACTOR_API_PATH="/KeyfactorAPI" # Defaults to /KeyfactorAPI if not set ex. my.domain.com/KeyfactorAPI
5361
$env:KFUTIL_EXP=0 # Set to 1 or true to enable experimental features
@@ -58,17 +66,17 @@ $env:KFUTIL_DEBUG=0 # Set to 1 or true to enable debug logging
5866

5967
`kfutil` supports the following authentication providers in order of precedence:
6068

61-
| Provider Type | Description |
62-
|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
63-
| Azure Key Vault via Azure ID | This provider will read the Keyfactor Command credentials from Azure Key Vault. For more info review the [auth providers](docs/auth_providers#azure-key-vault) docs. |
64-
| Environment | This provider will read the Keyfactor Command credentials from the environment variables listed above. |
65-
| File | This is the default provider. It will read the credentials from a file on disk at `$HOME/.keyfactor/command_config.json` |
66-
| User Interactive | This provider will prompt the user for their credentials. |
67-
69+
| Provider Type | Description |
70+
|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
71+
| Azure Key Vault via Azure ID | This provider will read the Keyfactor Command credentials from Azure Key Vault. For more info review the [auth providers](docs/auth_providers.md#azure-key-vault) docs. |
72+
| Environment | This provider will read the Keyfactor Command credentials from the environment variables listed above. |
73+
| File | This is the default provider. It will read the credentials from a file on disk at `$HOME/.keyfactor/command_config.json` |
74+
| User Interactive | This provider will prompt the user for their credentials. |
6875

6976
## Commands
7077

7178
### Login
79+
7280
For full documentation on the `login` command, see the [login](docs/kfutil_login.md) documentation.
7381

7482
*WARNING* - The `login` command will store your Keyfactor credentials in a file on your local machine. This file is not
@@ -80,6 +88,7 @@ kfutil login
8088
```
8189

8290
### Logout
91+
8392
For full documentation on the `logout` command, see the [logout](docs/kfutil_logout.md) documentation.
8493

8594
*WARNING* - This will delete the file containing your Keyfactor credentials at `$HOME/.keyfactor/command_config.json`.

0 commit comments

Comments
 (0)