0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-12-16 21:56:25 -05:00

feat: adds option to set scope in webui instructions header

If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header e.g. npm set @coolsp:registry http://localhost:4873.
Added as webui.scope option in .yaml.
> Note: in .yaml, escape @ with \\@.

See also feature request #593.

Removed changes to website/translated_docs and website/versioned_docs
And update docs/web.md and config.md
This commit is contained in:
Peter Cools 2018-07-30 21:11:36 +02:00
parent 8b98302985
commit 507a3c7a7d
14 changed files with 14 additions and 35 deletions

View file

@ -70,6 +70,7 @@ web:
enable: true enable: true
title: Verdaccio title: Verdaccio
logo: logo.png logo: logo.png
scope:
``` ```
### Uplinks ### Uplinks

View file

@ -12,6 +12,7 @@ web:
enable: true enable: true
title: Verdaccio title: Verdaccio
logo: logo.png logo: logo.png
scope:
``` ```
All access restrictions defined to [protect your packages](protect-your-dependencies.md) will also apply to the Web Interface. All access restrictions defined to [protect your packages](protect-your-dependencies.md) will also apply to the Web Interface.
@ -23,3 +24,4 @@ Property | Type | Required | Example | Support | Description
enable | boolean | No | true/false | all | allow to display the web interface enable | boolean | No | true/false | all | allow to display the web interface
title | string | No | Verdaccio | all | HTML head title description title | string | No | Verdaccio | all | HTML head title description
logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located
scope | string | No | \\@myscopy | all | If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header (note: escape @ with \\@)

View file

@ -13,7 +13,6 @@ web:
enable: true enable: true
title: Verdaccio title: Verdaccio
logo: logo.png logo: logo.png
scope:
``` ```
### Configuration ### Configuration
@ -22,5 +21,4 @@ web:
| -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- | | -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- |
| enable | boolean | No | true/false | all | allow to display the web interface | | enable | boolean | No | true/false | all | allow to display the web interface |
| title | string | No | $authenticated | all | HTML head title description | | title | string | No | $authenticated | all | HTML head title description |
| logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located | | logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located |
| scope | string | No | \\@myscopy | all | If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header (note: escape @ with \\@) |

View file

@ -13,7 +13,6 @@ web:
enable: true enable: true
title: Verdaccio title: Verdaccio
logo: logo.png logo: logo.png
scope:
``` ```
### Configuration ### Configuration
@ -22,5 +21,4 @@ web:
| -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- | | -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- |
| enable | boolean | No | true/false | all | allow to display the web interface | | enable | boolean | No | true/false | all | allow to display the web interface |
| title | string | No | $authenticated | all | HTML head title description | | title | string | No | $authenticated | all | HTML head title description |
| logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located | | logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located |
| scope | string | No | \\@myscopy | all | If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header (note: escape @ with \\@) |

View file

