diff options
| author | marzavec <admin@marzavec.com> | 2018-05-20 02:21:08 +0200 |
|---|---|---|
| committer | marzavec <admin@marzavec.com> | 2018-05-20 02:21:08 +0200 |
| commit | a70006b5bca3c3273ba34bfd0607235339e87583 (patch) | |
| tree | f360e6d4e5e636956fa03a32a6f8064285ba424a /documentation/DEPLOY.md | |
| parent | Merge pull request #12 from neelkamath/master (diff) | |
| download | hackchat-a70006b5bca3c3273ba34bfd0607235339e87583.tar.gz hackchat-a70006b5bca3c3273ba34bfd0607235339e87583.zip | |
streamline dev flow
Diffstat (limited to 'documentation/DEPLOY.md')
| -rw-r--r-- | documentation/DEPLOY.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/documentation/DEPLOY.md b/documentation/DEPLOY.md new file mode 100644 index 0000000..344165c --- /dev/null +++ b/documentation/DEPLOY.md @@ -0,0 +1,14 @@ +# Live Deployment Installation + +1. [Clone](https://help.github.com/articles/cloning-a-repository/) the repository: `git clone https://github.com/hack-chat/main.git` +1. Change the directory: `cd main/server` +1. Install server dependencies: `npm install` +1. Configure the server: `npm run config` (you may also migrate a `config` directory into `./main/server` if you previously configured the server elsewhere) +1. Migrate the contents of `./main/client` into any suitable directory of your webserver +1. (OPTIONAL) Cleanup; you may delete `main/clientSource` and `main/documentation` + + You can now run start the server software with a process manager like [PM2](https://github.com/Unitech/pm2) (e.g., `pm2 start server/main.js --name HackChat`). If you plan on using SSL to serve the client; you will need to use a reverse proxy, as TLS is not natively supported by the hack.chat server software (this may change in future releases). + +# Advanced + +(TODO) |