mirror of
https://github.com/dokku/dokku.git
synced 2026-02-24 04:00:36 +01:00
6fec401ded
# History ## 0.33.0 Install/update via the bootstrap script: ```shell wget -NP . https://dokku.com/install/v0.33.0/bootstrap.sh sudo DOKKU_TAG=v0.33.0 bash bootstrap.sh ``` ### Bug Fixes - #6466: @josegonzalez Use correct key for migrating global scheduler configuration on upgrade - #6450: @josegonzalez Always set -- on docker run commands internally to avoid parsing flags on specified commands - #6447: @josegonzalez Propagate arm64 build support for development builds - #6445: @josegonzalez Do not strip whitespace when displaying a file for debugging purposes - #6442: @josegonzalez Ignore go.work when bumping modules - #6427: @josegonzalez Add missing gitignore entry for app-json trigger ### New Features - #6500: @josegonzalez Add support for custom user namespaces when creating persistent storage directories - #6492: @josegonzalez Add support for multierror when exiting triggers - #6491: @josegonzalez Add wrappers for exec and ssh commands - #6489: @josegonzalez Disable flag parsing for dokku enter - #6469: @josegonzalez Allow generating an ssh deploy key via the git plugin - #6468: @josegonzalez Implement global support for setting proxy type - #6467: @josegonzalez Add ability to customize the registry repo with a template - #6464: @josegonzalez Create helper function for exposing a docker image's working directory - #6462: @josegonzalez Ensure ps:stop has a proper cli header - #6460: @josegonzalez Add a post-registry-login trigger - #6459: @josegonzalez Alias common registry names to docker.io - #6457: @josegonzalez Add the ability to specify the output format when listing ports - #6452: @josegonzalez Add alternative implementation for calling plugin triggers - #6446: @josegonzalez Add support for global-only environment properties - #6443: @josegonzalez Add support for exposing healthchecks in the AppJson struct - #6435: @josegonzalez Implement native k3s scheduler support - #6433: @josegonzalez Add go.work.sum to gitignore - #6432: @josegonzalez Upgrade golang to 1.21.6 - #6430: @josegonzalez Reformat devcontainer file - #6428: @josegonzalez Add ms-azuretools.vscode-docker to devcontainer setup - #6313: @josegonzalez Set the platform flag in order to run amd64 images on arm64 deploy targets ### Refactors - #6448: @josegonzalez Return an int32 for scale count - #6444: @josegonzalez Allow setting a custom mode when writing a slice to a file ### Documentation - #6517: @josegonzalez Remove k3s tutorial from documentation - #6516: @josegonzalez Note that the external kubernetes plugin is deprecated - #6515: @josegonzalez Replace the kubernetes plugin with k3s in the documentation - #6514: @josegonzalez Add notes on k3s replacement of the scheduler-kubernetes plugin - #6461: @josegonzalez Add documentation for implementing scheduler-related commands - #6458: @josegonzalez Add docblocks to appjson structs - #6420: @aochagavia Fix typo in zero downtime documentation ### Tests - #6465: @josegonzalez Update haproxy tests so they pass - #6449: @josegonzalez Run ci on ubuntu 22.04 - #6431: @josegonzalez Add golanglint-ci testing support ### Dependencies - #6513: @dependabot[bot] chore(deps): bump github.com/containerd/containerd from 1.7.6 to 1.7.11 in /plugins/scheduler-k3s - #6512: @josegonzalez Update github.com/gonsi/gomega golang dependency - #6511: @josegonzalez Update crypto and sys golang dependencies - #6494: @dependabot[bot] chore(deps): bump markupsafe from 2.1.3 to 2.1.4 in /docs/_build - #6482: @dependabot[bot] chore(deps): bump mkdocs-material from 9.5.3 to 9.5.4 in /docs/_build - #6478: @dependabot[bot] chore(deps): bump golang from 1.21.5 to 1.21.6 in /tests/apps/zombies-dockerfile-tini - #6456: @dependabot[bot] chore(deps): bump google.golang.org/grpc from 1.29.1 to 1.60.1 in /tests/apps/gogrpc - #6454: @dependabot[bot] chore(deps): bump flask from 3.0.0 to 3.0.1 in /tests/apps/python-flask - #6455: @dependabot[bot] chore(deps): bump flask from 3.0.0 to 3.0.1 in /tests/apps/multi - #6453: @josegonzalez Remove ignored dependency from dependabot - #6451: @josegonzalez Update go modules - #6439: @dependabot[bot] chore(deps): bump github.com/onsi/gomega from 1.30.0 to 1.31.0 in /plugins/config - #6438: @dependabot[bot] chore(deps): bump github.com/onsi/gomega from 1.30.0 to 1.31.0 in /plugins/common - #6437: @dependabot[bot] chore(deps): bump beautifulsoup4 from 4.12.2 to 4.12.3 in /docs/_build - #6436: @dependabot[bot] chore(deps): bump tj-actions/changed-files from 41.1.1 to 42.0.0 - #6425: @dependabot[bot] chore(deps): bump tj-actions/changed-files from 41.0.1 to 41.1.1 - #6424: @dependabot[bot] chore(deps): bump mkdocs-material from 9.5.3 to 9.5.4 in /docs/_build - #6421: @josegonzalez chore: bump golang.org/x/sync from 0.5.0 to 0.6.0 - #6419: @dependabot[bot] chore(deps): bump jinja2 from 3.1.2 to 3.1.3 in /docs/_build - #6418: @dependabot[bot] chore(deps): bump jinja2 from 3.1.2 to 3.1.3 in /tests/apps/python-flask - #6415: @dependabot[bot] chore(deps): bump golang from 1.21.5 to 1.21.6 in /tests/apps/go-fail-postdeploy - #6414: @dependabot[bot] chore(deps): bump golang from 1.21.5 to 1.21.6 in /tests/apps/gogrpc - #6413: @dependabot[bot] chore(deps): bump golang from 1.21.5 to 1.21.6 in /tests/apps/go-fail-predeploy - #6412: @dependabot[bot] chore(deps): bump golang from 1.21.5 to 1.21.6 in /tests/apps/zombies-dockerfile-no-tini - #6411: @dependabot[bot] chore(deps): bump golang from 1.21.5 to 1.21.6 in /tests/apps/zombies-dockerfile-tini - #6410: @dependabot[bot] chore(deps): bump golang.org/x/net from 0.19.0 to 0.20.0 in /tests/apps/gogrpc - #6406: @dependabot[bot] chore(deps): bump golang.org/x/sync from 0.5.0 to 0.6.0 in /plugins/scheduler-docker-local ### Other - #6463: @josegonzalez Use exported function from appjson module instead of manually parsing - #6429: @josegonzalez Use go.work for development purposes
588 lines
30 KiB
HTML
588 lines
30 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
|
|
<meta name="description" content="">
|
|
<meta name="author" content="">
|
|
<title>Dokku - {{DOC_TITLE}}</title>
|
|
|
|
<link rel="apple-touch-icon" sizes="57x57" href="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.33.0/docs/assets/favicons/apple-touch-icon-57x57.png">
|
|
<link rel="apple-touch-icon" sizes="60x60" href="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.33.0/docs/assets/favicons/apple-touch-icon-60x60.png">
|
|
<link rel="apple-touch-icon" sizes="72x72" href="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.33.0/docs/assets/favicons/apple-touch-icon-72x72.png">
|
|
<link rel="apple-touch-icon" sizes="76x76" href="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.33.0/docs/assets/favicons/apple-touch-icon-76x76.png">
|
|
<link rel="apple-touch-icon" sizes="114x114" href="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.33.0/docs/assets/favicons/apple-touch-icon-114x114.png">
|
|
<link rel="apple-touch-icon" sizes="120x120" href="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.33.0/docs/assets/favicons/apple-touch-icon-120x120.png">
|
|
<link rel="apple-touch-icon" sizes="144x144" href="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.33.0/docs/assets/favicons/apple-touch-icon-144x144.png">
|
|
<link rel="apple-touch-icon" sizes="152x152" href="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.33.0/docs/assets/favicons/apple-touch-icon-152x152.png">
|
|
<link rel="apple-touch-icon" sizes="180x180" href="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.33.0/docs/assets/favicons/apple-touch-icon-180x180.png">
|
|
<link rel="icon" type="image/png" href="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.33.0/docs/assets/favicons/favicon-32x32.png" sizes="32x32">
|
|
<link rel="icon" type="image/png" href="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.33.0/docs/assets/favicons/android-chrome-192x192.png" sizes="192x192">
|
|
<link rel="icon" type="image/png" href="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.33.0/docs/assets/favicons/favicon-96x96.png" sizes="96x96">
|
|
<link rel="icon" type="image/png" href="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.33.0/docs/assets/favicons/favicon-16x16.png" sizes="16x16">
|
|
<link rel="manifest" href="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.33.0/docs/assets/favicons/manifest.json">
|
|
<link rel="shortcut icon" href="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.33.0/docs/assets/favicons/favicon.ico">
|
|
<meta name="apple-mobile-web-app-title" content="Dokku">
|
|
<meta name="application-name" content="Dokku">
|
|
<meta name="msapplication-TileColor" content="#da532c">
|
|
<meta name="msapplication-TileImage" content="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.33.0/docs/assets/favicons/mstile-144x144.png">
|
|
<meta name="msapplication-config" content="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.33.0/docs/assets/favicons/browserconfig.xml">
|
|
<meta name="theme-color" content="#ffffff">
|
|
|
|
<script>
|
|
if ('{{DOC}}' == 'index.md') {
|
|
var indexLink = '/{{NAME}}/';
|
|
if ('{{REF}}' !== 'master') {
|
|
indexLink = '/{{NAME}}~{{REF}}/';
|
|
}
|
|
window.location.replace(window.location.origin + indexLink);
|
|
}
|
|
</script>
|
|
|
|
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor" crossorigin="anonymous">
|
|
|
|
<!-- Font (Lato) -->
|
|
<link rel="preconnect" href="https://fonts.googleapis.com">
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
<link href="https://fonts.googleapis.com/css2?family=Lato:wght@400;700;900&display=swap" rel="stylesheet">
|
|
|
|
<link href="https://cdn.jsdelivr.net/gh/dokku/dokku@v0.33.0/docs/assets/style.css" rel="stylesheet">
|
|
<!-- <link href="./assets/style.css" rel="stylesheet"> -->
|
|
<link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.5.0/css/font-awesome.min.css" rel="stylesheet">
|
|
</head>
|
|
<body>
|
|
<div class="dev-warning doc-floating-warning" style="display:none">
|
|
This document is for dokku's development version, which can be significantly different from previous releases. For older releases, use the version selector floating in the bottom right corner of this page.
|
|
</div>
|
|
<header class="hero-section">
|
|
<nav class="navbar navbar-expand-md navbar-dark py-3" id="mainNav">
|
|
<div class="container top-50 px-4 px-lg-5">
|
|
<a class="navbar-brand d-flex" href="/{{NAME}}/">
|
|
<img class="me-3" src="./assets/dokku-logo.svg" alt="" width="55">
|
|
<span class="align-self-center d-block">Dokku</span>
|
|
</a>
|
|
<button class="navbar-toggler navbar-toggler-right" type="button" data-bs-toggle="collapse" data-bs-target="#navbarResponsive" aria-controls="navbarResponsive" aria-expanded="false" aria-label="Toggle navigation"><span class="navbar-toggler-icon"></span></button>
|
|
<div class="collapse navbar-collapse" id="navbarResponsive">
|
|
<ul class="navbar-nav ms-auto my-2 my-lg-0">
|
|
<li class="nav-item"><a class="nav-link mx-0 mx-md-2 underline" href="https://dokku.com/blog/">Blog</a></li>
|
|
<li class="nav-item"><a class="nav-link mx-0 mx-md-2 underline" href="https://github.com/dokku/dokku/">Code</a></li>
|
|
<li class="nav-item"><a class="nav-link mx-0 mx-md-2 underline" href="/{{NAME}}/getting-started/installation/">Docs</a></li>
|
|
<li class="nav-item dropdown">
|
|
<a class="nav-link dropdown-toggle mx-0 mx-md-2 underline" id="navbarDropdownMenuLink" role="button" data-bs-toggle="dropdown" aria-expanded="false">
|
|
Social
|
|
</a>
|
|
<ul class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink">
|
|
<div class="d-grid gap-2">
|
|
<a href="https://discord.gg/YQjANGMZvu" class="btn rounded-2 d-flex align-items-center py-2 px-3 lh-sm text-start mx-2">
|
|
<img class="me-3" alt="discord" src="./assets/social/discord.png" width="25px" />
|
|
<div>
|
|
<strong class="d-block">Discord</strong>
|
|
</div>
|
|
</a>
|
|
<a href="https://slack.dokku.com/" class="btn rounded-2 d-flex align-items-center py-2 px-3 lh-sm text-start mx-2">
|
|
<img class="me-3" alt="slack" src="./assets/social/slack.png" width="25px" />
|
|
<div>
|
|
<strong class="d-block">Slack</strong>
|
|
</div>
|
|
</a>
|
|
<a href="https://webchat.libera.chat/?channels=dokku" class="btn rounded-2 d-flex align-items-center py-2 px-3 lh-sm text-start mx-2">
|
|
<img class="me-3" alt="irc" src="./assets/social/irc.png" width="25px" />
|
|
<div>
|
|
<strong class="d-block">IRC</strong>
|
|
</div>
|
|
</a>
|
|
<a href="https://github.com/dokku/dokku/discussions" class="btn rounded-2 d-flex align-items-center py-2 px-3 lh-sm text-start mx-2">
|
|
<img class="me-3" alt="github" src="./assets/social/github.png" width="25px" />
|
|
<div>
|
|
<strong class="d-block">GitHub Discussions</strong>
|
|
</div>
|
|
</a>
|
|
</div>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-item"><a class="nav-link mx-0 mx-md-2 underline" href="https://pro.dokku.com/">Pro</a></li>
|
|
<li class="nav-item"><a class="btn btn-primary mx-0 mx-md-3 cta" href="/{{NAME}}/getting-started/installation/">Get Started</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
</header>
|
|
|
|
<div class="container">
|
|
<div class="improve-slideout">
|
|
<i class="fa fa-pencil icon-improve"></i>
|
|
<a href="https://github.com/{{USER}}/{{NAME}}/edit/master/docs/{{DOC}}" target="_blank">
|
|
<div class="improve-slideout-inner"><h6>Improve This Doc <i class="fa fa-github git-improve"></i></h6></div>
|
|
</a>
|
|
</div>
|
|
<a class="back-to-contents" href="#page-contents"><i class="fa fa-arrow-circle-up icon-improve" title="Back to Contents"></i></a>
|
|
|
|
<div class="row">
|
|
<div class="col-4 col-md-3" style="padding-top:16px">
|
|
<div class="list-group">
|
|
<a href="#" class="list-group-item disabled">Getting Started</a>
|
|
<a href="/{{NAME}}/getting-started/installation/" class="list-group-item">Getting Started with Dokku</a>
|
|
<a href="/{{NAME}}/getting-started/upgrading/" class="list-group-item">Upgrading Dokku</a>
|
|
<a href="/{{NAME}}/getting-started/uninstalling/" class="list-group-item">Uninstalling Dokku</a>
|
|
<a href="/{{NAME}}/getting-started/troubleshooting/" class="list-group-item">Troubleshooting</a>
|
|
<a href="/{{NAME}}/getting-started/where-to-get-help/" class="list-group-item">Getting Help</a>
|
|
|
|
<a href="#" class="list-group-item disabled">Commercial</a>
|
|
<a href="/{{NAME}}/enterprise/pro/" class="list-group-item">Dokku Pro</a>
|
|
|
|
<a href="#" class="list-group-item disabled">Deployment</a>
|
|
|
|
<a href="/{{NAME}}/deployment/application-deployment/" class="list-group-item">Deploying an Application</a>
|
|
<a href="/{{NAME}}/deployment/application-management/" class="list-group-item">Application Management</a>
|
|
<a href="/{{NAME}}/deployment/logs/" class="list-group-item">Application Logs</a>
|
|
<a href="/{{NAME}}/deployment/remote-commands/" class="list-group-item">Remote Commands</a>
|
|
<a href="/{{NAME}}/deployment/user-management/" class="list-group-item">User Management</a>
|
|
<a href="/{{NAME}}/deployment/zero-downtime-deploys/" class="list-group-item">Zero Downtime Deploy Checks</a>
|
|
|
|
<a href="#" class="list-group-item disabled">Builders</a>
|
|
|
|
<a href="/{{NAME}}/deployment/builders/builder-management/" class="list-group-item">Builder Management</a>
|
|
<a href="/{{NAME}}/deployment/builders/cloud-native-buildpacks/" class="list-group-item">Cloud Native Buildpacks</a>
|
|
<a href="/{{NAME}}/deployment/builders/herokuish-buildpacks/" class="list-group-item">Herokuish Buildpacks</a>
|
|
<a href="/{{NAME}}/deployment/builders/dockerfiles/" class="list-group-item">Dockerfile Deployment</a>
|
|
<a href="/{{NAME}}/deployment/builders/lambda/" class="list-group-item">Lambda Builder</a>
|
|
<a href="/{{NAME}}/deployment/builders/nixpacks/" class="list-group-item">Nixpacks Builder</a>
|
|
<a href="/{{NAME}}/deployment/builders/null/" class="list-group-item">Null Builder</a>
|
|
|
|
<a href="#" class="list-group-item disabled">Deployment Methods</a>
|
|
<a href="/{{NAME}}/deployment/methods/git/" class="list-group-item">Git Deployment</a>
|
|
<a href="/{{NAME}}/deployment/methods/image/" class="list-group-item">Docker Image Deployment</a>
|
|
<a href="/{{NAME}}/deployment/methods/archive/" class="list-group-item">Archive Deployment</a>
|
|
|
|
<a href="#" class="list-group-item disabled">Configuration</a>
|
|
|
|
<a href="/{{NAME}}/configuration/environment-variables/" class="list-group-item">Environment Variables</a>
|
|
<a href="/{{NAME}}/configuration/domains/" class="list-group-item">Domain Configuration</a>
|
|
<a href="/{{NAME}}/configuration/ssl/" class="list-group-item">SSL Configuration</a>
|
|
|
|
<a href="#" class="list-group-item disabled">Interacting with Processes</a>
|
|
|
|
<a href="/{{NAME}}/processes/entering-containers/" class="list-group-item">Entering Containers</a>
|
|
<a href="/{{NAME}}/processes/one-off-tasks/" class="list-group-item">One-Off Tasks</a>
|
|
<a href="/{{NAME}}/processes/process-management/" class="list-group-item">Process Management</a>
|
|
<a href="/{{NAME}}/processes/scheduled-cron-tasks/" class="list-group-item">Scheduled Cron Tasks</a>
|
|
|
|
<a href="#" class="list-group-item disabled">Network Management</a>
|
|
|
|
<a href="/{{NAME}}/networking/dns/" class="list-group-item">DNS Configuration</a>
|
|
<a href="/{{NAME}}/networking/network/" class="list-group-item">Network Management</a>
|
|
<a href="/{{NAME}}/networking/port-management/" class="list-group-item">Port Management</a>
|
|
|
|
<a href="#" class="list-group-item disabled">Proxy Configuration</a>
|
|
|
|
<a href="/{{NAME}}/networking/proxy-management/" class="list-group-item">Proxy Management</a>
|
|
<a href="/{{NAME}}/networking/proxies/caddy/" class="list-group-item">Caddy Proxy</a>
|
|
<a href="/{{NAME}}/networking/proxies/haproxy/" class="list-group-item">Haproxy Proxy</a>
|
|
<a href="/{{NAME}}/networking/proxies/nginx/" class="list-group-item">Nginx Proxy</a>
|
|
<a href="/{{NAME}}/networking/proxies/openresty/" class="list-group-item">Openresty Proxy</a>
|
|
<a href="/{{NAME}}/networking/proxies/traefik/" class="list-group-item">Traefik Proxy</a>
|
|
|
|
<a href="#" class="list-group-item disabled">Advanced Usage</a>
|
|
|
|
<a href="/{{NAME}}/advanced-usage/backup-recovery/" class="list-group-item">Backup and Recovery</a>
|
|
<a href="/{{NAME}}/advanced-usage/deployment-tasks/" class="list-group-item">Deployment Tasks</a>
|
|
<a href="/{{NAME}}/advanced-usage/docker-options/" class="list-group-item">Docker Container Options</a>
|
|
<a href="/{{NAME}}/advanced-usage/registry-management/" class="list-group-item">Docker Registry Management</a>
|
|
<a href="/{{NAME}}/advanced-usage/event-logs/" class="list-group-item">Event Logs</a>
|
|
<a href="/{{NAME}}/advanced-usage/persistent-storage/" class="list-group-item">Persistent Storage</a>
|
|
<a href="/{{NAME}}/advanced-usage/plugin-management/" class="list-group-item">Plugin Management</a>
|
|
<a href="/{{NAME}}/advanced-usage/repository-management/" class="list-group-item">Repository Management</a>
|
|
<a href="/{{NAME}}/advanced-usage/resource-management/" class="list-group-item">Resource Management</a>
|
|
|
|
<a href="#" class="list-group-item disabled">Schedulers</a>
|
|
|
|
<a href="/{{NAME}}/deployment/schedulers/scheduler-management/" class="list-group-item">Scheduler Management</a>
|
|
<a href="/{{NAME}}/deployment/schedulers/docker-local/" class="list-group-item">Docker Local</a>
|
|
<a href="/{{NAME}}/deployment/schedulers/k3s/" class="list-group-item">Kubernetes</a>
|
|
<a href="/{{NAME}}/deployment/schedulers/nomad/" class="list-group-item">Nomad</a>
|
|
<a href="/{{NAME}}/deployment/schedulers/null/" class="list-group-item">Null Scheduler</a>
|
|
|
|
<a href="#" class="list-group-item disabled">Development</a>
|
|
|
|
<a href="/{{NAME}}/development/plugin-creation/" class="list-group-item">Plugin Creation</a>
|
|
<a href="/{{NAME}}/development/plugin-triggers/" class="list-group-item">Plugin Triggers</a>
|
|
<a href="/{{NAME}}/development/testing/" class="list-group-item">Running Tests</a>
|
|
<a href="/{{NAME}}/development/release-process/" class="list-group-item">Release Process</a>
|
|
|
|
<a href="#" class="list-group-item disabled">Continuous Integration</a>
|
|
<a href="/{{NAME}}/deployment/continuous-integration/github-actions/" class="list-group-item">GitHub Actions</a>
|
|
<a href="/{{NAME}}/deployment/continuous-integration/gitlab-ci/" class="list-group-item">GitLab CI</a>
|
|
<a href="/{{NAME}}/deployment/continuous-integration/generic/" class="list-group-item">Generic</a>
|
|
|
|
<a href="#" class="list-group-item disabled">Community Contributions</a>
|
|
<a href="/{{NAME}}/community/clients/" class="list-group-item">Clients</a>
|
|
<a href="/{{NAME}}/community/plugins/" class="list-group-item">Plugins</a>
|
|
</div>
|
|
</div>
|
|
<div class="col-8 col-md-9 markdown-body" style="padding-top:16px">
|
|
{{CONTENT}}
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="rst-versions rst-badge" data-toggle="rst-versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version" data-doc="{{DOC}}" data-ref="{{REF}}">
|
|
<span class="fa fa-book"> </span>
|
|
v: {{REF}}
|
|
<span class="fa fa-caret-down"></span>
|
|
</span>
|
|
<div class="rst-other-versions">
|
|
<dl>
|
|
<dt>Versions</dt>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>On GitHub</dt>
|
|
<dd>
|
|
<a href="https://github.com/{{USER}}/{{NAME}}/blob/master/docs/{{DOC}}" target="_blank">View</a>
|
|
</dd>
|
|
<dd>
|
|
<a href="https://github.com/{{USER}}/{{NAME}}/edit/master/docs/{{DOC}}" target="_blank">Edit</a>
|
|
</dd>
|
|
</dl>
|
|
<hr>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="dev-warning doc-floating-warning" style="display:none">
|
|
This document is for dokku's development version, which can be significantly different from previous releases. For older releases, use the version selector floating in the bottom right corner of this page.
|
|
</div>
|
|
|
|
<!-- Footer section -->
|
|
<footer class="px-4 px-lg-5 text-start mt-5">
|
|
<div class="container">
|
|
<div class="row">
|
|
<div class="col-lg-12 align-self-start text-white">
|
|
<p class="m-0 py-3">© 2013-2022 Dokku. Website designed & developed by <a href="https://yasoob.me" class="text-decoration-none text-white">Yasoob Khalid</a></p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/1.3.0/anchor.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js" integrity="sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2" crossorigin="anonymous"></script>
|
|
|
|
<script src="https://dokku.dpdcart.com/dpd.js"></script>
|
|
<script>
|
|
// Source: https://github.com/Alhadis/Snippets/blob/master/js/polyfills/IE8-child-elements.js
|
|
if (!('nextElementSibling' in document.documentElement)) {
|
|
Object.defineProperty(Element.prototype, 'nextElementSibling', {
|
|
get: function () {
|
|
var e = this.nextSibling;
|
|
while (e && 1 !== e.nodeType) {
|
|
e = e.nextSibling;
|
|
}
|
|
return e;
|
|
}
|
|
});
|
|
}
|
|
// Source: https://jonlabelle.com/snippets/view/javascript/wrap-an-html-element-in-javascript
|
|
HTMLElement.prototype.wrap = function (elms) {
|
|
if (!elms.length) elms = [elms];
|
|
for (var i = elms.length - 1; i >= 0; i--) {
|
|
var child = (i > 0) ? this.cloneNode(true) : this;
|
|
var el = elms[i];
|
|
var parent = el.parentNode;
|
|
var sibling = el.nextSibling;
|
|
child.appendChild(el);
|
|
if (sibling) {
|
|
parent.insertBefore(child, sibling);
|
|
} else {
|
|
parent.appendChild(child);
|
|
}
|
|
}
|
|
};
|
|
|
|
document.addEventListener('DOMContentLoaded', function (e) {
|
|
var markdownBody = document.querySelectorAll('.markdown-body')[0],
|
|
isRedirect = markdownBody.innerHTML.trim().indexOf('<p>See the <a href=') === 0;
|
|
if (isRedirect) {
|
|
var redirectUrl = markdownBody.getElementsByTagName('a')[0].href;
|
|
window.location.replace(redirectUrl);
|
|
}
|
|
anchors.options.visible = 'always';
|
|
anchors.add('.markdown-body h1, .markdown-body h2, .markdown-body h3, .markdown-body h4, .markdown-body h5, .markdown-body h6');
|
|
|
|
var tables = document.querySelectorAll('table'),
|
|
blockquotes = document.querySelectorAll('blockquote'),
|
|
versionList = document.querySelectorAll('.rst-other-versions dl')[0],
|
|
backToContentsEl = document.querySelectorAll('.back-to-contents')[0]
|
|
currentVersionEl = document.querySelectorAll('.rst-current-version')[0],
|
|
currentVersion = currentVersionEl.getAttribute('data-ref'),
|
|
versionContainer = document.querySelectorAll('.rst-versions.rst-badge')[0],
|
|
pageHeader = document.querySelectorAll('.markdown-body p')[0],
|
|
headers = document.querySelectorAll('h2, h3, h4'),
|
|
classNames = ['table', 'table-striped', 'table-hover', 'table-condensed'],
|
|
localPath = location.pathname.split('/').splice(2).join('/'),
|
|
addClass = function (el, className) {
|
|
if (el.classList) {
|
|
el.classList.add(className);
|
|
} else {
|
|
el.className += ' ' + className;
|
|
}
|
|
},
|
|
addListener = function (elem, type, fn) {
|
|
if (elem.addEventListener) {
|
|
elem.addEventListener(type, fn, false);
|
|
} else if (elem.attachEvent) {
|
|
elem.attachEvent('on' + type, function() {
|
|
return fn.call(elem, window.event);
|
|
});
|
|
} else {
|
|
elem['on' + type] = fn;
|
|
}
|
|
},
|
|
hasClass = function (el, className) {
|
|
if (el.classList) {
|
|
return el.classList.contains(className);
|
|
} else {
|
|
return new RegExp('(^| )' + className + '( |$)', 'gi').test(el.className);
|
|
}
|
|
},
|
|
removeClass = function (el, className) {
|
|
if (el.classList) {
|
|
el.classList.remove(className);
|
|
} else {
|
|
el.className = el.className.replace(new RegExp('(^|\\b)' + className.split(' ').join('|') + '(\\b|$)', 'gi'), ' ');;
|
|
}
|
|
},
|
|
languageClass = function (el) {
|
|
if (!hasClass(el, 'highlight')) {
|
|
return;
|
|
}
|
|
var classes = [];
|
|
if (el.classList) {
|
|
classes = el.classList.value.split(/\s+/);
|
|
} else {
|
|
classes = el.className.split(/\s+/);
|
|
}
|
|
var language = null;
|
|
for (i = 0; i < classes.length; i++) {
|
|
if (classes[i].lastIndexOf('highlight-source-', 0) === 0) {
|
|
language = classes[i].replace('highlight-source-', '');
|
|
break;
|
|
}
|
|
}
|
|
return language;
|
|
};
|
|
|
|
addListener(backToContentsEl, 'click', function(e) {
|
|
e.preventDefault();
|
|
var scrollToTop = window.setInterval(function() {
|
|
var pos = window.pageYOffset;
|
|
if ( pos > 0 ) {
|
|
window.scrollTo( 0, pos - 20 );
|
|
} else {
|
|
window.clearInterval( scrollToTop );
|
|
}
|
|
}, 1);
|
|
return false;
|
|
});
|
|
|
|
var ls2 = {
|
|
save : function (key, jsonData, expirationMS) {
|
|
if (typeof (Storage) === 'undefined') { return false; }
|
|
var record = {value: JSON.stringify(jsonData), timestamp: new Date().getTime()/1000 + expirationMS}
|
|
localStorage.setItem(key, JSON.stringify(record));
|
|
return jsonData;
|
|
},
|
|
load : function (key) {
|
|
if (typeof (Storage) === 'undefined') { return false; }
|
|
var record = JSON.parse(localStorage.getItem(key));
|
|
if (!record){return false;}
|
|
return (new Date().getTime()/1000 < record.timestamp && JSON.parse(record.value));
|
|
}
|
|
};
|
|
|
|
var ToC =
|
|
'<nav role="navigation" class="table-of-contents">' +
|
|
'<ul>';
|
|
|
|
var newLine, el, title, link, currentDepth, count = 0, lastNodeDepth = null;
|
|
Array.prototype.forEach.call(headers, function (el, i) {
|
|
count++;
|
|
title = el.innerText || element.textContent;
|
|
link = '#' + el.getAttribute('id');
|
|
currentDepth = parseInt(el.nodeName.replace('H', ''), 10);
|
|
|
|
newLine =
|
|
'<li>' +
|
|
'<a href="' + link + '" class="current-depth-' + currentDepth + '">' +
|
|
title +
|
|
'</a>' +
|
|
'</li>';
|
|
|
|
if (currentDepth === lastNodeDepth || lastNodeDepth === null) {
|
|
} else if (currentDepth > lastNodeDepth) {
|
|
newLine = '<ul>' + newLine;
|
|
} else if (currentDepth < lastNodeDepth) {
|
|
newLine = '</ul>' + newLine;
|
|
}
|
|
ToC += newLine;
|
|
|
|
lastNodeDepth = currentDepth;
|
|
});
|
|
ToC += '</ul></nav>';
|
|
|
|
if (count > 1) {
|
|
var navItems = document.querySelectorAll('.list-group-item');
|
|
Array.prototype.forEach.call(navItems, function(el, i){
|
|
if (el.getAttribute('href') == location.pathname) {
|
|
el.insertAdjacentHTML('afterEnd', ToC);
|
|
}
|
|
});
|
|
}
|
|
|
|
Array.prototype.forEach.call(blockquotes, function (el, i) {
|
|
if (el.innerHTML.toLowerCase().indexOf('warning') !== -1) {
|
|
addClass(el, 'warning');
|
|
el.innerHTML = el.innerHTML.replace('Warning', '<strong>Warning</strong>')
|
|
} else if (el.innerHTML.toLowerCase().indexOf('new as of') !== -1) {
|
|
addClass(el, 'new-as-of');
|
|
} else if (el.innerHTML.toLowerCase().indexOf('not yet released') !== -1) {
|
|
addClass(el, 'not-yet-released');
|
|
}
|
|
});
|
|
Array.prototype.forEach.call(classNames, function (className, i) {
|
|
Array.prototype.forEach.call(tables, function (el, i) {
|
|
addClass(el, className);
|
|
});
|
|
});
|
|
|
|
var addLanguageLabel = function (el, language) {
|
|
var labelWrapper = document.createElement('div'),
|
|
label = document.createElement('div');
|
|
|
|
labelWrapper.setAttribute('class', 'highlight-show-language');
|
|
label.setAttribute('class', 'highlight-show-language-label');
|
|
label.appendChild(document.createTextNode(language));
|
|
labelWrapper.appendChild(label);
|
|
el.insertBefore(labelWrapper, el.firstChild);
|
|
};
|
|
|
|
var highlightElements = document.querySelectorAll('pre');
|
|
Array.prototype.forEach.call(highlightElements, function(el, i) {
|
|
var language = languageClass(el.parentElement);
|
|
if (typeof (language) === 'undefined') {
|
|
return;
|
|
}
|
|
|
|
addLanguageLabel(el.parentElement, language);
|
|
|
|
var nextEl = el.parentElement.nextElementSibling;
|
|
if (nextEl !== null && nextEl.nodeName.toLowerCase() === 'pre') {
|
|
var wrapper = document.createElement('div');
|
|
wrapper.setAttribute('class', 'highlight-output');
|
|
wrapper.wrap(nextEl);
|
|
addLanguageLabel(wrapper, 'output');
|
|
addClass(el, 'highlight-has-output');
|
|
}
|
|
});
|
|
|
|
addListener(currentVersionEl, 'click', function() {
|
|
if (hasClass(versionContainer, 'shift-up')) {
|
|
removeClass(versionContainer, 'shift-up');
|
|
} else {
|
|
addClass(versionContainer, 'shift-up');
|
|
}
|
|
});
|
|
|
|
var range = function(start, count) {
|
|
return Array.apply(0, Array(count))
|
|
.map(function (element, index) {
|
|
return index + start;
|
|
});
|
|
}
|
|
|
|
var parseVersions = function(version, versions) {
|
|
var pieces = version.split('.'),
|
|
prefix = pieces.slice(0, 2).join('.') + '.',
|
|
maxPatchVersion = parseInt(pieces.slice(2, 3)[0], 10),
|
|
versionRange = range(0, maxPatchVersion + 1);
|
|
|
|
for (var i in versionRange) {
|
|
versions.push(prefix.concat(versionRange[i]));
|
|
}
|
|
return versions;
|
|
}
|
|
|
|
var addVersionLink = function(version) {
|
|
var a = document.createElement('a'),
|
|
dd = document.createElement('dd'),
|
|
ref = 'dokku~v' + version,
|
|
versionName = 'v' + version;
|
|
if (version == 'master') {
|
|
ref = 'dokku';
|
|
versionName = 'master';
|
|
}
|
|
|
|
a.setAttribute('href', '/' + ref + '/' + localPath);
|
|
a.appendChild(document.createTextNode(versionName));
|
|
if (versionName == currentVersion) {
|
|
var strong = document.createElement('strong');
|
|
strong.appendChild(a);
|
|
dd.appendChild(strong);
|
|
} else {
|
|
dd.appendChild(a);
|
|
}
|
|
versionList.appendChild(dd);
|
|
};
|
|
|
|
var processVersions = function(data) {
|
|
var versions = [];
|
|
for (var key in data['max-versions']) {
|
|
if (!data['max-versions'].hasOwnProperty(key)) {
|
|
continue;
|
|
}
|
|
|
|
versions = parseVersions(data['max-versions'][key], versions);
|
|
}
|
|
|
|
addVersionLink('master');
|
|
versions.reverse();
|
|
Array.prototype.forEach.call(versions, function (version, i) {
|
|
addVersionLink(version);
|
|
});
|
|
};
|
|
|
|
if (currentVersion === 'master') {
|
|
document.querySelectorAll('.dev-warning')[0].style.position = 'relative';
|
|
Array.prototype.forEach.call(document.querySelectorAll('.dev-warning'), function (el, i) {
|
|
el.style.display = '';
|
|
});
|
|
}
|
|
|
|
data = ls2.load('max-versions');
|
|
if (!data) {
|
|
var request = new XMLHttpRequest();
|
|
request.open('GET', '/dokku/assets/versions.json', true);
|
|
request.setRequestHeader('Cache-Control', 'no-cache, no-store');
|
|
|
|
request.onload = function() {
|
|
if (request.status >= 200 && request.status < 400) {
|
|
var data = JSON.parse(request.responseText);
|
|
// store for 1 day
|
|
ls2.save('max-versions', data, 86400);
|
|
processVersions(data);
|
|
}
|
|
};
|
|
|
|
request.onerror = function() {
|
|
// There was a connection error of some sort
|
|
};
|
|
|
|
request.send();
|
|
} else {
|
|
processVersions(data);
|
|
}
|
|
});
|
|
</script>
|
|
</body>
|
|
</html>
|