zoriya/flood
1
0
Fork 0
mirror of https://github.com/zoriya/flood.git synced 2026-06-04 03:27:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Iss 646 (#664)

Browse Source 
* Update README.md

- fix github GFM to reset counter of markdown ordered list
- note about baseURI change that need recompiling

* Update config.template.js

add warning about baseURI change
This commit is contained in:
Alexandre ZANNI
2018-05-09 20:10:13 +02:00
committed by John Furrow
parent f32d8e69d6
commit f4b90eb799
2 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -4
View File
@@ -34,16 +34,18 @@ If you have a specific issue or bug, please file a Github issue. If you want to
4. If you're proxying Flood to a path other than the root of the host, you must specify the `baseURI` in `config.js`. All request URIs will be prefixed with this value.
* For example, if hosting Flood from `https://foo.bar/apps/flood`, you would set `baseURI` to `/apps/flood`. If hosting flood from `https://foo.bar`, you do not need to configure `baseURI`.
**Note**: each time you modify `baseURI` in `config.js` you need to recompile assets (`npm run build`). To be sure follow the *Updating* procedure each time you modify the `config.js` file.
#### Compiling assets and starting the server
1. Run `npm install`.
* Note: Since #523 [node-gyp](https://www.npmjs.com/package/node-gyp) is needed. **IF** you need `sudo`, use `sudo npm i --unsafe-perm` (see [here](https://github.com/nodejs/node-gyp/issues/454) for why `--unsafe-perm`) else installation will fail. If you dont need sudo just use `npm i` as usual.
* If your system use python3 as default you will need to install python2 and use `npm i --python="/usr/bin/python2"`.
1. Run `npm run build`.
1. Run `npm start`.
1. Access the UI in your browser. Defaults to `localhost:3000`.
2. Run `npm run build`.
3. Run `npm start`.
4. Access the UI in your browser. Defaults to `localhost:3000`.
* You may change the default port in `config.js`.
1. Upon loading the UI the first time, you will be prompted to create a user account.
5. Upon loading the UI the first time, you will be prompted to create a user account.
#### Updating
config.template.js
+1
View File
@@ -6,6 +6,7 @@
const CONFIG = {
// The URL that Flood will be served from. For example, if you intend to
// serve from http://example.com/flood, set this to '/flood'.
// Recompiling assets with `npm run build` is needed after each `baseURI` change.
baseURI: '/',
// Flood uses a local nedb database to keep track of users, torrents,
// and activity. The database is regularly purged to remove outdated data.