diff --git a/README.md b/README.md index 40e04a04..83a10376 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,20 @@ In development you can quickly get an environment running using Docker by follow 1. Ensure that the bot token scope contains at least `users:read` 1. Run `make up`. This will download dependencies, build and launch a development version of Outline +### Upgrade + +#### Docker + +If you're running Outline with Docker you'll need to run migrations within the docker container after updating the image. The command will be something like: +``` +docker run --rm outlinewiki/outline:latest yarn sequelize:migrate +``` +#### Yarn + +If you're running Outline by cloning this repository, run the following command to upgrade: +``` +yarn upgrade +``` ## Development diff --git a/package.json b/package.json index e2ed4fe9..7d0c7513 100644 --- a/package.json +++ b/package.json @@ -17,6 +17,7 @@ "heroku-postbuild": "yarn build && yarn sequelize:migrate", "sequelize:create-migration": "sequelize migration:create", "sequelize:migrate": "sequelize db:migrate", + "upgrade": "git fetch && git pull && yarn install && yarn heroku-postbuild", "test": "yarn test:app && yarn test:server", "test:app": "jest", "test:server": "jest --config=server/.jestconfig.json --runInBand --forceExit",