From a19fe02782f80da67da3fff6d99be95c2e5643b7 Mon Sep 17 00:00:00 2001 From: Wyatt Johnson Date: Fri, 14 Apr 2017 14:48:44 -0600 Subject: [PATCH] Added setup/usage docs --- INSTALL.md | 46 ++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 44 insertions(+), 2 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index a7ccf302d..49e78ee7d 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,3 +1,11 @@ +## Contents + +- [Installation](#installation) - install the application on a machine + - [Via Docker](#installation-from-docker) + - [Via Source](#installation-from-source) +- [Setup](#setup) - setup the application for first use +- [Usage](#usage) - connect the application to a website + # Installation ## Requirements @@ -176,7 +184,7 @@ You can also clone the git repository via: git clone https://github.com/coralproject/talk.git ``` -#### Setup +#### Building We now have to install the dependencies and build the static assets. @@ -220,4 +228,38 @@ file under the `scripts` key including: - `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 while - also sourcing a `.env` file in your local directory for configuration \ No newline at end of file + also sourcing a `.env` file in your local directory for configuration + +# Setup + +Once you've installed Talk (either via Docker or source), you still need to +setup the application. If you are unfamiliar with any terminoligy used in the +setup process, refer to the `TERMINOLOGY.md` document. + +## Via Web + +If you want to perform your setup via the web, you can navigate to your +installation of Talk at the path `/admin/install`. There you will be asked a +series of questions for your installation. + +## Via CLI + +If you want to perform your setup through the terminal, you can simply run: + +```bash +cli setup +``` + +And follow the instructions to perform initial setup and create your first user +account. + + +# Usage + +After setup is complete, you can then refer to the `/admin/configure` path to +get the embed code that you can copy/paste onto your blog or website in order to +start using Talk. + +_In order for the embed to work correctly, you will need to whitelist the domain +that is allowed to embed your site on the `/admin/configure` page, failure to do +so will result in the comment stream not loading._