Skip to content

Commit

Permalink
Merge pull request #2 from drewwells/patch-2
Browse files Browse the repository at this point in the history
updates documentation for address
  • Loading branch information
fgeller authored May 18, 2020
2 parents 20463d8 + 23318cf commit 7eb4745
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ $ bilder -config /path/to/your/config.json

It currently supports the following options:

+ `port` *default:* `8173`: This is the port that bilder will serve on.
+ `addr` *default:* `0.0.0.0:8173`: This is the address that bilder will serve on.
+ `url-path-prefix` *default:* `""`: This is a prefix that can be added to the assets' paths that are loaded from the browser. This allows bilder to run behind a proxy like nginx (e.g. if you want to use nginx to terminate the HTTPS connection). Consider the path of the demo linked above: [https://geller.io/bilder/b/kitties](https://geller.io/bilder/b/kitties). In this case nginx proxy passes to bilder under the `/bilder` path which we would set `url-path-prefix` to:
```
location /bilder/ {
Expand All @@ -51,7 +51,7 @@ bilder/kitties/happy.jpg

This is the JSON file that is used for the [demo](https://geller.io/bilder/b/kitties):
```
{ "bilder-dir": "/home/fgeller/var/bilder", "url-path-prefix": "/bilder" }
{ "bilder-dir": "/home/fgeller/var/bilder", "url-path-prefix": "/bilder", "addr": "0.0.0.0:8173" }
```

### Albums
Expand Down

0 comments on commit 7eb4745

Please sign in to comment.