Rewrite upgrade instructions

This commit is contained in:
Hugo Peixoto committed 2020-07-14 19:36:55 +01:00
1 parent a52dbafc5f
commit a72c04ed65
1 file changed
+49 -47
+49 -47
View File
@@ -2,6 +2,7 @@
If your version of Dokku is pre 0.3.0 (check with `dokku version`), we recommend [a fresh install](/docs/getting-started/installation.md) on a new server. If your version of Dokku is pre 0.3.0 (check with `dokku version`), we recommend [a fresh install](/docs/getting-started/installation.md) on a new server.
## Security Updates ## Security Updates
For any security related updates, please follow our [Twitter account](https://twitter.com/dokku). As Dokku does not run any daemons, the security risk introduced by our software is minimal. For any security related updates, please follow our [Twitter account](https://twitter.com/dokku). As Dokku does not run any daemons, the security risk introduced by our software is minimal.
@@ -15,67 +16,43 @@ Your operating system may occasionally provide security updates. We recommend se
Docker releases updates periodically to their engine. We recommend reading their release notes and upgrading accordingly. Please see the [Docker documentation](https://docs.docker.com/) for more details. Docker releases updates periodically to their engine. We recommend reading their release notes and upgrading accordingly. Please see the [Docker documentation](https://docs.docker.com/) for more details.
Finally, we provide a helpful binary called `dokku-update`. This is a recommended package that:
- Can be installed separately, so upgrading Dokku will not affect the running of this package.
- Automates many of the upgrade instructions for you.
- Provides a clean way for us to further enhance the upgrade process in the future.
When installing from source, this is available from `contrib/dokku-update`, and is also available on Debian and RPM-based systems from our package repositories under the name `dokku-update`.
## Migration Guides ## Migration Guides
Before upgrading, check the migration guides to get comfortable with new features and prepare your deployment to be upgraded. Before upgrading, check the migration guides to get comfortable with new features and prepare your deployment to be upgraded.
### 0.5 Migration Guide - [Upgrading to 0.20](/docs/appendices/0.20.0-migration-guide.md)
- [Upgrading to 0.10](/docs/appendices/0.10.0-migration-guide.md)
- [Upgrading to 0.9](/docs/appendices/0.9.0-migration-guide.md)
- [Upgrading to 0.8](/docs/appendices/0.8.0-migration-guide.md)
- [Upgrading to 0.7](/docs/appendices/0.7.0-migration-guide.md)
- [Upgrading to 0.6](/docs/appendices/0.6.0-migration-guide.md)
- [Upgrading to 0.5](/docs/appendices/0.5.0-migration-guide.md)
- [0.5 Migration Guide](/docs/appendices/0.5.0-migration-guide.md)
### 0.6 Migration Guide ## Before upgrading
- [0.6 Migration Guide](/docs/appendices/0.6.0-migration-guide.md) If you'll be updating docker simultaneously, it's recommended that you stop all
applications before upgrading:
### 0.7 Migration Guide
- [0.7 Migration Guide](/docs/appendices/0.7.0-migration-guide.md)
### 0.8 Migration Guide
- [0.8 Migration Guide](/docs/appendices/0.8.0-migration-guide.md)
### 0.9 Migration Guide
- [0.9 Migration Guide](/docs/appendices/0.9.0-migration-guide.md)
### 0.10 Migration Guide
- [0.10 Migration Guide](/docs/appendices/0.10.0-migration-guide.md)
### 0.20 Migration Guide
- [0.20 Migration Guide](/docs/appendices/0.20.0-migration-guide.md)
## Upgrade Instructions
If Dokku was installed via `apt-get install dokku` or `bootstrap.sh` (most common), upgrade with:
```shell ```shell
# update your local apt cache # for 0.11.4 and newer versions, use:
sudo apt-get update
# stop each running app
# for 0.11.4 and newer versions, use
dokku ps:stopall dokku ps:stopall
# for versions between 0.8.1 and 0.11.3, use # for versions between 0.8.1 and 0.11.3, use
dokku --quiet apps:list | xargs -L1 dokku ps:stop dokku --quiet apps:list | xargs -L1 dokku ps:stop
# for versions versions older than 0.8.1, use # for versions versions older than 0.8.1, use
dokku --quiet apps | xargs -L1 dokku ps:stop dokku --quiet apps | xargs -L1 dokku ps:stop
```
# update dokku and its dependencies ## After upgrading
sudo apt-get install -qq -y dokku herokuish sshcommand plugn gliderlabs-sigil
# rebuild all of your applications After upgrading, you should rebuild the applications to take advantage of any
dokku ps:rebuildall # rebuilds all applications new buildpacks that were released:
```shell
dokku ps:rebuildall
``` ```
> If you have any applications deployed via the `tags` or `tar` commands, do not run the `ps:rebuildall` command, > If you have any applications deployed via the `tags` or `tar` commands, do not run the `ps:rebuildall` command,
@@ -88,12 +65,38 @@ dokku ps:rebuildall # rebuilds all applications
> Please see the [images documentation](/docs/deployment/methods/images.md) and [tar documentation](/docs/deployment/methods/tar.md) > Please see the [images documentation](/docs/deployment/methods/images.md) and [tar documentation](/docs/deployment/methods/tar.md)
> for instructions on rebuilding applications deployed by those plugins. > for instructions on rebuilding applications deployed by those plugins.
### Upgrade From Source
## Upgrading using `dokku-update`
We provide a helpful binary called `dokku-update`. This is a recommended package that:
- Can be installed separately, so upgrading Dokku will not affect the running of this package.
- Automates many of the upgrade instructions for you.
- Provides a clean way for us to further enhance the upgrade process in the future.
When installing from source, this is available from `contrib/dokku-update`, and is also available on Debian and RPM-based systems from our package repositories under the name `dokku-update`.
## Upgrading using `apt`
If Dokku was installed in a Debian or Ubuntu system, via `apt install dokku` or `bootstrap.sh`, you can upgrade with `apt`:
```shell
# update your local apt cache
sudo apt update
# update dokku and its dependencies
sudo apt install -qq -y dokku herokuish sshcommand plugn gliderlabs-sigil
# or just upgrade every package:
sudo apt upgrade
```
## Upgrading from source
If you installed Dokku from source (less common), upgrade with: If you installed Dokku from source (less common), upgrade with:
```shell ```shell
dokku --quiet apps | xargs -L1 dokku ps:stop # stops each running app
cd ~/dokku cd ~/dokku
git pull --tags origin master git pull --tags origin master
@@ -102,7 +105,6 @@ sudo DOKKU_BRANCH=master make install
# upgrade to debian package-based installation # upgrade to debian package-based installation
sudo make install sudo make install
dokku ps:rebuildall # rebuilds all applications
``` ```
To upgrade Herokuish from source, upgrade with: To upgrade Herokuish from source, upgrade with: