diff --git a/docs/deployment/methods/tar.md b/docs/deployment/methods/tar.md new file mode 100644 index 000000000..a32e1c09e --- /dev/null +++ b/docs/deployment/methods/tar.md @@ -0,0 +1,25 @@ +# Tarfile Deployment + +> New as of 0.4.0 + +``` +tar:from # Loads an app tarball from url +tar:in # Reads an tarball containing the app from stdin +``` + +## Deploying from a tarball + +In some cases, it may be useful to deploy an application from a tarball. For instance, if you implemented a non-git based deployment plugin, tarring the generated artifact may be an easier route to interface with the existing dokku infrastructure. + +You can place the tarball on an external webserver and deploy via the `tar:from` command. + +```shell +dokku tar:from node-js-app https://dokku.me/releases/node-js-app/v1 +``` + +As an alternative, a deploy can be trigged from a tarball read from stdin using the `tar:in` command: + +```shell +# run from the generated artifact directory +tar c . $* | dokku tar:in node-js-app +``` diff --git a/docs/template.html b/docs/template.html index c1284301b..f98fb94b6 100644 --- a/docs/template.html +++ b/docs/template.html @@ -143,6 +143,7 @@ Buildpack Deployment Dockerfile Deployment Docker Image Deployment + Tarfile Deployment Configuration diff --git a/plugins/tar/commands b/plugins/tar/commands index ce4db88f9..60a8123a5 100755 --- a/plugins/tar/commands +++ b/plugins/tar/commands @@ -7,7 +7,6 @@ case "$1" in help_content_func () { declare desc="return tar plugin help content" cat<, Reads an tarball containing the app from stdin tar:from , Loads an app tarball from url help_content