mirror of
https://github.com/verdaccio/verdaccio.git
synced 2025-04-01 02:42:23 -05:00
New Crowdin translations (#806)
* New translations web.md (Portuguese, Brazilian) docs(website): new translations * New translations web.md (Spanish) docs(website): new translations * New translations web.md (Chinese Simplified) docs(website): new translations * New translations docker.md (Chinese Simplified) docs(website): new translations * New translations plugins.md (Spanish) docs(website): new translations * New translations plugins.md (Portuguese, Brazilian) docs(website): new translations * New translations plugins.md (Chinese Simplified) docs(website): new translations * New translations iis-server.md (Chinese Simplified) docs(website): new translations * New translations iis-server.md (Chinese Simplified) docs(website): new translations * New translations iis-server.md (Chinese Simplified) docs(website): new translations * New translations iis-server.md (Chinese Simplified) docs(website): new translations * New translations iis-server.md (Chinese Simplified) docs(website): new translations * New translations iis-server.md (Chinese Simplified) docs(website): new translations * New translations iis-server.md (Chinese Simplified) docs(website): new translations * New translations install.md (Chinese Simplified) docs(website): new translations * New translations install.md (Chinese Simplified) docs(website): new translations * New translations install.md (Chinese Simplified) docs(website): new translations * New translations kubernetes.md (Chinese Simplified) docs(website): new translations * New translations kubernetes.md (Chinese Simplified) docs(website): new translations * New translations kubernetes.md (Chinese Simplified) docs(website): new translations * New translations kubernetes.md (Chinese Simplified) docs(website): new translations * New translations logger.md (Chinese Simplified) docs(website): new translations * New translations logger.md (Chinese Simplified) docs(website): new translations * New translations node-api.md (Chinese Simplified) docs(website): new translations * New translations notifications.md (Chinese Simplified) docs(website): new translations * New translations node-api.md (Chinese Simplified) docs(website): new translations * New translations notifications.md (Chinese Simplified) docs(website): new translations * New translations notifications.md (Chinese Simplified) docs(website): new translations * New translations notifications.md (Chinese Simplified) docs(website): new translations * New translations notifications.md (Chinese Simplified) docs(website): new translations * New translations node-api.md (Chinese Simplified) docs(website): new translations * New translations iis-server.md (Chinese Simplified) docs(website): new translations * New translations iis-server.md (Chinese Simplified) docs(website): new translations * New translations install.md (Chinese Simplified) docs(website): new translations * New translations kubernetes.md (Chinese Simplified) docs(website): new translations * New translations kubernetes.md (Chinese Simplified) docs(website): new translations * New translations kubernetes.md (Chinese Simplified) docs(website): new translations * New translations logger.md (Chinese Simplified) docs(website): new translations * New translations notifications.md (Chinese Simplified) docs(website): new translations
This commit is contained in:
verdacciobot
Juan Picado @jotadeveloper
parent
45b21fa87d
commit
f90522e303
13 changed files with 112 additions and 110 deletions
|
|
@ -117,6 +117,7 @@ store:
|
|||
* [verdaccio-active-directory](https://github.com/nowhammies/verdaccio-activedirectory): plugin de autenticación Active Directory para verdaccio
|
||||
* [verdaccio-gitlab](https://github.com/bufferoverflow/verdaccio-gitlab): use la Token de Acceso Personal de GitLab para autenticarse
|
||||
* [verdaccio-htpasswd](https://github.com/verdaccio/verdaccio-htpasswd): Auth basado en el plugin del archivo htpasswd (incorporado) para verdaccio
|
||||
* [verdaccio-github-oauth](https://github.com/aroundus-inc/verdaccio-github-oauth): Github oauth authentication plugin for verdaccio.
|
||||
|
||||
### Plugins de Middleware
|
||||
|
||||
|
|
|
|||
|
|
@ -15,10 +15,12 @@ web:
|
|||
logo: logo.png
|
||||
```
|
||||
|
||||
All access restrictions defined to [protect your packages](protect-your-dependencies.md) will also apply to the Web Interface.
|
||||
|
||||
### Configuración
|
||||
|
||||
| Propiedad | Tipo | Requerido | Ejemplo | Soporte | Descripcion |
|
||||
| --------- | ------- | --------- | ------------------------------ | ------- | ------------------------------------ |
|
||||
| enable | boolean | No | true/false | all | habilita la interfaz web |
|
||||
| title | string | No | $authenticated | 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 |
|
||||
|
|
@ -117,6 +117,7 @@ store:
|
|||
* [verdaccio-active-directory](https://github.com/nowhammies/verdaccio-activedirectory): Active Directory authentication plugin for verdaccio
|
||||
* [verdaccio-gitlab](https://github.com/bufferoverflow/verdaccio-gitlab): use GitLab Personal Access Token to authenticate
|
||||
* [verdaccio-htpasswd](https://github.com/verdaccio/verdaccio-htpasswd): Auth based on htpasswd file plugin (built-in) for verdaccio
|
||||
* [verdaccio-github-oauth](https://github.com/aroundus-inc/verdaccio-github-oauth): Github oauth authentication plugin for verdaccio.
|
||||
|
||||
### Middleware Plugins
|
||||
|
||||
|
|
|
|||
|
|
@ -15,10 +15,12 @@ web:
|
|||
logo: logo.png
|
||||
```
|
||||
|
||||
All access restrictions defined to [protect your packages](protect-your-dependencies.md) will also apply to the Web Interface.
|
||||
|
||||
### Configuração
|
||||
|
||||
| Nome | Tipo | Obrigatório | Exemplo | Suporte | Descrição |
|
||||
| ------ | ------- | ----------- | ------------------------------ | ------- | --------------------------- |
|
||||
| enable | boolean | Não | true/false | all | habilitar a interface web |
|
||||
| title | string | Não | $authenticated | 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 |
|
||||
|
|
@ -65,7 +65,7 @@ V_PATH=/path/for/verdaccio; docker run -it --rm --name verdaccio -p 4873:4873 \
|
|||
verdaccio/verdaccio
|
||||
```
|
||||
|
||||
> 请注意：Verdaccio 在容器内是作为non-root 用户端 (uid=100, gid=101) 运行, 如果您使用绑定安装来覆盖默认设置, 您需要确保安装目录是被指定到正确的用户端。 在上面的示例里，您要运行 `sudo chown -R 100:101 /opt/verdaccio`，否则在运行的时候您会得到权限错误提醒。 推荐[使用docker卷](https://docs.docker.com/storage/volumes/)来替代绑定安装。
|
||||
> 请注意：Verdaccio 在容器内是作为non-root 用户端 (uid=100, gid=101) 运行, 如果您使用绑定安装来覆盖默认设置, 您需要确保安装目录是被指定到正确的用户端。 在上面的示例里，您要运行 `sudo chown -R 100:101 /opt/verdaccio`，否则在运行的时候您会得到权限错误提醒。 推荐[使用docker卷（volume)](https://docs.docker.com/storage/volumes/)来替代绑定安装。
|
||||
|
||||
### Docker和自定义端口配置
|
||||
|
||||
|
|
@ -125,7 +125,7 @@ Docker将生成一个用于存储持续应用程序数据的命名卷(named volu
|
|||
docker build -t verdaccio .
|
||||
```
|
||||
|
||||
还有一个创建 docker图片的npm 脚本，因此您还可以执行以下操作：
|
||||
还有一个创建 docker镜像的npm 脚本，因此您还可以执行以下操作：
|
||||
|
||||
```bash
|
||||
npm run build:docker
|
||||
|
|
|
|||
|
|
@ -14,18 +14,18 @@ title: "IIS server上进行安装"
|
|||
npm install
|
||||
|
||||
|
||||
- Make sure you have an inbound rule accepting TCP traffic to the port in Windows Firewall
|
||||
- Thats it! Now you can navigate to the host and port that you specified
|
||||
- 请确保您有入站规则来接受TCP流量到Windows防火墙的端口
|
||||
- 就这样！现在您可以导航到您指定的主机和端口
|
||||
|
||||
I wanted the `verdaccio` site to be the default site in IIS so I did the following:
|
||||
我希望 `verdaccio`站点成为IIS中默认的站点，因此我执行了以下操作：
|
||||
|
||||
- I made sure the .npmrc file in `c:\users{yourname}` had the registry set to `"registry=http://localhost/"`
|
||||
- I stopped the "Default Web Site" and only start the site "verdaccio" site in IIS
|
||||
- I set the bindings to "http", ip address "All Unassigned" on port 80, ok any warning or prompts
|
||||
- 我确定`c:\users{yourname}`里的.npmrc文件的registry已设置为 `"registry=http://localhost/"`
|
||||
- 我中止“默认网站”，并且只在IIS 里启动"verdaccio"站点
|
||||
- 我将端口80绑定设置为"http", ip 地址为"全部未定义"，ok 任何警告或提示。
|
||||
|
||||
These instructions are based on [Host Sinopia in IIS on Windows](https://gist.github.com/HCanber/4dd8409f79991a09ac75). I had to tweak my web config as per below but you may find the original from the for mentioned link works better
|
||||
这些指南是基于[Host Sinopia in IIS on Windows](https://gist.github.com/HCanber/4dd8409f79991a09ac75)。 我不得不依照以下调整我的网页配置，但是您可能发现上述提到链接里的原始配置可以更好作业
|
||||
|
||||
A default configuration file will be created `c:\verdaccio\verdaccio\config.yaml`
|
||||
将创建默认配置文件`c:\verdaccio\verdaccio\config.yaml`
|
||||
|
||||
### package.json
|
||||
|
||||
|
|
@ -68,14 +68,7 @@ require('./node_modules/verdaccio/src/lib/cli.js');
|
|||
<rewrite>
|
||||
<rules>
|
||||
|
||||
<!-- iisnode folder is where iisnode stores it's logs. These should
|
||||
never be rewritten -->
|
||||
<rule name="iisnode" stopProcessing="true">
|
||||
<match url="iisnode*" />
|
||||
<action type="None" />
|
||||
</rule>
|
||||
|
||||
<!-- Rewrite all other urls in order for verdaccio to handle these -->
|
||||
<!-- iisnode folder is where iisnode stores it's logs. <!-- Rewrite all other urls in order for verdaccio to handle these -->
|
||||
<rule name="verdaccio">
|
||||
<match url="/*" />
|
||||
<action type="Rewrite" url="start.js" />
|
||||
|
|
@ -97,7 +90,7 @@ require('./node_modules/verdaccio/src/lib/cli.js');
|
|||
</configuration>
|
||||
```
|
||||
|
||||
### Troubleshooting
|
||||
### 故障排除
|
||||
|
||||
- **The web interface does not load when hosted with https as it tries to download scripts over http.**
|
||||
Make sure that you have correctly mentioned `url_prefix` in verdaccio config. Follow the [discussion](https://github.com/verdaccio/verdaccio/issues/622).
|
||||
- **以https 为主机的网页界面无法加载，因为它总是尝试从 http下载脚本。**
|
||||
请确保您在verdaccio配置里正确提到`url_prefix`。请跟随 [讨论](https://github.com/verdaccio/verdaccio/issues/622)。
|
||||
|
|
@ -1,20 +1,20 @@
|
|||
---
|
||||
id: installation
|
||||
title: "Installation"
|
||||
title: "安装"
|
||||
---
|
||||
Verdaccio is a multiplatform web application. To install it, you need a few prerequisites.
|
||||
Verdaccio 是一个多平台网页应用程序。在安装之前，您需要具有一些先决条件。
|
||||
|
||||
#### 最低要求:
|
||||
|
||||
1. Node.js 版本
|
||||
- For version `verdaccio@2.x` Node `v4.6.1` is the minimum supported version.
|
||||
- For version `verdaccio@latest` Node `6.12.0` is the minimum supported version.
|
||||
- 对于`verdaccio@2.x`版本，Node `v4.6.1`是最低支持版本。
|
||||
- 对于`verdaccio@latest`版本，Node `6.12.0` 是最低支持版本。
|
||||
2. npm `>=3.x` or `yarn`
|
||||
3. The web interface supports the `Chrome, Firefox, Edge, and IE9` browsers.
|
||||
3. 网页界面支持`Chrome, Firefox, Edge, 和 IE9` 浏览器。
|
||||
|
||||
## 安装
|
||||
## 安装CLI
|
||||
|
||||
`verdaccio` must be installed globaly using either of the following methods:
|
||||
`verdaccio` 总体上必须用以下两种方法之一来安装：
|
||||
|
||||
使用 `npm`
|
||||
|
||||
|
|
@ -28,11 +28,11 @@ npm install -g verdaccio
|
|||
yarn global add verdaccio
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
## 基本使用
|
||||
|
||||
Once it has been installed, you only need to execute the CLI command:
|
||||
一旦安装后，您只需要执行CLI 命令：
|
||||
|
||||
```bash
|
||||
$> verdaccio
|
||||
|
|
@ -42,8 +42,8 @@ warn --- http address - http://localhost:4873/ - verdaccio/3.0.1
|
|||
|
||||
|
||||
|
||||
For more information about the CLI, please [read the cli section](cli.md).
|
||||
更多关于CLI的信息, 请[阅读cli章节](cli.md)。
|
||||
|
||||
## Docker 镜像
|
||||
|
||||
`verdaccio` has an official docker image you can use, and in most cases, the default configuration is good enough. For more information about how to install the official image, [read the docker section](docker.md).
|
||||
`verdaccio`有官方docker镜像可以使用，在大多数情况下，默认的配置已经够好。 更多关于如何安装官方镜像的信息，请[阅读docker章节](docker.md)。
|
||||
|
|
@ -2,85 +2,85 @@
|
|||
id: kubernetes
|
||||
title: "Kubernetes"
|
||||
---
|
||||
You can find instructions to deploy Verdaccio on a Kubernetes cluster on the [verdaccio/docker-example](https://github.com/verdaccio/docker-examples/tree/master/kubernetes-example) repository. However, the recommended method to install Verdaccio on a Kubernetes cluster is to use [Helm](https://helm.sh). Helm is a [Kubernetes](https://kubernetes.io) package manager which bring multiple advantages.
|
||||
您可以在[verdaccio/docker-例子](https://github.com/verdaccio/docker-examples/tree/master/kubernetes-example)资源库找到在Kubernetes群集中配置Verdaccio的指南。 然而，建议在Kubernetes集群上安装Verdaccio的方法是使用[Helm](https://helm.sh)。 Helm 是 [Kubernetes](https://kubernetes.io) 包管理者，它带来很多优点。
|
||||
|
||||
## Helm
|
||||
|
||||
### Setup Helm
|
||||
### 设置Helm
|
||||
|
||||
If you haven't used Helm before, you need to setup the Helm controller called Tiller:
|
||||
如果您以前没有使用过Helm，您需要设置叫做Tiller的Helm控制器:
|
||||
|
||||
```bash
|
||||
helm init
|
||||
```
|
||||
|
||||
### Install
|
||||
### 安装
|
||||
|
||||
Deploy the Helm [stable/verdaccio](https://github.com/kubernetes/charts/tree/master/stable/verdaccio) chart. In this example we use `npm` as release name:
|
||||
配置Helm [stable/verdaccio](https://github.com/kubernetes/charts/tree/master/stable/verdaccio) chart。在这个例子里，我们用 `npm` 作为发行名称:
|
||||
|
||||
```bash
|
||||
helm install --name npm stable/verdaccio
|
||||
```
|
||||
|
||||
### Deploy a specific version
|
||||
### 配置特定版本
|
||||
|
||||
```bash
|
||||
helm install --name npm --set image.tag=2.6.5 stable/verdaccio
|
||||
```
|
||||
|
||||
### Upgrading Verdaccio
|
||||
### 升级Verdaccio
|
||||
|
||||
```bash
|
||||
helm upgrade npm stable/verdaccio
|
||||
```
|
||||
|
||||
### Uninstalling
|
||||
### 卸载
|
||||
|
||||
```bash
|
||||
helm del --purge npm
|
||||
```
|
||||
|
||||
**Note:** this command delete all the resources, including packages that you may have previously published to the registry.
|
||||
**请注意:** 此命令删除所有源代码，包含您之前可能已经发布到registry里的包。
|
||||
|
||||
### Custom Verdaccio configuration
|
||||
### 自定义Verdaccio 配置
|
||||
|
||||
You can customize the Verdaccio configuration using a Kubernetes *configMap*.
|
||||
您可以用Kubernetes *configMap*自定义 Verdaccio 配置。
|
||||
|
||||
#### Prepare
|
||||
#### 准备
|
||||
|
||||
Copy the [existing configuration](https://github.com/verdaccio/verdaccio/blob/master/conf/full.yaml) and adapt it for your use case:
|
||||
复制 [现有配置](https://github.com/verdaccio/verdaccio/blob/master/conf/full.yaml)并将其调整为您所需要的:
|
||||
|
||||
```bash
|
||||
wget https://raw.githubusercontent.com/verdaccio/verdaccio/master/conf/full.yaml -O config.yaml
|
||||
```
|
||||
|
||||
**Note:** Make sure you are using the right path for the storage that is used for persistency:
|
||||
**请注意:** 请确保您使用的是持续存储的正确路径:
|
||||
|
||||
```yaml
|
||||
storage: /verdaccio/storage/data
|
||||
torage: /verdaccio/storage/data
|
||||
auth:
|
||||
htpasswd:
|
||||
file: /verdaccio/storage/htpasswd
|
||||
```
|
||||
|
||||
#### Deploy the configMap
|
||||
#### 配置configMap
|
||||
|
||||
Deploy the `configMap` to the cluster
|
||||
配置`configMap`到集群
|
||||
|
||||
```bash
|
||||
kubectl create configmap verdaccio-config --from-file ./config.yaml
|
||||
```
|
||||
|
||||
#### Deploy Verdaccio
|
||||
#### 配置Verdaccio
|
||||
|
||||
Now you can deploy the Verdaccio Helm chart and specify which configuration to use:
|
||||
现在您可以配置Verdaccio Helm chart 并指定使用哪个配置:
|
||||
|
||||
```bash
|
||||
helm install --name npm --set customConfigMap=verdaccio-config stable/verdaccio
|
||||
```
|
||||
|
||||
## Rancher Support
|
||||
## Rancher 支持
|
||||
|
||||
[Rancher](http://rancher.com/) is a complete container management platform that makes managing and using containers in production really easy.
|
||||
[Rancher](http://rancher.com/) 是一个完整的容器管理平台，它使得在生产中管理和使用容器非常容易。
|
||||
|
||||
* [verdaccio-rancher](https://github.com/lgaticaq/verdaccio-rancher)
|
||||
|
|
@ -1,24 +1,24 @@
|
|||
---
|
||||
id: logger
|
||||
title: "Logger"
|
||||
id: 记录器
|
||||
title: "记录器"
|
||||
---
|
||||
As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs.
|
||||
和任何网页应用程序一样， verdaccio 有可自定义的内置记录器。您可以定义多种输出类型。
|
||||
|
||||
```yaml
|
||||
logs:
|
||||
# console output
|
||||
# 控制台输出
|
||||
- {type: stdout, format: pretty, level: http}
|
||||
# file output
|
||||
# 文件输出
|
||||
- {type: file, path: verdaccio.log, level: info}
|
||||
```
|
||||
|
||||
Use `SIGUSR2` to notify the application, the log-file was rotated and it needs to reopen it.
|
||||
用`SIGUSR2` 来通知应用程序，此log-file 已循环，需要重新打开它。
|
||||
|
||||
### Configuration
|
||||
### 配置
|
||||
|
||||
| Property | Type | Required | Example | Support | Description |
|
||||
| -------- | ------ | -------- | ---------------------------------------------- | ------- | ------------------------------------------------- |
|
||||
| type | string | No | [stdout, file] | all | define the output |
|
||||
| path | string | No | verdaccio.log | all | if type is file, define the location of that file |
|
||||
| format | string | No | [pretty, pretty-timestamped] | all | output format |
|
||||
| level | string | No | [fatal, error, warn, http, info, debug, trace] | all | verbose level |
|
||||
| 属性 | 类型 | 必填 | 范例 | 支持 | 描述 |
|
||||
| -- | --- | -- | ---------------------------------------------- | ---- | ----------------- |
|
||||
| 类型 | 字符串 | 不 | [stdout, file] | 任意路径 | 定义输出 |
|
||||
| 路径 | 字符串 | 不 | verdaccio.log | 任意路径 | 如果类型为文件，请定义该文件的位置 |
|
||||
| 格式 | 字符串 | 不 | [pretty, pretty-timestamped] | 任意路径 | 输出格式 |
|
||||
| 级别 | 字符串 | 不 | [fatal, error, warn, http, info, debug, trace] | 任意路径 | 详细级别 |
|
||||
|
|
@ -4,12 +4,12 @@ title: "Node API"
|
|||
---
|
||||
Verdaccio can be invoqued programmatically. The node API was introduced after version `verdaccio@3.0.0-alpha.10`.
|
||||
|
||||
## Usage
|
||||
## 使用
|
||||
|
||||
#### Programmatically
|
||||
#### 编程
|
||||
|
||||
```js
|
||||
import startServer from 'verdaccio';
|
||||
mport startServer from 'verdaccio';
|
||||
|
||||
startServer(configJsonFormat, 6000, store, '1.0.0', 'verdaccio',
|
||||
(webServer, addrs, pkgName, pkgVersion) => {
|
||||
|
|
@ -19,9 +19,9 @@ Verdaccio can be invoqued programmatically. The node API was introduced after ve
|
|||
});
|
||||
```
|
||||
|
||||
## Other implementations
|
||||
## 其他执行
|
||||
|
||||
* [verdaccio-server](https://github.com/boringame/verdaccio-server) local npm registry proxy server
|
||||
* [verdaccio-server](https://github.com/boringame/verdaccio-server) 本地 npm registry proxy server（代理服务器）
|
||||
|
||||
```js
|
||||
// js
|
||||
|
|
|
|||
|
|
@ -1,16 +1,16 @@
|
|||
---
|
||||
id: notifications
|
||||
title: "Notifications"
|
||||
id: 通知
|
||||
title: "通知"
|
||||
---
|
||||
Notify was built primarily to use with Slack's Incoming webhooks, but will also deliver a simple payload to any endpoint. Currently only active for `npm publish` command.
|
||||
创建通知主要是与Slack的输入webhooks一起使用，但它也会传递简单的载荷到任何末端。目前只对 `npm publish`命令有效。
|
||||
|
||||
## Usage
|
||||
## 使用
|
||||
|
||||
An example with a **HipChat**, **Stride** and **Google Hangouts Chat** hook:
|
||||
**HipChat**, **Stride** 和 **Google Hangouts Chat** hook的一个范例:
|
||||
|
||||
> Verdaccio supports any API, feel free to ad more examples.
|
||||
> Verdaccio 支持任何 API, 请随意添加更多范例。
|
||||
|
||||
#### Single notification
|
||||
#### 单个通知
|
||||
|
||||
```yaml
|
||||
notify:
|
||||
|
|
@ -20,7 +20,7 @@ notify:
|
|||
content: '{"color":"green","message":"New package published: * {{ name }}*","notify":true,"message_format":"text"}'
|
||||
```
|
||||
|
||||
#### Multiple notification
|
||||
#### 多通知
|
||||
|
||||
```yaml
|
||||
notify:
|
||||
|
|
@ -41,30 +41,30 @@ notify:
|
|||
content: '{"body": {"version": 1,"type": "doc","content": [{"type": "paragraph","content": [{"type": "text","text": "New package published: * {{ name }}* Publisher name: * {{ publisher.name }}"}]}]}}'
|
||||
```
|
||||
|
||||
## Template
|
||||
## 模板
|
||||
|
||||
We use [Handlebars](https://handlebarsjs.com/) as main template engine.
|
||||
我们用[Handlebars](https://handlebarsjs.com/) 作为主要模板引擎。
|
||||
|
||||
### Format Examples
|
||||
### 格式范例
|
||||
|
||||
# iterate all versions
|
||||
# 重复所有版本
|
||||
{{ name }}{{#each versions}} v{{version}}{{/each}}`"}
|
||||
|
||||
# publisher and `dist-tag` package published
|
||||
# 已发布的发表人和 `dist-tag` 包
|
||||
{{ publisher.name }} has published {{publishedPackage}}"}
|
||||
|
||||
|
||||
### Properties
|
||||
### 属性
|
||||
|
||||
List of properties accesible via template
|
||||
通过模板进入的属性列表
|
||||
|
||||
* Metadata
|
||||
* Publisher (who is publishing)
|
||||
* Package Published (package@1.0.0)
|
||||
* 元数据
|
||||
* 发表者（在发表的人）
|
||||
* 已发布的包（包@1.0.0)
|
||||
|
||||
### Metadata
|
||||
### 元数据
|
||||
|
||||
Package metadata that the template has access
|
||||
模板可以访问的包元数据
|
||||
|
||||
{
|
||||
"_id": "@test/pkg1",
|
||||
|
|
@ -115,11 +115,11 @@ Package metadata that the template has access
|
|||
}
|
||||
|
||||
|
||||
### Publisher
|
||||
### 发表人
|
||||
|
||||
You can access to the package publisher information in the `content` of a webhook using the `publisher` object.
|
||||
您可以用`publisher` object(对象）在webhook的`content`里访问包发表人信息。
|
||||
|
||||
See below the `publisher` object type:
|
||||
请参阅以下`publisher` object（对象）类别：
|
||||
|
||||
{
|
||||
name: string,
|
||||
|
|
@ -128,7 +128,7 @@ See below the `publisher` object type:
|
|||
}
|
||||
|
||||
|
||||
An example:
|
||||
范例：
|
||||
|
||||
notify:
|
||||
method: POST
|
||||
|
|
@ -137,22 +137,22 @@ An example:
|
|||
content: '{"color":"green","message":"New package published: * {{ name }}*. Publisher name: * {{ publisher.name }} *.","notify":true,"message_format":"text"}'
|
||||
|
||||
|
||||
**Note:** it's not possible to get the publisher information if the `package.json` file already has the `publisher` property.
|
||||
**请注意:** 如果 `package.json` 文件已经有`publisher`属性，是不可能再拿到发表人信息的。
|
||||
|
||||
### Package Published
|
||||
### 已发布包
|
||||
|
||||
You can acces to the package is being published with the keyword `{{publishedPackage}}` as follows.
|
||||
您可以如以下所示用热词`{{publishedPackage}}` 来访问已经发布的包.
|
||||
|
||||
{{ publisher.name }} has published {{publishedPackage}}"}
|
||||
|
||||
|
||||
## Configuration
|
||||
## 配置
|
||||
|
||||
| Property | Type | Required | Support | Default | Description |
|
||||
| ------------------- | ------------ | -------- | ------- | ------- | -------------------------------------------------------------------------------------------- |
|
||||
| method | string | No | all | | HTTP verb |
|
||||
| packagePattern | string | No | all | | Only run this notification if the package name matches the regular expression |
|
||||
| packagePatternFlags | string | No | all | | Any flags to be used with the regular expression |
|
||||
| headers | array/object | Yes | all | | If this endpoint requires specific headers, set them here as an array of key: value objects. |
|
||||
| endpoint | string | Yes | all | | set the URL endpoint for this call |
|
||||
| content | string | Yes | all | | any [Handlebar](https://handlebarsjs.com/) expressions |
|
||||
| 属性 | 类型 | 必填 | 支持 | 默认 | 描述 |
|
||||
| ------------------- | ----- | -- | ---- | -- | ------------------------------------------- |
|
||||
| 方法 | 字符串 | 不 | 任意路径 | | HTTP verb |
|
||||
| packagePattern | 字符串 | 不 | 任意路径 | | 仅当包名字和正规表达式匹配时才运行此通知 |
|
||||
| packagePatternFlags | 字符串 | 不 | 任意路径 | | 任何与正规表达式一起使用的标记 |
|
||||
| 标头 | 数组/对象 | 是 | 任意路径 | | 如果此端点需要特定的标头，请把它们设置为键数组：value objects（值对象）。 |
|
||||
| 端点 | 字符串 | 是 | 任意路径 | | 设置此调用的URL 端点 |
|
||||
| 内容 | 字符串 | 是 | 任意路径 | | 任何[Handlebar](https://handlebarsjs.com/)表达式 |
|
||||
|
|
@ -117,6 +117,7 @@ store:
|
|||
* [verdaccio-active-directory](https://github.com/nowhammies/verdaccio-activedirectory)：verdaccio Active Directory认证插件
|
||||
* [verdaccio-gitlab](https://github.com/bufferoverflow/verdaccio-gitlab)：使用Gitlab的Personal Access Token进行认证
|
||||
* [verdaccio-htpasswd](https://github.com/verdaccio/verdaccio-htpasswd)：基于(内置)htpasswd文件插件的verdaccio认证插件
|
||||
* [verdaccio-github-oauth](https://github.com/aroundus-inc/verdaccio-github-oauth): Github oauth authentication plugin for verdaccio.
|
||||
|
||||
### 中间件插件
|
||||
|
||||
|
|
|
|||
|
|
@ -15,10 +15,12 @@ web:
|
|||
logo: logo.png
|
||||
```
|
||||
|
||||
All access restrictions defined to [protect your packages](protect-your-dependencies.md) will also apply to the Web Interface.
|
||||
|
||||
### Configuration
|
||||
|
||||
| Property | Type | Required | Example | Support | Description |
|
||||
| -------- | ------- | -------- | ------------------------------ | ------- | ---------------------------------- |
|
||||
| enable | boolean | No | true/false | all | allow to display the web interface |
|
||||
| title | string | No | $authenticated | 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 |
|
||||
Loading…
Add table
Reference in a new issue