diff options
| author | David Mehren | 2020-07-10 19:59:32 +0200 |
|---|---|---|
| committer | GitHub | 2020-07-10 19:59:32 +0200 |
| commit | 3db8b0df43b027d15d13047e25617266ddc57f13 (patch) | |
| tree | da64f90f7cd4ab4c1deaf67a572a45c2a583dc7e /docs/setup | |
| parent | 0b7dbd1f43899b4321ddf41bf98a64a7bd5fa48d (diff) | |
| parent | 89895cef2e5785134bf1fdcc9c8813831c07f17b (diff) | |
Merge pull request #410 from oupala/feature/markdown-linting
Diffstat (limited to 'docs/setup')
| -rw-r--r-- | docs/setup/cloudron.md | 3 | ||||
| -rw-r--r-- | docs/setup/docker-linuxserver.md | 6 | ||||
| -rw-r--r-- | docs/setup/docker.md | 9 | ||||
| -rw-r--r-- | docs/setup/heroku.md | 3 | ||||
| -rw-r--r-- | docs/setup/kubernetes.md | 3 | ||||
| -rw-r--r-- | docs/setup/manual-setup.md | 17 |
6 files changed, 21 insertions, 20 deletions
diff --git a/docs/setup/cloudron.md b/docs/setup/cloudron.md index a33fd2f1..f2ba8b97 100644 --- a/docs/setup/cloudron.md +++ b/docs/setup/cloudron.md @@ -1,5 +1,4 @@ -Cloudron -=== +# Cloudron CodiMD is available as a 1-click install on [Cloudron](https://cloudron.io). Cloudron makes it easy to run apps like CodiMD on your server and keep them up-to-date and secure. diff --git a/docs/setup/docker-linuxserver.md b/docs/setup/docker-linuxserver.md index f99176e8..344bcfab 100644 --- a/docs/setup/docker-linuxserver.md +++ b/docs/setup/docker-linuxserver.md @@ -1,13 +1,11 @@ -LinuxServer.io CodiMD Image -=== +# LinuxServer.io CodiMD Image + [](https://discord.gg/YWrKVTn)[](https://microbadger.com/images/linuxserver/codimd "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/codimd "Get your own version badge on microbadger.com")[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-codimd/job/master/)[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/codimd/latest/index.html) [LinuxServer.io](https://linuxserver.io) have created an Ubuntu-based multi-arch container image for x86-64, arm64 and armhf which supports PDF export from all architectures using [PhantomJS](https://phantomjs.org/). - It supports all the environment variables detailed in the [configuration documentation](../configuration-env-vars.md) to modify it according to your needs. - - It gets rebuilt on new releases from CodiMD and also weekly if necessary to update any other package changes in the underlying container, making it easy to keep your CodiMD instance up to date. - - It also details how to easily [utilize Docker networking to reverse proxy](https://github.com/linuxserver/docker-codimd/#application-setup) CodiMD using their [LetsEncrypt docker image](https://github.com/linuxserver/docker-letsencrypt) In order to contribute check the LinuxServer.io [GitHub repository](https://github.com/linuxserver/docker-codimd/) for CodiMD. diff --git a/docs/setup/docker.md b/docs/setup/docker.md index 0268727c..a9a8b240 100644 --- a/docs/setup/docker.md +++ b/docs/setup/docker.md @@ -1,15 +1,12 @@ -CodiMD Docker Image -=== +# CodiMD Docker Image [](http://play-with-docker.com?stack=https://github.com/codimd/container/raw/master/docker-compose.yml&stack_name=codimd) - -**Debian-based version:** +## Debian-based version [](https://quay.io/repository/codimd/server) - -**Alpine-based version:** +## Alpine-based version [](https://quay.io/repository/codimd/server) diff --git a/docs/setup/heroku.md b/docs/setup/heroku.md index 9dc3bb3a..9f62e58c 100644 --- a/docs/setup/heroku.md +++ b/docs/setup/heroku.md @@ -1,5 +1,4 @@ -Heroku Deployment -=== +# Heroku Deployment You can quickly setup a sample Heroku CodiMD application by clicking the button below. diff --git a/docs/setup/kubernetes.md b/docs/setup/kubernetes.md index db596851..91c57188 100644 --- a/docs/setup/kubernetes.md +++ b/docs/setup/kubernetes.md @@ -1,5 +1,4 @@ -Kubernetes -=== +# Kubernetes To install use `helm install stable/hackmd`. 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 |