Skip to content

Commit

Permalink
Fixed invalid port numbers in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@ComprosoftCEO
ComprosoftCEO committed Dec 23, 2021
1 parent ee83efd commit 800080e
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion collector/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The command-line parameters override any values set in the `.env` files.
| :------------------: | :------------------: | :-----------------: | :-----------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Collector | _Argument_ | **Yes** | | Index of the collector (`1` or `2`) |
| C{1,2}\_HOST | `--host` | No | 127.0.0.1 | IP address to use for running collector 1 or 2. If you use the `localhost` IP address, then you cannot connect to the API server from an external location. This must be an IP address and not a domain name. |
| C{1,2}\_PORT | `--port` | No | 3001 | Port number for collector 1 or 2. |
| C{1,2}\_PORT | `--port` | No | 3001 or 3002 | Port number for collector 1 or 2. (C1 = 3001, C2 = 3002) |
| C{1,2}\_USE_HTTPS | `--use-https` | No | false | If true, then use HTTPS instead of HTTP for API requests. HTTPS encryption is performed using the OpenSSL library. |
| C{1,2}\_KEY_FILE | `--key-file` | Only If `USE_HTTPS` | | Private key file for OpenSSL. This should be an unencrypted `.pem` file. |
| C{1,2}\_CERT_FILE | `--cert-file` | Only If `USE_HTTPS` | | Certificate file for OpenSSL. This should be the unencrypted `.pem` file generated using the private key. For compatibility with some applications, this should be the full chain file and not just the certificate. |
Expand Down
20 changes: 10 additions & 10 deletions notifications/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,24 +27,24 @@ Use the `--help` flag to list all command-line options

## Environment Variables

For running the collector, you will need to specify certain environment variables.
For running the notifications server, you will need to specify certain environment variables.
This can be done using the following files:

- `.env` - Environment variables shared by both development and production systems
- `.env.development` - Environment variables only on development system
- `.env.production` - Environment variables only on production system

Alternatively, these values can be passed in using command-line parameters when running the API server.
Alternatively, these values can be passed in using command-line parameters when running the notifications server.
The command-line parameters override any values set in the `.env` files.

| Variable | Command-line Flag | Required | Default Value | Description |
| :--------: | :------------------: | :-----------------: | :-----------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| HOST | `--host`, `-h` | No | 127.0.0.1 | IP address to use for running the API server. If you use the `localhost` IP address, then you cannot connect to the API server from an external location. This must be an IP address and not a domain name. |
| PORT | `--port`, `-p` | No | 3000 | Port number for the API server. |
| USE_HTTPS | `--use-https` | No | false | If true, then use HTTPS instead of HTTP for API requests. HTTPS encryption is performed using the OpenSSL library. |
| KEY_FILE | `--key-file` | Only If `USE_HTTPS` | | Private key file for OpenSSL. This should be an unencrypted `.pem` file. |
| CERT_FILE | `--cert-file` | Only If `USE_HTTPS` | | Certificate file for OpenSSL. This should be the unencrypted `.pem` file generated using the private key. For compatibility with some applications, this should be the full chain file and not just the certificate. |
| JWT_SECRET | `--jwt-secret`, `-s` | No | _Hidden..._ | Secret value for signing the JSON Web Token |
| Variable | Command-line Flag | Required | Default Value | Description |
| :--------: | :------------------: | :-----------------: | :-----------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| HOST | `--host`, `-h` | No | 127.0.0.1 | IP address to use for running the notifications server. If you use the `localhost` IP address, then you cannot connect to the API server from an external location. This must be an IP address and not a domain name. |
| PORT | `--port`, `-p` | No | 3005 | Port number for the notifications server. |
| USE_HTTPS | `--use-https` | No | false | If true, then use HTTPS instead of HTTP for API requests. HTTPS encryption is performed using the OpenSSL library. |
| KEY_FILE | `--key-file` | Only If `USE_HTTPS` | | Private key file for OpenSSL. This should be an unencrypted `.pem` file. |
| CERT_FILE | `--cert-file` | Only If `USE_HTTPS` | | Certificate file for OpenSSL. This should be the unencrypted `.pem` file generated using the private key. For compatibility with some applications, this should be the full chain file and not just the certificate. |
| JWT_SECRET | `--jwt-secret`, `-s` | No | _Hidden..._ | Secret value for signing the JSON Web Token |

<br />

Expand Down
2 changes: 1 addition & 1 deletion server/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ The command-line parameters override any values set in the `.env` files.
| Variable | Command-line Flag | Required | Default Value | Description |
| :------------------: | :----------------------------: | :-----------------: | :-----------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| HOST | `--host`, `-h` | No | 127.0.0.1 | IP address to use for running the API server. If you use the `localhost` IP address, then you cannot connect to the API server from an external location. This must be an IP address and not a domain name. |
| PORT | `--port`, `-p` | No | 3001 | Port number for the API server. |
| PORT | `--port`, `-p` | No | 3000 | Port number for the API server. |
| USE_HTTPS | `--use-https` | No | false | If true, then use HTTPS instead of HTTP for API requests. HTTPS encryption is performed using the OpenSSL library. |
| KEY_FILE | `--key-file` | Only If `USE_HTTPS` | | Private key file for OpenSSL. This should be an unencrypted `.pem` file. |
| CERT_FILE | `--cert-file` | Only If `USE_HTTPS` | | Certificate file for OpenSSL. This should be the unencrypted `.pem` file generated using the private key. For compatibility with some applications, this should be the full chain file and not just the certificate. |
Expand Down

0 comments on commit 800080e

Please sign in to comment.