From 507a3c7a7d9289cf234f233c0aca463624564d09 Mon Sep 17 00:00:00 2001 From: Peter Cools Date: Mon, 30 Jul 2018 21:11:36 +0200 Subject: [PATCH] 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 --- docs/config.md | 1 + docs/web.md | 2 ++ website/translated_docs/ar/web.md | 4 +--- website/translated_docs/de/web.md | 4 +--- website/translated_docs/es-ES/web.md | 4 +--- website/translated_docs/fr/web.md | 4 +--- website/translated_docs/ja/web.md | 4 +--- website/translated_docs/pt-BR/web.md | 4 +--- website/translated_docs/ur-IN/web.md | 4 +--- website/translated_docs/ur-PK/web.md | 4 +--- website/translated_docs/zh-HK/web.md | 4 +--- website/translated_docs/zh-Hans/web.md | 4 +--- website/translated_docs/zh-Hant/web.md | 4 +--- website/versioned_docs/version-3.3.0/web.md | 2 -- 14 files changed, 14 insertions(+), 35 deletions(-) diff --git a/docs/config.md b/docs/config.md index b12f32fad..666e24559 100644 --- a/docs/config.md +++ b/docs/config.md @@ -70,6 +70,7 @@ web: enable: true title: Verdaccio logo: logo.png + scope: ``` ### Uplinks diff --git a/docs/web.md b/docs/web.md index 9334547e4..f26f0354b 100644 --- a/docs/web.md +++ b/docs/web.md @@ -12,6 +12,7 @@ web: enable: true title: Verdaccio logo: logo.png + scope: ``` 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 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 +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 \\@) diff --git a/website/translated_docs/ar/web.md b/website/translated_docs/ar/web.md index ed49a0f0f..a9aa6a9ec 100644 --- a/website/translated_docs/ar/web.md +++ b/website/translated_docs/ar/web.md @@ -13,7 +13,6 @@ web: enable: true title: Verdaccio logo: logo.png - scope: ``` ### Configuration @@ -22,5 +21,4 @@ web: | -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- | | enable | boolean | No | true/false | all | allow to display the web interface | | 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 | -| 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 \\@) | +| logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located | \ No newline at end of file diff --git a/website/translated_docs/de/web.md b/website/translated_docs/de/web.md index ed49a0f0f..a9aa6a9ec 100644 --- a/website/translated_docs/de/web.md +++ b/website/translated_docs/de/web.md @@ -13,7 +13,6 @@ web: enable: true title: Verdaccio logo: logo.png - scope: ``` ### Configuration @@ -22,5 +21,4 @@ web: | -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- | | enable | boolean | No | true/false | all | allow to display the web interface | | 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 | -| 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 \\@) | +| logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located | \ No newline at end of file diff --git a/website/translated_docs/es-ES/web.md b/website/translated_docs/es-ES/web.md index ebe53e8ac..f3478e224 100644 --- a/website/translated_docs/es-ES/web.md +++ b/website/translated_docs/es-ES/web.md @@ -13,7 +13,6 @@ web: enable: true title: Verdaccio logo: logo.png - scope: ``` 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 | | 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 | -| 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 \\@) | +| logo | string | No | http://my.logo.domain/logo.png | all | el URI donde el logo esta localizado | \ No newline at end of file diff --git a/website/translated_docs/fr/web.md b/website/translated_docs/fr/web.md index ed49a0f0f..a9aa6a9ec 100644 --- a/website/translated_docs/fr/web.md +++ b/website/translated_docs/fr/web.md @@ -13,7 +13,6 @@ web: enable: true title: Verdaccio logo: logo.png - scope: ``` ### Configuration @@ -22,5 +21,4 @@ web: | -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- | | enable | boolean | No | true/false | all | allow to display the web interface | | 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 | -| 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 \\@) | +| logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located | \ No newline at end of file diff --git a/website/translated_docs/ja/web.md b/website/translated_docs/ja/web.md index ed49a0f0f..a9aa6a9ec 100644 --- a/website/translated_docs/ja/web.md +++ b/website/translated_docs/ja/web.md @@ -13,7 +13,6 @@ web: enable: true title: Verdaccio logo: logo.png - scope: ``` ### Configuration @@ -22,5 +21,4 @@ web: | -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- | | enable | boolean | No | true/false | all | allow to display the web interface | | 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 | -| 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 \\@) | +| logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located | \ No newline at end of file diff --git a/website/translated_docs/pt-BR/web.md b/website/translated_docs/pt-BR/web.md index a3c2bb5af..445cb67b9 100644 --- a/website/translated_docs/pt-BR/web.md +++ b/website/translated_docs/pt-BR/web.md @@ -13,7 +13,6 @@ web: enable: true title: Verdaccio logo: logo.png - scope: ``` 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 | | 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 | -| 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 \\@) | +| logo | string | Não | http://my.logo.domain/logo.png | all | URI onde o logo se encontra | \ No newline at end of file diff --git a/website/translated_docs/ur-IN/web.md b/website/translated_docs/ur-IN/web.md index ed49a0f0f..a9aa6a9ec 100644 --- a/website/translated_docs/ur-IN/web.md +++ b/website/translated_docs/ur-IN/web.md @@ -13,7 +13,6 @@ web: enable: true title: Verdaccio logo: logo.png - scope: ``` ### Configuration @@ -22,5 +21,4 @@ web: | -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- | | enable | boolean | No | true/false | all | allow to display the web interface | | 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 | -| 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 \\@) | +| logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located | \ No newline at end of file diff --git a/website/translated_docs/ur-PK/web.md b/website/translated_docs/ur-PK/web.md index ed49a0f0f..a9aa6a9ec 100644 --- a/website/translated_docs/ur-PK/web.md +++ b/website/translated_docs/ur-PK/web.md @@ -13,7 +13,6 @@ web: enable: true title: Verdaccio logo: logo.png - scope: ``` ### Configuration @@ -22,5 +21,4 @@ web: | -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- | | enable | boolean | No | true/false | all | allow to display the web interface | | 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 | -| 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 \\@) | +| logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located | \ No newline at end of file diff --git a/website/translated_docs/zh-HK/web.md b/website/translated_docs/zh-HK/web.md index ed49a0f0f..a9aa6a9ec 100644 --- a/website/translated_docs/zh-HK/web.md +++ b/website/translated_docs/zh-HK/web.md @@ -13,7 +13,6 @@ web: enable: true title: Verdaccio logo: logo.png - scope: ``` ### Configuration @@ -22,5 +21,4 @@ web: | -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- | | enable | boolean | No | true/false | all | allow to display the web interface | | 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 | -| 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 \\@) | +| logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located | \ No newline at end of file diff --git a/website/translated_docs/zh-Hans/web.md b/website/translated_docs/zh-Hans/web.md index 2c705760f..50ff010d1 100644 --- a/website/translated_docs/zh-Hans/web.md +++ b/website/translated_docs/zh-Hans/web.md @@ -13,7 +13,6 @@ web: enable: true title: Verdaccio logo: logo.png - scope: ``` 所有访问限制定义为[保护包](protect-your-dependencies.md)，它也将应用于网页界面。 @@ -24,5 +23,4 @@ web: | ------ | ------- | -- | ------------------------------ | --- | ----------- | | enable | boolean | No | true/false | all | 允许显示网页界面 | | title | string | No | Verdaccio | all | HTML 页眉标题说明 | -| 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 \\@) | +| logo | string | No | http://my.logo.domain/logo.png | all | logo 位于的URI | \ No newline at end of file diff --git a/website/translated_docs/zh-Hant/web.md b/website/translated_docs/zh-Hant/web.md index ed49a0f0f..a9aa6a9ec 100644 --- a/website/translated_docs/zh-Hant/web.md +++ b/website/translated_docs/zh-Hant/web.md @@ -13,7 +13,6 @@ web: enable: true title: Verdaccio logo: logo.png - scope: ``` ### Configuration @@ -22,5 +21,4 @@ web: | -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- | | enable | boolean | No | true/false | all | allow to display the web interface | | 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 | -| 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 \\@) | +| logo | string | No | http://my.logo.domain/logo.png | all | a URI where logo is located | \ No newline at end of file diff --git a/website/versioned_docs/version-3.3.0/web.md b/website/versioned_docs/version-3.3.0/web.md index 1ddda0097..6de482fca 100644 --- a/website/versioned_docs/version-3.3.0/web.md +++ b/website/versioned_docs/version-3.3.0/web.md @@ -13,7 +13,6 @@ web: enable: true title: Verdaccio logo: logo.png - scope: ``` 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 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 -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 \\@)