depau/HackMD
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

fixing manual upgrade instructions and completing requirements

Browse source 
Signed-off-by: Claudius <opensource@amenthes.de>
This commit is contained in:
Claudius 2019-04-15 21:53:32 +02:00
parent 074198f941
commit 32d3b914b2
1 changed files with 19 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
docs/setup/manual-setup.md
View file

@ -6,34 +6,35 @@ Manual Installation
- Node.js 6.x or up (test up to 7.5.0) and <10.x - Node.js 6.x or up (test up to 7.5.0) and <10.x
- Database (PostgreSQL, MySQL, MariaDB, SQLite, MSSQL) use charset `utf8` - Database (PostgreSQL, MySQL, MariaDB, SQLite, MSSQL) use charset `utf8`
- npm (and its dependencies, [node-gyp](https://github.com/nodejs/node-gyp#installation)) - npm (and its dependencies, [node-gyp](https://github.com/nodejs/node-gyp#installation))
- yarn
- `libssl-dev` for building scrypt (see [here](https://github.com/ml1nk/node-scrypt/blob/master/README.md#installation-instructions) for further information) - `libssl-dev` for building scrypt (see [here](https://github.com/ml1nk/node-scrypt/blob/master/README.md#installation-instructions) for further information)
- Bash (for the setup script)
- For **building** CodiMD we recommend to use a machine with at least **2GB** RAM - For **building** CodiMD we recommend to use a machine with at least **2GB** RAM
## Instructions ## Instructions
1. Download a release and unzip or clone into a directory 1. Check if you meet the [requirements at the top of this document](#requirements-on-your-server).
2. Enter the directory and type `bin/setup`, which will install npm dependencies and create configs. The setup script is written in Bash, you would need bash as a prerequisite. 2. Clone this repository (preferred) or download a release and unzip it.
3. Setup the configs, see more below 3. Enter the directory and type `bin/setup`, which will install npm dependencies and create configs.
4. Setup environment variables which will overwrite the configs 4. Setup the configs, see more below
5. Build front-end bundle by `npm run build` (use `npm run dev` if you are in development) 5. Setup environment variables which will overwrite the configs
6. Modify the file named `.sequelizerc`, change the value of the variable `url` with your db connection string 6. Build front-end bundle by `npm run build` (use `npm run dev` if you are in development)
7. Modify the file named `.sequelizerc`, change the value of the variable `url` with your db connection string
For example: `postgres://username:password@localhost:5432/codimd` For example: `postgres://username:password@localhost:5432/codimd`
7. Run `node_modules/.bin/sequelize db:migrate`, this step will migrate your db to the latest schema 8. It is recommended to start your server manually once: `npm start --production`, this way it's easier to see warnings or errors that might occur (leave out `--production` for development).
8. Run the server as you like (node, forever, pm2) 9. Run the server as you like (node, forever, pm2, SystemD, Init-Scripts)
## How to upgrade your installation ## How to upgrade your installation
:warning: When you are still running from the old repository, please run: `git remote set-url origin https://github.com/codimd/server.git` :warning:
If you are upgrading CodiMD from an older version, follow these steps: If you are upgrading CodiMD from an older version, follow these steps:
1. Fully stop your old server first (important) 1. Check if you meet the [requirements at the top of this document](#requirements-on-your-server).
2. `git pull` or do whatever that updates the files 2. Verify which version you were running before and take a look at [migrations and breaking changes](../guides/migrations-and-breaking-changes.md) to see if additional steps, or configuration changes are necessary!
3. `npm install` to update dependencies 3. Fully stop your old CodiMD server.
4. Build front-end bundle by `npm run build` (use `npm run dev` if you are in development) 4. `git pull` or unzip a new release in the directory.
5. Modify the file named `.sequelizerc`, change the value of the variable `url` with your db connection string 5. Run `bin/setup`. This will take care of installing dependencies. It is safe to run on an existing installation.
For example: `postgres://username:password@localhost:5432/codimd` 6. Build front-end bundle by `npm run build` (use `npm run dev` if you are in development).
6. Run `node_modules/.bin/sequelize db:migrate`, this step will migrate your db to the latest schema 7. It is recommended to start your server manually once: `npm start --production`, this way it's easier to see warnings or errors that might occur (leave out `--production` for development).
7. Start your whole new server! 8. You can now restart the CodiMD server!