diff options
| author | Sheogorath | 2019-12-20 11:04:40 +0100 |
|---|---|---|
| committer | GitHub | 2019-12-20 11:04:40 +0100 |
| commit | 6733e8ead2c5b6fab78173b181a9fd116526dc49 (patch) | |
| tree | 4c545c2098760f82a2e72af19d10a8f441d16cbe /docs/setup | |
| parent | 33150b79c7a4c3ba456afdadb31c709b3be18980 (diff) | |
| parent | 5c552b81a0065e832a1a92c2a857ea8def153b56 (diff) | |
Merge pull request #243 from bluehood/docs
[DOC] Misc improvements to manual setup instructions
Diffstat (limited to 'docs/setup')
| -rw-r--r-- | docs/setup/manual-setup.md | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/docs/setup/manual-setup.md b/docs/setup/manual-setup.md index e13a6f12..f12371ed 100644 --- a/docs/setup/manual-setup.md +++ b/docs/setup/manual-setup.md @@ -4,7 +4,9 @@ Manual Installation ## Requirements on your server - Node.js 8.5 or up -- Database (PostgreSQL, MySQL, MariaDB, SQLite, MSSQL) use charset `utf8` +- Database (PostgreSQL, MySQL, MariaDB, SQLite, MSSQL). Must use charset `utf8`: this is typically the + default in PostgreSQL and SQLite, while in MySQL and MariaDB utf8 might need to be set with + `alter database <DBNAME> character set utf8 collate utf8_bin;` - npm (and its dependencies, [node-gyp](https://github.com/nodejs/node-gyp#installation)) - yarn - Bash (for the setup script) @@ -16,11 +18,14 @@ Manual Installation 1. Check if you meet the [requirements at the top of this document](#requirements-on-your-server). 2. Clone this repository (preferred) or download a release and unzip it. 3. Enter the directory and type `bin/setup`, which will install npm dependencies and create configs. -4. Setup the configs, see more below -5. Setup environment variables which will overwrite the configs +4. Modify `config.json`, see docs [here](https://github.com/codimd/server/blob/master/docs/configuration-config-file.md). +5. Instead of modifying `config.json`, it's possible to configure CodiMD through environment variables which will + overwrite the configs, see docs [here](https://github.com/codimd/server/blob/master/docs/configuration-env-vars.md). 6. Build front-end bundle by `yarn run build` (use `yarn 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` +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` + - `mysql://username:password@localhost:3306/codimd` + - `sqlite://:memory:` 8. It is recommended to start your server manually once: `yarn start --production`, this way it's easier to see warnings or errors that might occur (leave out `--production` for development). 9. Run the server as you like (node, forever, pm2, SystemD, Init-Scripts) |