docs/deployment/methods/tar.md

# Tarball Deployment

> New as of 0.4.0

```
tar:from <app> <url>                           # Loads an app tarball from url
tar:in <app>                                   # Reads an tarball containing the app from stdin
```

> When triggering `dokku ps:rebuild APP` on an application deployed via the `tar` plugin, the following may occur:
>
> - Applications previously deployed via another method (`git`): The application may revert to a state before the latest custom image tag was deployed.
> - Applications that were only ever deployed via the `tar` plugin: The application will be properly rebuilt.
>
> Please use the appropriate `tar` command when redeploying an application deployed via tarball.

## Usage

### 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
```

### Deploying via stdin

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
```
Document caveats around ps:rebuild and tags/tar deployed applications. Closes #2374 The tags and tar plugins do not necessarily build from source, and running `ps:rebuild` can have some unexpected output in certain cases. Rather than try to handle that complexity - it's a lot - documenting the edge cases is the most appropriate way forward. 2016-09-06 20:26:53 -04:00			`# Tarball Deployment`
Document tar deployment method [ci skip] 2016-07-05 01:16:57 -04:00
			`> New as of 0.4.0`

			```
			`tar:from <app> <url> # Loads an app tarball from url`
			`tar:in <app> # Reads an tarball containing the app from stdin`
			```

Document caveats around ps:rebuild and tags/tar deployed applications. Closes #2374 The tags and tar plugins do not necessarily build from source, and running `ps:rebuild` can have some unexpected output in certain cases. Rather than try to handle that complexity - it's a lot - documenting the edge cases is the most appropriate way forward. 2016-09-06 20:26:53 -04:00			> When triggering `dokku ps:rebuild APP` on an application deployed via the `tar` plugin, the following may occur:
			`>`
			> - Applications previously deployed via another method (`git`): The application may revert to a state before the latest custom image tag was deployed.
			> - Applications that were only ever deployed via the `tar` plugin: The application will be properly rebuilt.
			`>`
Add missing space [ci skip] 2016-09-07 10:29:23 -04:00			> Please use the appropriate `tar` command when redeploying an application deployed via tarball.
Document caveats around ps:rebuild and tags/tar deployed applications. Closes #2374 The tags and tar plugins do not necessarily build from source, and running `ps:rebuild` can have some unexpected output in certain cases. Rather than try to handle that complexity - it's a lot - documenting the edge cases is the most appropriate way forward. 2016-09-06 20:26:53 -04:00
Use correct casing for Dokku name lowercase should only be used to refer to the binary, not the project 2016-09-03 04:39:12 -04:00			`## Usage`
Document tar deployment method [ci skip] 2016-07-05 01:16:57 -04:00
Use correct casing for Dokku name lowercase should only be used to refer to the binary, not the project 2016-09-03 04:39:12 -04:00			`### Deploying from a tarball`

Fix Deployment guides style 2019-02-19 20:01:24 +08:00			`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.`
Document tar deployment method [ci skip] 2016-07-05 01:16:57 -04:00
			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`
			```

Use correct casing for Dokku name lowercase should only be used to refer to the binary, not the project 2016-09-03 04:39:12 -04:00			`### Deploying via stdin`

Document tar deployment method [ci skip] 2016-07-05 01:16:57 -04:00			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`
			```