Skip to content

Commit

Permalink
Better document the "url" config option, refs #7
Browse files Browse the repository at this point in the history
  • Loading branch information
shesek committed Oct 10, 2019
1 parent f465d46 commit 3567471
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ $ filebazaar

FileBazaar's configuration options can be managed using the `_filebazaar.yaml` file or via environment variables.
All config options are optional and have sane defaults except for `charge_token` and `token_secret`, which are required.
If you're accessing the web server remotely, you probably also want to set `host` and `url`.
See [`lib/config.js`](https://github.com/elementsproject/filebazaar/blob/master/src/lib/config.js) for more details.

Below is an example `_filebazaar.yaml` file:
Expand Down
2 changes: 2 additions & 0 deletions _filebazaar.yaml.example
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ env: production

#port: 9678
#host: 127.0.0.1

# For remote access, set the URL where the web server is publicly available. Defaults to http://{host}:{port}
#url: http://my-public-url.com/

### Lightning Charge
Expand Down

0 comments on commit 3567471

Please sign in to comment.