@ -13,7 +13,6 @@ web:
enable: true enable: true
title: Verdaccio title: Verdaccio
logo: logo.png logo: logo.png
scope:
``` ```
All access restrictions defined to [protect your packages](protect-your-dependencies.md) will also apply to the Web Interface. All access restrictions defined to [protect your packages](protect-your-dependencies.md) will also apply to the Web Interface.
@ -24,5 +23,4 @@ All access restrictions defined to [protect your packages](protect-your-dependen
| --------- | ------- | --------- | ------------------------------ | ------- | ------------------------------------ | | --------- | ------- | --------- | ------------------------------ | ------- | ------------------------------------ |
| enable | boolean | No | true/false | all | habilita la interfaz web | | enable | boolean | No | true/false | all | habilita la interfaz web |
| title | string | No | Verdaccio | all | El título de la interfaz web | | title | string | No | Verdaccio | all | El título de la interfaz web |
| logo | string | No | http://my.logo.domain/logo.png | all | el URI donde el logo esta localizado | | logo | string | No | http://my.logo.domain/logo.png | all | el URI donde el logo esta localizado |
| scope | string | No | \\@myscopy | all | If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header (note: escape @ with \\@) |

View file

@ -13,7 +13,6 @@ web:
enable: true enable: true
title: Verdaccio title: Verdaccio
logo: logo.png logo: logo.png
scope:
``` ```
### Configuration ### Configuration
@ -22,5 +21,4 @@ web:
| -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- | | -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- |
| enable | boolean | No | true/false | all | allow to display the web interface | | enable | boolean | No | true/false | all | allow to display the web interface |
| title | string | No | $authenticated | all | HTML head title description | | title | string | No | $authenticated | all | HTML head title description |
| logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located | | logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located |
| scope | string | No | \\@myscopy | all | If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header (note: escape @ with \\@) |

View file

@ -13,7 +13,6 @@ web:
enable: true enable: true
title: Verdaccio title: Verdaccio
logo: logo.png logo: logo.png
scope:
``` ```
### Configuration ### Configuration
@ -22,5 +21,4 @@ web:
| -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- | | -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- |
| enable | boolean | No | true/false | all | allow to display the web interface | | enable | boolean | No | true/false | all | allow to display the web interface |
| title | string | No | $authenticated | all | HTML head title description | | title | string | No | $authenticated | all | HTML head title description |
| logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located | | logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located |
| scope | string | No | \\@myscopy | all | If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header (note: escape @ with \\@) |

View file

@ -13,7 +13,6 @@ web:
enable: true enable: true
title: Verdaccio title: Verdaccio
logo: logo.png logo: logo.png
scope:
``` ```
All access restrictions defined to [protect your packages](protect-your-dependencies.md) will also apply to the Web Interface. All access restrictions defined to [protect your packages](protect-your-dependencies.md) will also apply to the Web Interface.
@ -24,5 +23,4 @@ All access restrictions defined to [protect your packages](protect-your-dependen
| ------ | ------- | ----------- | ------------------------------ | ------- | --------------------------- | | ------ | ------- | ----------- | ------------------------------ | ------- | --------------------------- |
| enable | boolean | Não | true/false | all | habilitar a interface web | | enable | boolean | Não | true/false | all | habilitar a interface web |
| title | string | Não | Verdaccio | all | Título da página web | | title | string | Não | Verdaccio | all | Título da página web |
| logo | string | Não | http://my.logo.domain/logo.png | all | URI onde o logo se encontra | | logo | string | Não | http://my.logo.domain/logo.png | all | URI onde o logo se encontra |
| scope | string | Não | \\@myscopy | all | If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header (note: escape @ with \\@) |

View file

@ -13,7 +13,6 @@ web:
enable: true enable: true
title: Verdaccio title: Verdaccio
logo: logo.png logo: logo.png
scope:
``` ```
### Configuration ### Configuration
@ -22,5 +21,4 @@ web:
| -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- | | -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- |
| enable | boolean | No | true/false | all | allow to display the web interface | | enable | boolean | No | true/false | all | allow to display the web interface |
| title | string | No | $authenticated | all | HTML head title description | | title | string | No | $authenticated | all | HTML head title description |
| logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located | | logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located |
| scope | string | No | \\@myscopy | all | If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header (note: escape @ with \\@) |

View file

@ -13,7 +13,6 @@ web:
enable: true enable: true
title: Verdaccio title: Verdaccio
logo: logo.png logo: logo.png
scope:
``` ```
### Configuration ### Configuration
@ -22,5 +21,4 @@ web:
| -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- | | -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- |
| enable | boolean | No | true/false | all | allow to display the web interface | | enable | boolean | No | true/false | all | allow to display the web interface |
| title | string | No | $authenticated | all | HTML head title description | | title | string | No | $authenticated | all | HTML head title description |
| logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located | | logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located |
| scope | string | No | \\@myscopy | all | If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header (note: escape @ with \\@) |

View file

@ -13,7 +13,6 @@ web:
enable: true enable: true
title: Verdaccio title: Verdaccio
logo: logo.png logo: logo.png
scope:
``` ```
### Configuration ### Configuration
@ -22,5 +21,4 @@ web:
| -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- | | -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- |
| enable | boolean | No | true/false | all | allow to display the web interface | | enable | boolean | No | true/false | all | allow to display the web interface |
| title | string | No | $authenticated | all | HTML head title description | | title | string | No | $authenticated | all | HTML head title description |
| logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located | | logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located |
| scope | string | No | \\@myscopy | all | If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header (note: escape @ with \\@) |

View file

@ -13,7 +13,6 @@ web:
enable: true enable: true
title: Verdaccio title: Verdaccio
logo: logo.png logo: logo.png
scope:
``` ```
所有访问限制定义为[保护包](protect-your-dependencies.md),它也将应用于网页界面。 所有访问限制定义为[保护包](protect-your-dependencies.md),它也将应用于网页界面。
@ -24,5 +23,4 @@ web:
| ------ | ------- | -- | ------------------------------ | --- | ----------- | | ------ | ------- | -- | ------------------------------ | --- | ----------- |
| enable | boolean | No | true/false | all | 允许显示网页界面 | | enable | boolean | No | true/false | all | 允许显示网页界面 |
| title | string | No | Verdaccio | all | HTML 页眉标题说明 | | title | string | No | Verdaccio | all | HTML 页眉标题说明 |
| logo | string | No | http://my.logo.domain/logo.png | all | logo 位于的URI | | logo | string | No | http://my.logo.domain/logo.png | all | logo 位于的URI |
| scope | string | No | \\@myscopy | all | If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header (note: escape @ with \\@) |

View file

@ -13,7 +13,6 @@ web:
enable: true enable: true
title: Verdaccio title: Verdaccio
logo: logo.png logo: logo.png
scope:
``` ```
### Configuration ### Configuration
@ -22,5 +21,4 @@ web:
| -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- | | -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- |
| enable | boolean | No | true/false | all | allow to display the web interface | | enable | boolean | No | true/false | all | allow to display the web interface |
| title | string | No | $authenticated | all | HTML head title description | | title | string | No | $authenticated | all | HTML head title description |
| logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located | | logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located |
| scope | string | No | \\@myscopy | all | If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header (note: escape @ with \\@) |

View file

@ -13,7 +13,6 @@ web:
enable: true enable: true
title: Verdaccio title: Verdaccio
logo: logo.png logo: logo.png
scope:
``` ```
All access restrictions defined to [protect your packages](protect-your-dependencies.md) will also apply to the Web Interface. All access restrictions defined to [protect your packages](protect-your-dependencies.md) will also apply to the Web Interface.
@ -25,4 +24,3 @@ Property | Type | Required | Example | Support | Description
enable | boolean | No | true/false | all | allow to display the web interface enable | boolean | No | true/false | all | allow to display the web interface
title | string | No | Verdaccio | all | HTML head title description title | string | No | Verdaccio | all | HTML head title description
logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located
scope | string | No | \\@myscopy | all | If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header (note: escape @ with \\@)