diff --git a/docs/upgrading.md b/docs/upgrading.md index 1f49f6adc..a2a02e4e6 100644 --- a/docs/upgrading.md +++ b/docs/upgrading.md @@ -1,73 +1,62 @@ # Upgrading -Dokku is in active development. You can update the deployment step and the build step separately. +This document covers upgrades for the 0.3.0 series and up. If upgrading from previous versions, we recommend [a fresh install](http://progrium.viewdocs.io/dokku/installation) on a new server. -**Note**: If you are upgrading from a revision prior to [27d4bc8c3c](https://github.com/progrium/dokku/commit/27d4bc8c3c19fe580ef3e65f2f85b85101cd83e4), follow the instructions in [this wiki entry](https://github.com/progrium/dokku/wiki/Migrating-to-Dokku-0.2.0). +> As of 0.3.18, dokku is installed by default via a debian package. Source-based installations are still available, though not recommended. -To update the deploy step (this is updated less frequently): +## Dokku + +If dokku was installed via a debian package, you can upgrade dokku via the following command: + +```shell +sudo apt-get install dokku +``` + +For unattended upgrades, you may run the following command: + +```shell +sudo apt-get install -qq -y dokku +``` + +If you have installed dokku from source, you may run the following commands to upgrade: ```shell cd ~/dokku git pull --tags origin master + +# continue to install from source +sudo DOKKU_BRANCH=master make install + +# upgrade to debian package-based installation sudo make install ``` -Nothing needs to be restarted. Changes will take effect on the next push / deployment. - -To update the build step: +All changes will take effect upon next application deployment. To trigger a rebuild of every application, simply run the following command: ```shell +dokku ps:rebuildall +``` + +## Buildstep image + +If dokku was installed via a debian package, you can upgrade buildstep via the following command: + +```shell +sudo apt-get install buildstep +``` + +For unattended upgrades, you may run the following command: + +```shell +sudo apt-get install -qq -y buildstep +``` + +In some cases, it may be desirable to run a specific version of buildstep. To install/upgrade buildstep from source, run the following commands: + +```shell +cd /tmp git clone https://github.com/progrium/buildstep.git cd buildstep git pull origin master sudo make build ``` - -This will build a fresh Ubuntu Quantal image, install a number of packages, and -eventually replace the Docker image for buildstep. - -## Migrating from 0.1.0 to 0.2.0 - -This should be summary of breaking changes between 0.1 and 0.2 version with instructions to upgrade. - -### software-properties-common - -software-properties-common is now a dependency for plugins. Before running dokku install script, make sure it is installed. - -```shell -> sudo apt-get install software-properties-common -``` - -### Gitreceive removed - -PR [#270](https://github.com/progrium/dokku/pull/270). - -Starting with Dokku 0.2.0, [Gitrecieve](https://github.com/progrium/gitreceive) is replaced by a `git` plugin. - -Dokku no longer uses the `git` user. Everything is done with the `dokku` user account. - -This causes the remote url to change. Instead of pushing to `git@hostname:app`, you should now push to `dokku@hostname:app`. -The url must be modified using the `git remote set-url` command : - - git remote set-url deploy dokku@hostname:app - -Where `deploy` is the name of the remote. - -Additionally, the repositiories on the server must be migrated to work with dokku 0.2.0 - -There is an upgrade [script](https://gist.github.com/plietar/7201430), which is meant to automate this migration. To use it: - -1. run the script as root -2. `git pull` to get the latest version of dokku -3. make install -4. `dokku ps:restartall` - -TDB. - -### Cache directory - -Commit [#6350f373](https://github.com/progrium/dokku/commit/6350f373be2cef4f3bb90912099e1be6196522d1) - -Buildstep have to be re-installed in order to support cache directory. - -TDB.