GITBOOK-6: Remove erroneous references to --sslcacert flag, clarified usage of flag

This commit is contained in:
James Carppe
2024-09-05 22:56:49 +00:00
committed by gitbook-bot
parent d1674f6ef6
commit 5508c605fa
2 changed files with 4 additions and 12 deletions

View File

@@ -19,11 +19,11 @@
| `--log-level` | Set the log level of the Portainer application, for example `--log-level DEBUG`. This is useful when troubleshooting. |
| `--log-mode` | Set the formatting for the Portainer log output, for example `--log-mode NOCOLOR`. Options are: `PRETTY` (default), `NOCOLOR` (disables color codes), `JSON` (JSON-formatted logs). |
| `--logo` | Specifies the URL to the image to be displayed as a logo in the UI. If not specified, the Portainer logo is used instead. |
| `--mtlscacert` | Specifies the path to the certificate authority (CA) certificate used for mTLS communication. |
| `--mtlscert` | Specifies the path to the certificate used for mTLS communication. |
| `--mtlskey` | Specifies the path to the certificate key used for mTLS communication. |
| `--mtlscacert` | Specifies the path to the certificate authority (CA) certificate used for mTLS communication. (BE only) |
| `--mtlscert` | Specifies the path to the certificate used for mTLS communication. (BE only) |
| `--mtlskey` | Specifies the path to the certificate key used for mTLS communication. (BE only) |
| `--snapshot-interval` | Specifies the time interval between two environment snapshot jobs expressed as a string. For example 30s, 5m, 1h… Supported by the `time.ParseDuration` method (default: 5m). |
| `--sslcacert` | Specifies the path to the certificate authority (CA) certificate used to secure the Portainer instance. |
| `--sslcacert` | Specifies the path to the certificate authority (CA) certificate used to validate the Edge Agent certificate. (BE only, **deprecated**, use [mTLS](mtls.md) instead) |
| `--sslcert` | Specifies the path to the SSL certificate used to secure the Portainer instance (default: `/certs/portainer.crt` on Linux, `C:\certs\portainer.crt` on Windows). |
| `--sslkey` | Specifies the path to the SSL key used to secure the Portainer instance (default: `/certs/portainer.key` on Linux, `C:\certs\portainer.key` on Windows). |
| `--syslog-*` | The `--syslog-*` options are used to configure auth and activity log streaming to an external Syslog-compatible provider. See the [SIEM documentation](siem.md) for more on this experimental feature. |

View File

@@ -14,10 +14,6 @@ Portainer expects certificates in PEM format.
Use the `--sslcert` and `--sslkey` flags during installation.
{% hint style="info" %}
If you are using certificates signed by your own CA, you may need to supply your CA certificate as well with the `--sslcacert` flag.
{% endhint %}
Upload your certificate (including the chain) and key to the server running Portainer, then start Portainer referencing them. The following command assumes your certificates are stored in `/path/to/your/certs` with the filenames `portainer.crt` and `portainer.key`, and bind-mounts the directory to `/certs` in the Portainer container:
{% tabs %}
@@ -91,10 +87,6 @@ docker secret create portainer.sslcert /path/to/your/certificate.crt
docker secret create portainer.sslkey /path/to/your/certificate.key
```
{% hint style="info" %}
If you are using certificates signed by your own CA, you may need to supply your CA certificate as well via a `portainer.sslcacert` secret and modifying the below YAML files to include the `--sslcacert` flag.
{% endhint %}
Next, retrieve the stack YML manifest:
{% tabs %}