github.com/verdaccio
1
0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2025-02-21 07:29:37 +01:00
Code Releases Wiki Activity

docs: update dev plugins

Browse Source
This commit is contained in:
Juan Picado @jotadeveloper 2018-05-28 23:47:15 +02:00
parent 658775220d
commit fdb6fcd9fb
No known key found for this signature in database
GPG Key ID: 18AC54485952D158
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/dev-plugins.md
View File

@ -80,14 +80,16 @@ Where `htpasswd` is the sufix of the plugin name. eg: `verdaccio-htpasswd` and t
## Middleware Plugin
Middleware plugins have the capability to modify the API layer, either adding new endpoints or intercepting requests. A pretty good example
of middleware plugin is the [sinopia-github-oauth](https://github.com/soundtrackyourbrand/sinopia-github-oauth) compatible with `verdaccio`.
Middleware plugins have the capability to modify the API layer, either adding new endpoints or intercepting requests.
> A pretty good example
of middleware plugin is the [sinopia-github-oauth](https://github.com/soundtrackyourbrand/sinopia-github-oauth) and [verdaccio-audit](https://github.com/verdaccio/verdaccio-audit).
### API
```js
function register_middlewares(expressApp, auth, storage) {
...more stuff
function register_middlewares(expressApp, authInstance, storageInstance) {
/* more stuff */
}
```
@ -97,7 +99,7 @@ To register a middleware we need an object with a single method called `register
## Storage Plugin
Since `verdaccio@3.x` we also can plug a custom storage.
Verdaccio by default uses a file system storage plugin [local-storage](https://github.com/verdaccio/local-storage) but, since `verdaccio@3.x` you can plug in a custom storage.
### API