diff options
Diffstat (limited to 'docs/setup')
| -rw-r--r-- | docs/setup/cloudron.md | 6 | ||||
| -rw-r--r-- | docs/setup/docker-linuxserver.md | 14 | ||||
| -rw-r--r-- | docs/setup/docker.md | 23 | ||||
| -rw-r--r-- | docs/setup/heroku.md | 7 | ||||
| -rw-r--r-- | docs/setup/kubernetes.md | 6 | ||||
| -rw-r--r-- | docs/setup/manual-setup.md | 39 |
6 files changed, 95 insertions, 0 deletions
diff --git a/docs/setup/cloudron.md b/docs/setup/cloudron.md new file mode 100644 index 00000000..aa707dc4 --- /dev/null +++ b/docs/setup/cloudron.md @@ -0,0 +1,6 @@ +Cloudron +=== + +Install CodiMD on [Cloudron](https://cloudron.io): + +[](https://cloudron.io/button.html?app=io.hackmd.cloudronapp) diff --git a/docs/setup/docker-linuxserver.md b/docs/setup/docker-linuxserver.md new file mode 100644 index 00000000..f99176e8 --- /dev/null +++ b/docs/setup/docker-linuxserver.md @@ -0,0 +1,14 @@ +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. +And to find all tags and versions of the image, check the [Docker Hub repository](https://hub.docker.com/r/linuxserver/codimd). diff --git a/docs/setup/docker.md b/docs/setup/docker.md new file mode 100644 index 00000000..0268727c --- /dev/null +++ b/docs/setup/docker.md @@ -0,0 +1,23 @@ +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:** + +[](https://quay.io/repository/codimd/server) + + +**Alpine-based version:** + +[](https://quay.io/repository/codimd/server) + +The easiest way to setup CodiMD using docker are using the following three commands: + +```sh +git clone https://github.com/codimd/container.git codimd-container +cd codimd-container +docker-compose up +``` +Read more about it in the [container repository](https://github.com/codimd/container). diff --git a/docs/setup/heroku.md b/docs/setup/heroku.md new file mode 100644 index 00000000..9dc3bb3a --- /dev/null +++ b/docs/setup/heroku.md @@ -0,0 +1,7 @@ +Heroku Deployment +=== + +You can quickly setup a sample Heroku CodiMD application by clicking the button +below. + +[](https://heroku.com/deploy?template=https://github.com/codimd/server/tree/master) diff --git a/docs/setup/kubernetes.md b/docs/setup/kubernetes.md new file mode 100644 index 00000000..db596851 --- /dev/null +++ b/docs/setup/kubernetes.md @@ -0,0 +1,6 @@ +Kubernetes +=== + +To install use `helm install stable/hackmd`. + +For all further details, please check out the offical CodiMD [K8s helm chart](https://github.com/kubernetes/charts/tree/master/stable/hackmd). diff --git a/docs/setup/manual-setup.md b/docs/setup/manual-setup.md new file mode 100644 index 00000000..e15e624a --- /dev/null +++ b/docs/setup/manual-setup.md @@ -0,0 +1,39 @@ +Manual Installation +=== + +## Requirements on your server + +- Node.js 8.5 or up +- Database (PostgreSQL, MySQL, MariaDB, SQLite, MSSQL) use charset `utf8` +- 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 + + +## 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. Setup the configs, see more below +5. Setup environment variables which will overwrite the configs +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` +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). +9. Run the server as you like (node, forever, pm2, SystemD, Init-Scripts) + + +## How to upgrade your installation + +If you are upgrading CodiMD from an older version, follow these steps: + +1. Check if you meet the [requirements at the top of this document](#requirements-on-your-server). +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. Fully stop your old CodiMD server. +4. `git pull` or unzip a new release in the directory. +5. Run `bin/setup`. This will take care of installing dependencies. It is safe to run on an existing installation. +6. Build front-end bundle by `npm run build` (use `npm run dev` if you are in development). +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. You can now restart the CodiMD server! |