github/dokku
0
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: use github admonitions

Browse Source 
These still need to be properly parsed.
This commit is contained in:
Jose Diaz-Gonzalez
2023-08-19 14:24:12 -04:00
parent 5dd78e2b86
commit d61d91cf87
47 changed files with 277 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/configuration/domains.md
View File

@@ -1,5 +1,6 @@
# Domain Configuration
> [!IMPORTANT]
> New as of 0.3.10
```
@@ -65,6 +66,7 @@ dokku domains:set node-js-app dokku.me dokku.org
## Displaying domains reports for an app
> [!IMPORTANT]
> New as of 0.8.1
You can get a report about the app's domains status using the `domains:report` command:

6
docs/configuration/environment-variables.md
View File

@@ -21,7 +21,8 @@ Environment variables are available both at run time and during the application
For buildpack deploys, Dokku will create a `/app/.env` file that can be used for legacy buildpacks. Note that this is _not_ updated when `config:set` or `config:unset` is called, and is only written during a `deploy` or `ps:rebuild`. Developers are encouraged to instead read from the application environment directly, as the proper values will be available then.
> Note: Global `ENV` files are sourced before app-specific `ENV` files. This means that app-specific variables will take precedence over global variables. Configuring your global `ENV` file is manual, and should be considered potentially dangerous as configuration applies to all applications.
> [!NOTE]
> Global `ENV` files are sourced before app-specific `ENV` files. This means that app-specific variables will take precedence over global variables. Configuring your global `ENV` file is manual, and should be considered potentially dangerous as configuration applies to all applications.
You can set multiple environment variables at once:
@@ -74,7 +75,8 @@ dokku config:export --format shell node-js-app
The following config variables have special meanings and can be set in a variety of ways. Unless specified via global app config, the values may not be passed into applications. Usage of these values within applications should be considered unsafe, as they are an internal configuration values that may be moved to the internal properties system in the future.
> Warning: This list is not exhaustive, and may vary from version to version.
> [!WARNING]
> This list is not exhaustive, and may vary from version to version.
| Name | Default | How to modify | Description |
| ------------------------------ | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------- |

8
docs/configuration/ssl.md
View File

@@ -1,5 +1,6 @@
# SSL Configuration
> [!IMPORTANT]
> New as of 0.4.0
Dokku supports SSL/TLS certificate inspection and CSR/Self-signed certificate generation via the `certs` plugin. Note that whenever SSL/TLS support is enabled SPDY is also enabled.
@@ -33,7 +34,8 @@ tar cvf cert-key.tar server.crt server.key
dokku certs:add node-js-app < cert-key.tar
```
> Note: If your `.crt` file came alongside a `.ca-bundle`, you'll want to concatenate those into a single `.crt` file before adding it to the `.tar`.
> [!NOTE]
> If your `.crt` file came alongside a `.ca-bundle`, you'll want to concatenate those into a single `.crt` file before adding it to the `.tar`.
```shell
cat yourdomain_com.crt yourdomain_com.ca-bundle > server.crt
@@ -47,7 +49,8 @@ Note that with the default nginx template, requests will be redirected to the `h
### Certificate generation
> Note: Using this method will create a self-signed certificate, which is only recommended for development or staging use, not production environments.
> [!NOTE]
> Using this method will create a self-signed certificate, which is only recommended for development or staging use, not production environments.
The `certs:generate` command will walk you through the correct `openssl` commands to create a key, csr and a self-signed cert for a given app/domain. We automatically put the self-signed cert in place as well as add the specified domain to the application configuration.
@@ -69,6 +72,7 @@ dokku certs:show node-js-app key > server.key
### Displaying certificate reports for an app
> [!IMPORTANT]
> New as of 0.8.1
You can get a report about the apps ssl status using the `certs:report` command: