summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMax Wu2016-06-14 22:57:54 +0800
committerGitHub2016-06-14 22:57:54 +0800
commitb4b8d4757f95a13efcf7e406893a489c4679d76d (patch)
tree2a0e2aebfd9a17abdd06cd2e82ecedb746f17649
parent2bff75a9f42a5156e5ffb83d6834e83cb3b432ea (diff)
Update README.md
-rw-r--r--README.md16
1 files changed, 10 insertions, 6 deletions
diff --git a/README.md b/README.md
index 17441063..57830f8f 100644
--- a/README.md
+++ b/README.md
@@ -43,13 +43,17 @@ Get started
4. Setup environment variables, which will overwrite the configs
5. Run the server as you like (node, forever, pm2)
-DB migration
+Upgrade guide
---
-If you are upgrading HackMD from an older version, you might need to do this to apply the DB schema changes.
-
-1. Modify the file named `.sequelizerc`, change the value of the variable `url` with your db connection string.
- For example: `postgres://username:password@localhost:5432/hackmd`
-2. Run `node_modules/.bin/sequelize db:migrate`, that's it!
+If you are upgrading HackMD from an older version, follow below steps:
+
+1. Fully stop your old server first (important).
+2. `git pull` or whatever that really update the files.
+3. Modify the file named `.sequelizerc`, change the value of the variable `url` with your db connection string.
+ For example: `postgres://username:password@localhost:5432/hackmd`.
+4. Run `node_modules/.bin/sequelize db:migrate`, this step will migrate your db with the latest schema.
+ You can also revert the migration with `node_modules/.bin/sequelize db:migrate:undo` (do this with caution).
+5. Retart your whole new server!
Structure
---