diff --git a/docs/appendices/0.10.0-migration-guide.md b/docs/appendices/0.10.0-migration-guide.md index 95940eeb9..053155738 100644 --- a/docs/appendices/0.10.0-migration-guide.md +++ b/docs/appendices/0.10.0-migration-guide.md @@ -4,10 +4,10 @@ By default, Dokku will ship a PCI Compliant nginx configuration. For developers whose users are on older browsers or mobile devices, you may need to ship a custom `nginx.conf.sigil` to enable ciphers for older browsers. -See the [nginx customization](/docs/configuration/nginx/#customizing-the-nginx-configuration) docs for more details. +See the [nginx customization](/docs/networking/proxies/nginx/#customizing-the-nginx-configuration) docs for more details. ## Nginx Error Pages We now ship with nicer error pages by default. You are free to customize your Dokku installation via a custom `nginx.conf.sigil` to change what error pages are displayed in different circumstances. -See the [nginx customization](/docs/configuration/nginx/#customizing-the-nginx-configuration) docs for more details. +See the [nginx customization](/docs/networking/proxies/nginx/#customizing-the-nginx-configuration) docs for more details. diff --git a/docs/appendices/0.5.0-migration-guide.md b/docs/appendices/0.5.0-migration-guide.md index 2daba27dd..86dfb0d11 100644 --- a/docs/appendices/0.5.0-migration-guide.md +++ b/docs/appendices/0.5.0-migration-guide.md @@ -5,11 +5,11 @@ - The nginx-vhosts template language is now [sigil](https://github.com/gliderlabs/sigil) - No need to escape literal `$` characters (or other "bash-isms") - Template variables are represented as {{ .VARIABLE_NAME }} - - A detailed list of template variables can be found [here](/docs/configuration/nginx.md#available-template-variables) + - A detailed list of template variables can be found [here](/docs/networking/proxies/nginx.md#available-template-variables) - A custom nginx-vhosts template must be named `nginx.conf.sigil` - The default path for this custom template is the root of your repo (i.e. `/app` in the container or `WORKDIR` if defined in a dockerfile app) - Dokku no longer looks for this file in `/home/dokku/node-js-app` on the Dokku server - - Check out an example template [here](/docs/configuration/nginx.md) + - Check out an example template [here](/docs/networking/proxies/nginx.md) - Support for server-wide SSL certs have been dropped in favor of using the `certs` plugin - `dokku certs:add node-js-app < certs.tar` - All domains for an SSL-enabled app will be redirected to https by default diff --git a/docs/configuration/domains.md b/docs/configuration/domains.md index c3e28f77f..28057375a 100644 --- a/docs/configuration/domains.md +++ b/docs/configuration/domains.md @@ -113,4 +113,4 @@ dokku domains:report node-js-app --domains-app-enabled ## Default site -This is specific to your proxy plugin of choice. See the [nginx documentation](/docs/configuration/nginx.md#default-site) for more information on how to configure this for the default nginx proxy implementation. +This is specific to your proxy plugin of choice. See the [nginx documentation](/docs/networking/proxies/nginx.md#default-site) for more information on how to configure this for the default nginx proxy implementation. diff --git a/docs/configuration/ssl.md b/docs/configuration/ssl.md index 5b6bfe149..5402154cf 100644 --- a/docs/configuration/ssl.md +++ b/docs/configuration/ssl.md @@ -43,7 +43,7 @@ cat yourdomain_com.crt yourdomain_com.ca-bundle > server.crt When an SSL certificate is associated to an application, the certificate will be associated with _all_ domains currently associated with said application. Your certificate _should_ be associated with all of those domains, otherwise accessing the application will result in SSL errors. If you wish to remove one of the domains from the application, refer to the [domain configuration documentation](/docs/configuration/domains.md). -Note that with the default nginx template, requests will be redirected to the `https` version of the domain. If this is not the desired state of request resolution, you may customize the nginx template in use. For more details, see the [nginx documentation](/docs/configuration/nginx.md). +Note that with the default nginx template, requests will be redirected to the `https` version of the domain. If this is not the desired state of request resolution, you may customize the nginx template in use. For more details, see the [nginx documentation](/docs/networking/proxies/nginx.md). ### Certificate generation @@ -126,7 +126,7 @@ dokku certs:report node-js-app --ssl-enabled The [HSTS header](https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security) is an HTTP header that can inform browsers that all requests to a given site should be made via HTTPS. Dokku does enables this header by default for HTTPS requests. -See the [NGINX HSTS documentation](/docs/configuration/nginx.md#hsts-header) for more information on how the HSTS configuration can be managed for your application. +See the [NGINX HSTS documentation](/docs/networking/proxies/nginx.md#hsts-header) for more information on how the HSTS configuration can be managed for your application. ## HTTP/2 support diff --git a/docs/configuration/nginx.md b/docs/networking/proxies/nginx.md similarity index 99% rename from docs/configuration/nginx.md rename to docs/networking/proxies/nginx.md index f4c72494e..57fb1aab1 100644 --- a/docs/configuration/nginx.md +++ b/docs/networking/proxies/nginx.md @@ -15,7 +15,7 @@ nginx:validate-config [] [--clean] # Validates and optionally cleans up in ### Request Proxying -By default, the `web` process is the only process proxied by the nginx proxy implementation. Proxying to other process types may be handled by a custom `nginx.conf.sigil` file, as generally described [below](/docs/configuration/nginx.md#customizing-the-nginx-configuration) +By default, the `web` process is the only process proxied by the nginx proxy implementation. Proxying to other process types may be handled by a custom `nginx.conf.sigil` file, as generally described [below](/docs/networking/proxies/nginx.md#customizing-the-nginx-configuration) Nginx will proxy the requests in a [round-robin balancing fashion](http://nginx.org/en/docs/http/ngx_http_upstream_module.html#upstream) to the different deployed (scaled) containers running the `web` proctype. This way, the host's resources can be fully leveraged for single-threaded applications (e.g. `dokku ps:scale node-js-app web=4` on a 4-core machine) diff --git a/docs/processes/process-management.md b/docs/processes/process-management.md index cdc2a2d9f..8e37f080b 100644 --- a/docs/processes/process-management.md +++ b/docs/processes/process-management.md @@ -164,7 +164,7 @@ There are also a few other exceptions for the `web` process. - Custom checks defined by a `CHECKS` file only apply to the `web` process type. - By default, the built-in nginx proxy implementation only proxies the `web` process (others may be handled via a custom `nginx.conf.sigil`). - - See the [nginx request proxying documentation](/docs/configuration/nginx.md#request-proxying) for more information on how nginx handles proxied requests. + - See the [nginx request proxying documentation](/docs/networking/proxies/nginx.md#request-proxying) for more information on how nginx handles proxied requests. - Only the `web` process may be bound to an external port. #### Changing the `Procfile` location diff --git a/docs/template.html b/docs/template.html index 06ded964f..a06763b71 100644 --- a/docs/template.html +++ b/docs/template.html @@ -157,7 +157,6 @@ Environment Variables Domain Configuration - Nginx Configuration SSL Configuration Interacting with Processes @@ -172,7 +171,11 @@ DNS Configuration Network Management Port Management + + Proxy Configuration + Proxy Management + Nginx Proxy Advanced Usage diff --git a/docs/viewdocs.json b/docs/viewdocs.json index 8a6a028c0..fbbfd817c 100644 --- a/docs/viewdocs.json +++ b/docs/viewdocs.json @@ -4,49 +4,40 @@ "advanced-installation": "getting-started/advanced-installation/", "troubleshooting": "getting-started/troubleshooting/", "upgrading": "getting-started/upgrading/", - "application-deployment": "deployment/application-deployment/", "checks-examples": "deployment/zero-downtime-deploys/", "remote-commands": "deployment/remote-commands/", - "process-management": "processes/process-management/", "deployment/process-management": "processes/process-management/", "deployment/one-off-processes": "processes/one-off-tasks/", - "deployment/buildpacks": "deployment/builders/herokuish-buildpacks/", "deployment/methods/buildpacks": "deployment/builders/herokuish-buildpacks/", "deployment/dockerfiles": "deployment/builders/dockerfiles/", - "deployment/methods/cloud-native-buildpacks": "deployment/builders/cloud-native-buildpacks/", "deployment/methods/dockerfiles": "deployment/builders/dockerfiles/", "deployment/methods/herokuish-buildpacks": "deployment/builders/herokuish-buildpacks/", - "deployment/images": "deployment/methods/git/#initializing-an-app-repository-from-a-docker-image", "deployment/tar": "deployment/methods/git/#initializing-an-app-repository-from-an-archive-file", "deployment/methods/images": "deployment/methods/git/#initializing-an-app-repository-from-a-docker-image", "deployment/methods/tar": "deployment/methods/git/#initializing-an-app-repository-from-an-archive-file", "configuration-management": "configuration/environment-variables/", "deployment/ssl-configuration": "configuration/ssl/", - "nginx": "configuration/nginx/", - + "configuration/nginx": "networking/proxies/nginx/", + "nginx": "networking/proxies/nginx/", "dns": "networking/dns/", "configuration/dns": "networking/dns/", "proxy": "networking/proxy-management/", "advanced-usage/proxy-management": "networking/proxy-management/", - "backup-recovery": "advanced-usage/backup-recovery/", "deployment-tasks": "advanced-usage/deployment-tasks/", "deployment/deployment-tasks": "advanced-usage/deployment-tasks/", "docker-options": "advanced-usage/docker-options/", "dokku-events-logs": "advanced-usage/event-logs/", "dokku-storage": "advanced-usage/persistent-storage/", - "advanced-usage/schedulers/alternate-schedulers": "deployment/schedulers/scheduler-management/", "advanced-usage/schedulers/docker-local": "deployment/schedulers/docker-local/", "deployment/schedulers/alternate-schedulers": "deployment/schedulers/scheduler-management/", - "community/tutorials/deploying-with-gitlab-ci": "deployment/continuous-integration/gitlab-ci/", - "plugins": "community/plugins/" } }