Leahnaya/SSSL
1
0
Fork 0
mirror of https://github.com/PretendoNetwork/SSSL.git synced 2026-03-21 17:34:48 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: fix incorrect short command-line arguments

Browse Source
This commit is contained in:
Matthew Lopez 2024-06-05 17:31:28 -04:00
parent ee758b69e1
commit ee782d904f
No known key found for this signature in database
GPG Key ID: 302A6EE3D63B7E0E
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -48,16 +48,16 @@ This script can also be run in a Docker container.
This script can be configured using environment variables, a `.env` file, or individual command-line arguments. Alternatively, it can be run with the `-i` or `--interactive` flag to interactively prompt for all configuration values. Command-line arguments always override environment variables.
| Environment Variable | Command-line Argument | Description | Default |
| -------------------------- | --------------------------------------- | ------------------------------------------------------------------- | ----------------------------- |
| N/A | `-i`, `--interactive` | Interactively prompt for all configuration values | N/A |
| SSSL_NINTENDO_CA_G3_PATH | `-g`, `--nintendo-ca-g3-path <value>` | Path to Nintendo CA - G3 certificate (may be in DER or PEM format) | `./CACERT_NINTENDO_CA_G3.der` |
| SSSL_NINTENDO_CA_G3_FORMAT | `-f`, `--nintendo-ca-g3-format <value>` | Nintendo CA - G3 certificate format (must be "der" or "pem") | `der` |
| SSSL_CA_PRIVATE_KEY_PATH | `-c`, `--ca-private-key-path <value>` | Path to private key for forged CA (will generate if not set) | N/A |
| SSSL_SITE_PRIVATE_KEY_PATH | `-s`, `--site-private-key-path <value>` | Path to private key for site certificate (will generate if not set) | N/A |
| SSSL_CSR_PATH | `-r`, `--csr-path <value>` | Path to CSR (will generate if not set) | N/A |
| SSSL_COMMON_NAME | `-n`, `--common-name <value>` | CN for site certificate (see [the bugs](#the-bugs)) | `*` |
| SSSL_OUTPUT_FOLDER_PATH | `-o`, `--output-folder-path <value>` | Output folder | `./` |
| Environment Variable | Command-line Argument | Description | Default |
| -------------------------- | ---------------------------------------- | ------------------------------------------------------------------- | ----------------------------- |
| N/A | `-i`, `--interactive` | Interactively prompt for all configuration values | N/A |
| SSSL_NINTENDO_CA_G3_PATH | `-g3`, `--nintendo-ca-g3-path <value>` | Path to Nintendo CA - G3 certificate (may be in DER or PEM format) | `./CACERT_NINTENDO_CA_G3.der` |
| SSSL_NINTENDO_CA_G3_FORMAT | `-f`, `--nintendo-ca-g3-format <value>` | Nintendo CA - G3 certificate format (must be "der" or "pem") | `der` |
| SSSL_CA_PRIVATE_KEY_PATH | `-cap`, `--ca-private-key-path <value>` | Path to private key for forged CA (will generate if not set) | N/A |
| SSSL_SITE_PRIVATE_KEY_PATH | `-sp`, `--site-private-key-path <value>` | Path to private key for site certificate (will generate if not set) | N/A |
| SSSL_CSR_PATH | `-csrp`, `--csr-path <value>` | Path to CSR (will generate if not set) | N/A |
| SSSL_COMMON_NAME | `-cn`, `--common-name <value>` | CN for site certificate (see [the bugs](#the-bugs)) | `*` |
| SSSL_OUTPUT_FOLDER_PATH | `-o`, `--output-folder-path <value>` | Output folder | `./` |
## Credits