SunRed/haste-server
1
0
Fork 0
mirror of https://github.com/SunRed/haste-server.git synced 2025-09-05 21:10:16 +02:00
Code Issues Releases Activity

Updated config documentation, changed env vars

Browse source 
Removed HASTE_ prefix as it would not work on evironments like Heroku, relevant comment: https://github.com/zneix/haste-server/pull/7#issuecomment-695790378
This commit is contained in:
zneix 2020-09-20 16:39:49 +02:00
parent 58c37bf677
commit 45b4ce87a8
WARNING! Although there is a key with this ID in the database it does not verify this commit! This commit is SUSPICIOUS.
GPG key ID: 911916E0523B22F6
4 changed files with 14 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/install.md
View file

@ -53,18 +53,21 @@ npm install
## Edit configuration
There is an [example configuration file](../example.config.json) available for you to copy:
Haste can already work "out-of-the-box" with no config changes - useful for environments like Heroku or Dokku.
You can use `HOST` and `PORT` environment variables for host and port specification to override config values.
However, there is an [example configuration file](../example.config.js) available for you to copy:
```bash
cp example.config.json config.json
cp example.config.js config.js
```
By default storage system stores haste documents as hashed files in `./data` directory.
Rest of provided defaults are enough to run the server, however, example config contains comments about what each value does and you can adjust the options to your likings.
[Guide for all supported storage systems.](./storage.md).
[Guide for all supported key generators.](./generators.md).
[Guide for all supported storage systems](./storage.md).
[Guide for all supported key generators](./generators.md).
## Run the server