1
0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-11-08 23:25:51 +01:00

Merge remote-tracking branch 'origin/master' into 4.x

This commit is contained in:
Juan Picado @jotadeveloper 2018-08-02 20:35:44 +02:00
commit 8c1fe7c21b
No known key found for this signature in database
GPG Key ID: 18AC54485952D158
3 changed files with 10 additions and 10 deletions

@ -26,7 +26,7 @@ interface IPluginAuth extends IPlugin {
}
```
> 仅 `adduser`, `allow_access` 和`allow_publish` 是可选的verdaccio 在所有这些例子里提供后退。
> 仅 `adduser`, `allow_access` 和`allow_publish` 是可选的verdaccio 在所有这些例子里提供后退功能
#### 回调
@ -104,7 +104,7 @@ interface verdaccio$IPluginMiddleware extends verdaccio$IPlugin {
### register_middlewares
此方法通过`auth`和`storage`提供完全认证访问。`app` 是可以让您添加新端点的表达应用程序。
此方法通过`auth`和`storage`提供认证和存储的完全访问。`app` 是可以让您添加新端点的应用程序。
> Middleware插件的一个很好的例子是[sinopia-github-oauth](https://github.com/soundtrackyourbrand/sinopia-github-oauth) 和 [verdaccio-audit](https://github.com/verdaccio/verdaccio-audit)。
@ -116,7 +116,7 @@ function register_middlewares(expressApp, authInstance, storageInstance) {
}
```
要注册middleware我们需要一个object对象以及一个可以接收3 个参数(`expressApp, auth, storage`),名叫 `register_middlewares`的单一方法。 *Auth*是authentification instance*storage* 也是主Storage instance,它将让您可以访问到所有存储操作。
要注册middleware我们需要一个object对象以及一个可以接收3 个参数(`expressApp, auth, storage`),名叫 `register_middlewares`的单一方法。 *Auth*是认证实例,*storage* 也是主存储实例,它将让您可以访问到所有存储操作。
## Storage Plugin存储插件
@ -124,7 +124,7 @@ Verdaccio 默认使用文件系统存储插件[local-storage](https://github.com
### API
存储API 更复杂一些,您将需要创建一个可以返回`IPluginStorage`执行的class。请参阅以下详细信息。
存储API 更复杂一些,您将需要创建一个可以返回实现`IPluginStorage`的class。请参阅以下详细信息。
```flow
class LocalDatabase<IPluginStorage>{
@ -174,11 +174,11 @@ class verdaccio$IReadTarball extends stream$PassThrough {
}
```
> 存储API 仍然还在实验阶段,并在接下来的小版本中可能会有修改。 更多有关存储API 的详细信息,请跟随[类型 我们官方资源库里的定义](https://github.com/verdaccio/flow-types)。
> 存储API 仍然还在实验阶段,并在接下来的小版本中可能会有修改。 更多有关存储API 的详细信息,请访问[我们官方资源库里的类型定义](https://github.com/verdaccio/flow-types)。
### 存储插件示例
以下插件列表执行存储API可以被用作示例。
以下插件列表实现存储API可以被用作示例。
* [verdaccio-memory](https://github.com/verdaccio/verdaccio-memory)
* [local-storage](https://github.com/verdaccio/local-storage)

@ -88,7 +88,7 @@ PORT=5000; docker run -it --rm --name verdaccio \
verdaccio/verdaccio
```
### HTTPS与Docker一同使用
### 在Docker中使用HTTPS
您可以配置 verdaccio 要监听的协议,类似于端口配置。 在 config.yaml里指定证书后您必须用"https"覆盖`PROTOCOL` 环境变量中的默认值("http")。
@ -109,7 +109,7 @@ $ docker-compose up --build
把`PORT=5000`作为以上命令的前缀来设置要使用(容器和主机二者)的端口。
Docker将生成一个named volume命名卷它用于存储持应用程序数据。 您可以使用`docker inspect` 或者 `docker volume inspect` 来查看此volume的物理位置并编辑配置比如
Docker将生成一个named volume命名卷它用于存储持久化应用程序数据。 您可以使用`docker inspect` 或者 `docker volume inspect` 来查看此volume的物理位置并编辑配置比如
$ docker volume inspect verdaccio_verdaccio
[
@ -144,7 +144,7 @@ npm run build:docker
npm run build:docker:rpi
```
请注意,您需要在您的机台上安装 docker 来执行以上任何docker命令 docker 执行项应该在您的`$PATH`里。
请注意,您需要在您的机器上安装 docker 来执行以上任何docker命令 docker 可执行程序应该在您的`$PATH`里。
## Docker示例

@ -120,7 +120,7 @@ store:
* [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): verdaccio 的Github oauth认证插件。
* [verdaccio-github-oauth-ui](https://github.com/n4bb12/verdaccio-github-oauth-ui): GitHub OAuth plugin for the verdaccio login button.
* [verdaccio-github-oauth-ui](https://github.com/n4bb12/verdaccio-github-oauth-ui): verdaccio登录按钮的GitHub OAuth 插件。
### 中间件插件