mirror of
https://github.com/verdaccio/verdaccio.git
synced 2024-12-30 22:34:10 -05:00
docs: new Crowdin translations (#714)
docs: new Crowdin translations (#714)
This commit is contained in:
parent
fdb6fcd9fb
commit
f034a3af05
18 changed files with 72 additions and 90 deletions
|
@ -77,13 +77,15 @@ Where `htpasswd` is the sufix of the plugin name. eg: `verdaccio-htpasswd` and t
|
||||||
|
|
||||||
## Middleware Plugin
|
## 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
|
### API
|
||||||
|
|
||||||
```js
|
```js
|
||||||
function register_middlewares(expressApp, auth, storage) {
|
function register_middlewares(expressApp, authInstance, storageInstance) {
|
||||||
...more stuff
|
/* more stuff */
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -91,7 +93,7 @@ To register a middleware we need an object with a single method called `register
|
||||||
|
|
||||||
## Storage Plugin
|
## 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
|
### API
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,7 @@ $> npm install --global verdaccio-activedirectory
|
||||||
|
|
||||||
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
||||||
|
|
||||||
&> npm install --global sinopia-memory
|
$> npm install --global sinopia-memory
|
||||||
|
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
@ -30,8 +30,6 @@ The default configuration looks like this, due we use a build-in `htpasswd` plug
|
||||||
```yaml
|
```yaml
|
||||||
htpasswd:
|
htpasswd:
|
||||||
file: ./htpasswd
|
file: ./htpasswd
|
||||||
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
||||||
# You can set this to -1 to disable registration.
|
|
||||||
#max_users: 1000
|
#max_users: 1000
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -53,8 +51,6 @@ This is tecnically possible, the plugins order becames important, the the creden
|
||||||
auth:
|
auth:
|
||||||
htpasswd:
|
htpasswd:
|
||||||
file: ./htpasswd
|
file: ./htpasswd
|
||||||
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
||||||
# You can set this to -1 to disable registration.
|
|
||||||
#max_users: 1000
|
#max_users: 1000
|
||||||
activedirectory:
|
activedirectory:
|
||||||
url: "ldap://10.0.100.1"
|
url: "ldap://10.0.100.1"
|
||||||
|
@ -84,7 +80,7 @@ store:
|
||||||
|
|
||||||
> If you define a custom store, the property **storage** in the configuration file will be ignored.
|
> If you define a custom store, the property **storage** in the configuration file will be ignored.
|
||||||
|
|
||||||
## Legacy plugins compatible with **Verdaccio**.
|
## Legacy plugins
|
||||||
|
|
||||||
### Sinopia Plugins
|
### Sinopia Plugins
|
||||||
|
|
||||||
|
|
|
@ -77,13 +77,15 @@ Where `htpasswd` is the sufix of the plugin name. eg: `verdaccio-htpasswd` and t
|
||||||
|
|
||||||
## Middleware Plugin
|
## 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
|
### API
|
||||||
|
|
||||||
```js
|
```js
|
||||||
function register_middlewares(expressApp, auth, storage) {
|
function register_middlewares(expressApp, authInstance, storageInstance) {
|
||||||
...more stuff
|
/* more stuff */
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -91,7 +93,7 @@ To register a middleware we need an object with a single method called `register
|
||||||
|
|
||||||
## Storage Plugin
|
## 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
|
### API
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,7 @@ $> npm install --global verdaccio-activedirectory
|
||||||
|
|
||||||
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
||||||
|
|
||||||
&> npm install --global sinopia-memory
|
$> npm install --global sinopia-memory
|
||||||
|
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
@ -30,8 +30,6 @@ The default configuration looks like this, due we use a build-in `htpasswd` plug
|
||||||
```yaml
|
```yaml
|
||||||
htpasswd:
|
htpasswd:
|
||||||
file: ./htpasswd
|
file: ./htpasswd
|
||||||
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
||||||
# You can set this to -1 to disable registration.
|
|
||||||
#max_users: 1000
|
#max_users: 1000
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -53,8 +51,6 @@ This is tecnically possible, the plugins order becames important, the the creden
|
||||||
auth:
|
auth:
|
||||||
htpasswd:
|
htpasswd:
|
||||||
file: ./htpasswd
|
file: ./htpasswd
|
||||||
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
||||||
# You can set this to -1 to disable registration.
|
|
||||||
#max_users: 1000
|
#max_users: 1000
|
||||||
activedirectory:
|
activedirectory:
|
||||||
url: "ldap://10.0.100.1"
|
url: "ldap://10.0.100.1"
|
||||||
|
@ -84,7 +80,7 @@ store:
|
||||||
|
|
||||||
> If you define a custom store, the property **storage** in the configuration file will be ignored.
|
> If you define a custom store, the property **storage** in the configuration file will be ignored.
|
||||||
|
|
||||||
## Legacy plugins compatible with **Verdaccio**.
|
## Legacy plugins
|
||||||
|
|
||||||
### Sinopia Plugins
|
### Sinopia Plugins
|
||||||
|
|
||||||
|
|
|
@ -77,13 +77,15 @@ Where `htpasswd` is the sufix of the plugin name. eg: `verdaccio-htpasswd` and t
|
||||||
|
|
||||||
## Middleware Plugin
|
## 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
|
### API
|
||||||
|
|
||||||
```js
|
```js
|
||||||
function register_middlewares(expressApp, auth, storage) {
|
function register_middlewares(expressApp, authInstance, storageInstance) {
|
||||||
...more stuff
|
/* more stuff */
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -91,7 +93,7 @@ To register a middleware we need an object with a single method called `register
|
||||||
|
|
||||||
## Storage Plugin
|
## 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
|
### API
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,7 @@ $> npm install --global verdaccio-activedirectory
|
||||||
|
|
||||||
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
||||||
|
|
||||||
&> npm install --global sinopia-memory
|
$> npm install --global sinopia-memory
|
||||||
|
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
@ -30,8 +30,6 @@ The default configuration looks like this, due we use a build-in `htpasswd` plug
|
||||||
```yaml
|
```yaml
|
||||||
htpasswd:
|
htpasswd:
|
||||||
file: ./htpasswd
|
file: ./htpasswd
|
||||||
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
||||||
# You can set this to -1 to disable registration.
|
|
||||||
#max_users: 1000
|
#max_users: 1000
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -53,8 +51,6 @@ This is tecnically possible, the plugins order becames important, the the creden
|
||||||
auth:
|
auth:
|
||||||
htpasswd:
|
htpasswd:
|
||||||
file: ./htpasswd
|
file: ./htpasswd
|
||||||
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
||||||
# You can set this to -1 to disable registration.
|
|
||||||
#max_users: 1000
|
#max_users: 1000
|
||||||
activedirectory:
|
activedirectory:
|
||||||
url: "ldap://10.0.100.1"
|
url: "ldap://10.0.100.1"
|
||||||
|
@ -84,7 +80,7 @@ store:
|
||||||
|
|
||||||
> If you define a custom store, the property **storage** in the configuration file will be ignored.
|
> If you define a custom store, the property **storage** in the configuration file will be ignored.
|
||||||
|
|
||||||
## Legacy plugins compatible with **Verdaccio**.
|
## Legacy plugins
|
||||||
|
|
||||||
### Sinopia Plugins
|
### Sinopia Plugins
|
||||||
|
|
||||||
|
|
|
@ -77,13 +77,15 @@ Where `htpasswd` is the sufix of the plugin name. eg: `verdaccio-htpasswd` and t
|
||||||
|
|
||||||
## Middleware Plugin
|
## 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
|
### API
|
||||||
|
|
||||||
```js
|
```js
|
||||||
function register_middlewares(expressApp, auth, storage) {
|
function register_middlewares(expressApp, authInstance, storageInstance) {
|
||||||
...more stuff
|
/* more stuff */
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -91,7 +93,7 @@ To register a middleware we need an object with a single method called `register
|
||||||
|
|
||||||
## Storage Plugin
|
## 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
|
### API
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,7 @@ $> npm install --global verdaccio-activedirectory
|
||||||
|
|
||||||
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
||||||
|
|
||||||
&> npm install --global sinopia-memory
|
$> npm install --global sinopia-memory
|
||||||
|
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
@ -30,8 +30,6 @@ The default configuration looks like this, due we use a build-in `htpasswd` plug
|
||||||
```yaml
|
```yaml
|
||||||
htpasswd:
|
htpasswd:
|
||||||
file: ./htpasswd
|
file: ./htpasswd
|
||||||
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
||||||
# You can set this to -1 to disable registration.
|
|
||||||
#max_users: 1000
|
#max_users: 1000
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -53,8 +51,6 @@ This is tecnically possible, the plugins order becames important, the the creden
|
||||||
auth:
|
auth:
|
||||||
htpasswd:
|
htpasswd:
|
||||||
file: ./htpasswd
|
file: ./htpasswd
|
||||||
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
||||||
# You can set this to -1 to disable registration.
|
|
||||||
#max_users: 1000
|
#max_users: 1000
|
||||||
activedirectory:
|
activedirectory:
|
||||||
url: "ldap://10.0.100.1"
|
url: "ldap://10.0.100.1"
|
||||||
|
@ -84,7 +80,7 @@ store:
|
||||||
|
|
||||||
> If you define a custom store, the property **storage** in the configuration file will be ignored.
|
> If you define a custom store, the property **storage** in the configuration file will be ignored.
|
||||||
|
|
||||||
## Legacy plugins compatible with **Verdaccio**.
|
## Legacy plugins
|
||||||
|
|
||||||
### Sinopia Plugins
|
### Sinopia Plugins
|
||||||
|
|
||||||
|
|
|
@ -77,13 +77,15 @@ Where `htpasswd` is the sufix of the plugin name. eg: `verdaccio-htpasswd` and t
|
||||||
|
|
||||||
## Middleware Plugin
|
## 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
|
### API
|
||||||
|
|
||||||
```js
|
```js
|
||||||
function register_middlewares(expressApp, auth, storage) {
|
function register_middlewares(expressApp, authInstance, storageInstance) {
|
||||||
...more stuff
|
/* more stuff */
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -91,7 +93,7 @@ To register a middleware we need an object with a single method called `register
|
||||||
|
|
||||||
## Storage Plugin
|
## 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
|
### API
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,7 @@ $> npm install --global verdaccio-activedirectory
|
||||||
|
|
||||||
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
||||||
|
|
||||||
&> npm install --global sinopia-memory
|
$> npm install --global sinopia-memory
|
||||||
|
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
@ -30,8 +30,6 @@ The default configuration looks like this, due we use a build-in `htpasswd` plug
|
||||||
```yaml
|
```yaml
|
||||||
htpasswd:
|
htpasswd:
|
||||||
file: ./htpasswd
|
file: ./htpasswd
|
||||||
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
||||||
# You can set this to -1 to disable registration.
|
|
||||||
#max_users: 1000
|
#max_users: 1000
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -53,8 +51,6 @@ This is tecnically possible, the plugins order becames important, the the creden
|
||||||
auth:
|
auth:
|
||||||
htpasswd:
|
htpasswd:
|
||||||
file: ./htpasswd
|
file: ./htpasswd
|
||||||
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
||||||
# You can set this to -1 to disable registration.
|
|
||||||
#max_users: 1000
|
#max_users: 1000
|
||||||
activedirectory:
|
activedirectory:
|
||||||
url: "ldap://10.0.100.1"
|
url: "ldap://10.0.100.1"
|
||||||
|
@ -84,7 +80,7 @@ store:
|
||||||
|
|
||||||
> If you define a custom store, the property **storage** in the configuration file will be ignored.
|
> If you define a custom store, the property **storage** in the configuration file will be ignored.
|
||||||
|
|
||||||
## Legacy plugins compatible with **Verdaccio**.
|
## Legacy plugins
|
||||||
|
|
||||||
### Sinopia Plugins
|
### Sinopia Plugins
|
||||||
|
|
||||||
|
|
|
@ -77,13 +77,15 @@ Where `htpasswd` is the sufix of the plugin name. eg: `verdaccio-htpasswd` and t
|
||||||
|
|
||||||
## Middleware Plugin
|
## 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
|
### API
|
||||||
|
|
||||||
```js
|
```js
|
||||||
function register_middlewares(expressApp, auth, storage) {
|
function register_middlewares(expressApp, authInstance, storageInstance) {
|
||||||
...more stuff
|
/* more stuff */
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -91,7 +93,7 @@ To register a middleware we need an object with a single method called `register
|
||||||
|
|
||||||
## Storage Plugin
|
## 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
|
### API
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,7 @@ $> npm install --global verdaccio-activedirectory
|
||||||
|
|
||||||
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
||||||
|
|
||||||
&> npm install --global sinopia-memory
|
$> npm install --global sinopia-memory
|
||||||
|
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
@ -30,8 +30,6 @@ The default configuration looks like this, due we use a build-in `htpasswd` plug
|
||||||
```yaml
|
```yaml
|
||||||
htpasswd:
|
htpasswd:
|
||||||
file: ./htpasswd
|
file: ./htpasswd
|
||||||
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
||||||
# You can set this to -1 to disable registration.
|
|
||||||
#max_users: 1000
|
#max_users: 1000
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -53,8 +51,6 @@ This is tecnically possible, the plugins order becames important, the the creden
|
||||||
auth:
|
auth:
|
||||||
htpasswd:
|
htpasswd:
|
||||||
file: ./htpasswd
|
file: ./htpasswd
|
||||||
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
||||||
# You can set this to -1 to disable registration.
|
|
||||||
#max_users: 1000
|
#max_users: 1000
|
||||||
activedirectory:
|
activedirectory:
|
||||||
url: "ldap://10.0.100.1"
|
url: "ldap://10.0.100.1"
|
||||||
|
@ -84,7 +80,7 @@ store:
|
||||||
|
|
||||||
> If you define a custom store, the property **storage** in the configuration file will be ignored.
|
> If you define a custom store, the property **storage** in the configuration file will be ignored.
|
||||||
|
|
||||||
## Legacy plugins compatible with **Verdaccio**.
|
## Legacy plugins
|
||||||
|
|
||||||
### Sinopia Plugins
|
### Sinopia Plugins
|
||||||
|
|
||||||
|
|
|
@ -77,13 +77,15 @@ Where `htpasswd` is the sufix of the plugin name. eg: `verdaccio-htpasswd` and t
|
||||||
|
|
||||||
## Middleware Plugin
|
## 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
|
### API
|
||||||
|
|
||||||
```js
|
```js
|
||||||
function register_middlewares(expressApp, auth, storage) {
|
function register_middlewares(expressApp, authInstance, storageInstance) {
|
||||||
...more stuff
|
/* more stuff */
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -91,7 +93,7 @@ To register a middleware we need an object with a single method called `register
|
||||||
|
|
||||||
## Storage Plugin
|
## 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
|
### API
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,7 @@ $> npm install --global verdaccio-activedirectory
|
||||||
|
|
||||||
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
||||||
|
|
||||||
&> npm install --global sinopia-memory
|
$> npm install --global sinopia-memory
|
||||||
|
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
@ -30,8 +30,6 @@ The default configuration looks like this, due we use a build-in `htpasswd` plug
|
||||||
```yaml
|
```yaml
|
||||||
htpasswd:
|
htpasswd:
|
||||||
file: ./htpasswd
|
file: ./htpasswd
|
||||||
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
||||||
# You can set this to -1 to disable registration.
|
|
||||||
#max_users: 1000
|
#max_users: 1000
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -53,8 +51,6 @@ This is tecnically possible, the plugins order becames important, the the creden
|
||||||
auth:
|
auth:
|
||||||
htpasswd:
|
htpasswd:
|
||||||
file: ./htpasswd
|
file: ./htpasswd
|
||||||
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
||||||
# You can set this to -1 to disable registration.
|
|
||||||
#max_users: 1000
|
#max_users: 1000
|
||||||
activedirectory:
|
activedirectory:
|
||||||
url: "ldap://10.0.100.1"
|
url: "ldap://10.0.100.1"
|
||||||
|
@ -84,7 +80,7 @@ store:
|
||||||
|
|
||||||
> If you define a custom store, the property **storage** in the configuration file will be ignored.
|
> If you define a custom store, the property **storage** in the configuration file will be ignored.
|
||||||
|
|
||||||
## Legacy plugins compatible with **Verdaccio**.
|
## Legacy plugins
|
||||||
|
|
||||||
### Sinopia Plugins
|
### Sinopia Plugins
|
||||||
|
|
||||||
|
|
|
@ -77,13 +77,15 @@ Where `htpasswd` is the sufix of the plugin name. eg: `verdaccio-htpasswd` and t
|
||||||
|
|
||||||
## Middleware Plugin
|
## 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
|
### API
|
||||||
|
|
||||||
```js
|
```js
|
||||||
function register_middlewares(expressApp, auth, storage) {
|
function register_middlewares(expressApp, authInstance, storageInstance) {
|
||||||
...more stuff
|
/* more stuff */
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -91,7 +93,7 @@ To register a middleware we need an object with a single method called `register
|
||||||
|
|
||||||
## Storage Plugin
|
## 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
|
### API
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,7 @@ $> npm install --global verdaccio-activedirectory
|
||||||
|
|
||||||
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
||||||
|
|
||||||
&> npm install --global sinopia-memory
|
$> npm install --global sinopia-memory
|
||||||
|
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
@ -30,8 +30,6 @@ The default configuration looks like this, due we use a build-in `htpasswd` plug
|
||||||
```yaml
|
```yaml
|
||||||
htpasswd:
|
htpasswd:
|
||||||
file: ./htpasswd
|
file: ./htpasswd
|
||||||
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
||||||
# You can set this to -1 to disable registration.
|
|
||||||
#max_users: 1000
|
#max_users: 1000
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -53,8 +51,6 @@ This is tecnically possible, the plugins order becames important, the the creden
|
||||||
auth:
|
auth:
|
||||||
htpasswd:
|
htpasswd:
|
||||||
file: ./htpasswd
|
file: ./htpasswd
|
||||||
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
||||||
# You can set this to -1 to disable registration.
|
|
||||||
#max_users: 1000
|
#max_users: 1000
|
||||||
activedirectory:
|
activedirectory:
|
||||||
url: "ldap://10.0.100.1"
|
url: "ldap://10.0.100.1"
|
||||||
|
@ -84,7 +80,7 @@ store:
|
||||||
|
|
||||||
> If you define a custom store, the property **storage** in the configuration file will be ignored.
|
> If you define a custom store, the property **storage** in the configuration file will be ignored.
|
||||||
|
|
||||||
## Legacy plugins compatible with **Verdaccio**.
|
## Legacy plugins
|
||||||
|
|
||||||
### Sinopia Plugins
|
### Sinopia Plugins
|
||||||
|
|
||||||
|
|
|
@ -77,13 +77,15 @@ Where `htpasswd` is the sufix of the plugin name. eg: `verdaccio-htpasswd` and t
|
||||||
|
|
||||||
## Middleware Plugin
|
## 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
|
### API
|
||||||
|
|
||||||
```js
|
```js
|
||||||
function register_middlewares(expressApp, auth, storage) {
|
function register_middlewares(expressApp, authInstance, storageInstance) {
|
||||||
...more stuff
|
/* more stuff */
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -91,7 +93,7 @@ To register a middleware we need an object with a single method called `register
|
||||||
|
|
||||||
## Storage Plugin
|
## 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
|
### API
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,7 @@ $> npm install --global verdaccio-activedirectory
|
||||||
|
|
||||||
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
||||||
|
|
||||||
&> npm install --global sinopia-memory
|
$> npm install --global sinopia-memory
|
||||||
|
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
@ -30,8 +30,6 @@ The default configuration looks like this, due we use a build-in `htpasswd` plug
|
||||||
```yaml
|
```yaml
|
||||||
htpasswd:
|
htpasswd:
|
||||||
file: ./htpasswd
|
file: ./htpasswd
|
||||||
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
||||||
# You can set this to -1 to disable registration.
|
|
||||||
#max_users: 1000
|
#max_users: 1000
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -53,8 +51,6 @@ This is tecnically possible, the plugins order becames important, the the creden
|
||||||
auth:
|
auth:
|
||||||
htpasswd:
|
htpasswd:
|
||||||
file: ./htpasswd
|
file: ./htpasswd
|
||||||
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
||||||
# You can set this to -1 to disable registration.
|
|
||||||
#max_users: 1000
|
#max_users: 1000
|
||||||
activedirectory:
|
activedirectory:
|
||||||
url: "ldap://10.0.100.1"
|
url: "ldap://10.0.100.1"
|
||||||
|
@ -84,7 +80,7 @@ store:
|
||||||
|
|
||||||
> If you define a custom store, the property **storage** in the configuration file will be ignored.
|
> If you define a custom store, the property **storage** in the configuration file will be ignored.
|
||||||
|
|
||||||
## Legacy plugins compatible with **Verdaccio**.
|
## Legacy plugins
|
||||||
|
|
||||||
### Sinopia Plugins
|
### Sinopia Plugins
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue