From 2fcfaa8a99c77f239ac7750ee744b6f6df07f20e Mon Sep 17 00:00:00 2001 From: Wyatt Johnson Date: Wed, 12 Apr 2017 15:08:07 -0600 Subject: [PATCH] More updates --- INSTALL.md | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 942b99377..fd2c5175f 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -46,6 +46,17 @@ yarn yarn build ``` +After you create/modify the `plugins.json` (refer to `PLUGINS.md` for plugin +docs) file, you can re-run the following to install their dependancies: + +```bash +# Reconcile plugins +./bin/cli plugins reconcile + +# Build static files +yarn build +``` + ### Running Refer to the `README.md` file for required configuration variables to add to the @@ -57,7 +68,8 @@ You can start the server after configuring the server using the command: yarn start ``` -This will setup the server to serve everything on a single node.js process. +This will setup the server to serve everything on a single node.js process and +is designed to be used in production. You can see other scripts we've made available by consulting the `package.json` file under the `scripts` key including: @@ -65,7 +77,8 @@ file under the `scripts` key including: - `yarn test` run unit tests - `yarn e2e` run end to end tests - `yarn build-watch` watch for changes to client files and build static assets -- `yarn dev-start` watch for changes to server files and reload the server +- `yarn dev-start` watch for changes to server files and reload the server while + also sourcing a `.env` file in your local directory for configuration ## Installation From Docker @@ -74,6 +87,17 @@ the dependancy install and asset build process. https://hub.docker.com/r/coralproject/talk/ +Images are tagged using the following notation: + +- `x` (where `x` is the major version number): any minor or patch updates will be included in this. If you're ok getting + new features occationally and all the bug fixes, this is the tag for you. +- `x.y` (where `y` is the minor version number): +- `x.y.z` (where `z` is the patch version): + +We provide tags with `*-onbuild` that can be used for easy plugin integration and +acts as a customization endpoint. Instructions are provided in the `PLUGINS.md` +document as to how to use it. + ### Requirements There are some runtime requirements for running Talk for Docker: @@ -126,7 +150,15 @@ for [Docker Links](https://docs.docker.com/compose/networking/#links). ### Running +If you're using docker compose: + ```bash # Start the services using compose docker-compose up -d ``` + +If you're using plain docker: + +```bash +docker run -d -P coralproject/talk:latest +``` \ No newline at end of file