Commit 125f39126d641932fa6ea0bf4af24df471f727c0
Document bootstrap route and needShasum config
cel committed on 8/29/2018, 11:26:05 PMParent: bf2c8915dee53c4a685241c0b75ac581a663ae81
Files changed
| README.md | changed |
| README.md | |||
|---|---|---|---|
| @@ -46,8 +46,9 @@ | |||
| 46 | 46 … | "host": "localhost", | |
| 47 | 47 … | "port": 8043, | |
| 48 | 48 … | "autoAuth": true, | |
| 49 | 49 … | "fetchAll": true, | |
| 50 … | + "needShasum": false, | ||
| 50 | 51 … | "wsLink": "http://localhost:8989" | |
| 51 | 52 … | } | |
| 52 | 53 … | } | |
| 53 | 54 … | ``` | |
| @@ -56,8 +57,9 @@ | |||
| 56 | 57 … | - `config.npm.autoAuth`: whether to automatically update `~/.npmrc` to add | |
| 57 | 58 … | - `config.npm.fetchAll`: whether to fetch blobs for all versions of a package, | |
| 58 | 59 … | to populate package metadata, for a request to a `/<package>` path. Most npm | |
| 59 | 60 … | clients require this. default is `true` | |
| 61 … | +- `config.npm.needShasum`: whether to fetch always calculate and send package shasums. Default is `false` but will always calculate the shasum in response to a request from `npm < v5` | ||
| 60 | 62 … | - `config.npm.wsLink`: URL for ssb-ws server that serves blobs, which the registry will link to. Default is to use HTTP and `config.host` (or `localhost`) and `config.ws.port` (or `8989`) to attempt to link to scuttlebot's local ssb-ws server. | |
| 61 | 63 … | ||
| 62 | 64 … | ## API | |
| 63 | 65 … | ||
| @@ -94,8 +96,12 @@ | |||
| 94 | 96 … | ||
| 95 | 97 … | In addition to the npm registry routes, ssb-npm-registry's web server (and | |
| 96 | 98 … | `respond` method) serve the following additional routes: | |
| 97 | 99 … | ||
| 100 … | +### `/-/bootstrap` - Bootstrap shell snippet | ||
| 101 … | + | ||
| 102 … | +Serves a shell script to for installing `ssb-npm-registry` and using it to install other `ssb-npm` packages by running in a bootstrap mode where it does not require running `scuttlebot`. | ||
| 103 … | + | ||
| 98 | 104 … | ### `/-/prebuild/:name` - Prebuild blobs | |
| 99 | 105 … | ||
| 100 | 106 … | `name` should be the name of a blob in the format | |
| 101 | 107 … | `{name}-v{version}-{runtime}-v{abi}-{platform}{libc}-{arch}.tar.gz`. | |
Built with git-ssb-web