From 8b6ccdcbb728ba318d1aa73a36c8ebb8007333a2 Mon Sep 17 00:00:00 2001 From: Wolvan Date: Thu, 3 Feb 2022 21:30:25 +0100 Subject: [PATCH] Update Readme to describe self-hosting --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 7151d38..24615ea 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,24 @@ You want more cutting edge? Under [dev.poll.horse](https://dev.poll.horse/) you ## API This service offers an API to create and get the status of polls. The API Docs can be found [here](API.md). +## Running your own instance of Poll.Horse +### Standalone +1. Make sure you have [Node](https://www.nodejs.org/) installed. +2. Download the latest release source code from [the releases page](https://github.com/Wolvan/poll.horse/releases/); +3. Extract the zip file anywhere +4. Open a shell in in the directory you just extracted to and run `npm i` +5. Run `npm run build` to build the project +6. Start the server with `npm start` +7. List all available options with `npm start -- --help` or use shell options with `npm start -- ` + +### Docker +1. Install [Docker](https://www.docker.com/get-started) +2. Download/clone the contents of this repository +3. Open a shell in the directory and run `docker build -t poll.horse` +4. Use `docker run poll.horse` +5. Optionally mount config file at `/usr/src/app/config.json` +6. Optionally mount persistent directory to `/data` + ## Contributing The core is written in TypeScript, a typed superset to Javascript and executed with NodeJS. Pull Requests welcome.