Lomanic
/
bibliogram
mirror of https://git.sr.ht/~cadence/bibliogram
1
0
Fork 0
Code Issues Releases Wiki Activity

Revise README installation instructions

This commit is contained in:
Cadence Fish 2020-02-14 22:55:26 +13:00
parent b7dbc733b8
commit 351bdefb8e
No known key found for this signature in database
GPG Key ID: 81015DF9AA8607E1
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -58,17 +58,20 @@ If you only use one computer, you can install Bibliogram on that computer and th
## Installing
You need [node.js](https://nodejs.org/en/) to run Bibliogram. Versions before 12.13.0 are untested.
Quick setup, if you've run webservers before:
1. `$ git clone https://github.com/cloudrac3r/bibliogram`
1. Install [node.js](https://nodejs.org/en/) (^12.13.0 suggested)
1. `$ git clone https://github.com/cloudrac3r/bibliogram`
If you are using a fork, be sure to actually install that fork instead!
1. `cd bibliogram`
1. `$ cd bibliogram`
1. `$ npm install --no-optional` (for Tor support, omit `--no-optional`)
1. Edit `/config.js` to suit your server environment
1. `$ npm start`
Bibliogram is now running on `0.0.0.0:10407`.
See [Wiki:Installing](https://github.com/cloudrac3r/bibliogram/wiki/Installing) and [Wiki:Configuring](https://github.com/cloudrac3r/bibliogram/wiki/Configuring) for more details.
## User-facing endpoints
- `/` - homepage