summaryrefslogtreecommitdiff
path: root/docs/setup/manual-setup.md
diff options
context:
space:
mode:
authoroupala2020-07-01 11:52:17 +0200
committeroupala2020-07-10 18:57:59 +0200
commit2f462f90d4608763e5cb9618ec80d939a679fe2e (patch)
tree0f13c88084116c53edfd0752576b7f596b5d8030 /docs/setup/manual-setup.md
parent73219909602e026616af6a97f588bc9e0eab1fa8 (diff)
style: linting markdown files
Linting markdown files according to default remark-lint configuration. Files inside the `public` directory were not linted. Signed-off-by: oupala <oupala@users.noreply.github.com>
Diffstat (limited to '')
-rw-r--r--docs/setup/manual-setup.md17
1 files changed, 13 insertions, 4 deletions
diff --git a/docs/setup/manual-setup.md b/docs/setup/manual-setup.md
index 3979cebc..4a2ad902 100644
--- a/docs/setup/manual-setup.md
+++ b/docs/setup/manual-setup.md
@@ -1,33 +1,42 @@
-Manual Installation
-===
+# Manual Installation
## Requirements on your server
- Node.js 8.5 or up
+
- 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)
-- 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
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. Modify `config.json` or configure CodiMD through environment variables which will
overwrite the configs, see docs [here](https://github.com/codimd/server/blob/master/docs/configuration.md).
+
5. Build front-end bundle by `yarn run build` (use `yarn run dev` if you are in development)
+
6. 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:`
+
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).
-8. Run the server as you like (node, forever, pm2, SystemD, Init-Scripts)
+8. Run the server as you like (node, forever, pm2, SystemD, Init-Scripts)
## How to upgrade your installation