Commit 96aff9dafdb188a781d3b37c947f1e02bee95ab8
Readme: clarify config options
cel committed on 8/25/2019, 9:01:50 PMParent: a2e4bfb1c3aad80b5a96cc0f888f9af1f6af6021
Files changed
| README.md | changed |
| README.md | ||
|---|---|---|
| @@ -37,30 +37,37 @@ | ||
| 37 | 37 … | |
| 38 | 38 … | ``` |
| 39 | 39 … | git ssb web [<options>] [<host:port>] |
| 40 | 40 … | ``` |
| 41 | -- `host`: hostname to listen on. defaults to `localhost`. | |
| 42 | -- `port`: port to listen on. defaults to `7718`. | |
| 43 | 41 … | |
| 44 | -Options: | |
| 45 | -- `--public`: make the app read-only (e.g. disable making digs), to make it | |
| 46 | - suitable for serving publicly | |
| 42 … | +`host` and `port` override the `host` and `port` settings from the config (described below), and default to `localhost:7718`. | |
| 47 | 43 … | |
| 44 … | +Options are passed to `ssb-config`, so e.g. `--public` sets config `{"public": true}`. | |
| 45 … | + | |
| 48 | 46 … | ## Config |
| 49 | 47 … | |
| 50 | 48 … | `~/.ssb/config`: |
| 51 | 49 … | ``` |
| 52 | 50 … | { |
| 51 … | + "public": false, | |
| 53 | 52 … | "git-ssb-web": { |
| 54 | 53 … | "host": "127.0.0.1", |
| 55 | 54 … | "port": 7718, |
| 56 | 55 … | "computeIssueCounts": false |
| 57 | 56 … | } |
| 58 | 57 … | } |
| 59 | 58 … | ``` |
| 60 | 59 … | |
| 61 | -Set `computeIssueCounts` to `true` to calculate counts of open issues and pull requests to display in the navigation links of a repo. This involves an expensive query at startup. | |
| 60 … | +top-level config options: | |
| 62 | 61 … | |
| 62 … | +- `public` (boolean): make the app not publish messages, so it is more suitable for public web hosting. Disables making digs or modifying issues, opening pull-requests, etc. | |
| 63 … | + | |
| 64 … | +`git-ssb-web` config options: | |
| 65 … | + | |
| 66 … | +- `host`: hostname to listen on. defaults to `localhost`. | |
| 67 … | +- `port`: port to listen on. defaults to `7718`. | |
| 68 … | +- `computeIssueCounts` (boolean): Calculate counts of open issues and pull requests to display in the navigation links of a repo. This involves an expensive query at startup. Default: `false`. | |
| 69 … | + | |
| 63 | 70 … | ## Screenshots |
| 64 | 71 … | |
| 65 | 72 … |  |
| 66 | 73 … | |
Built with git-ssb-web