mirror of
https://github.com/verdaccio/verdaccio.git
synced 2025-03-25 02:32:52 -05:00
docs: update translations
docs: update translations
This commit is contained in:
verdacciobot
Juan Picado @jotadeveloper
parent
7f03b5f2c5
commit
1cf6b7bff8
162 changed files with 216 additions and 216 deletions
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: ansible
|
||||
title: Installing with Ansible
|
||||
title: "Installing with Ansible"
|
||||
---
|
||||
We have a customised solution for `verdaccio` in our organization.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: authentification
|
||||
title: Authentification
|
||||
title: "Authentification"
|
||||
---
|
||||
The authentification is tied to the auth [plugin](plugins.md) you are using. The package restrictions also is handled by the [Package Access](packages.md).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: build
|
||||
title: Build the source code
|
||||
title: "Build the source code"
|
||||
---
|
||||
Verdaccio relies on `yarn` instead `npm` to download depenedencies.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: cli
|
||||
title: Command Line Tool
|
||||
title: "Command Line Tool"
|
||||
---
|
||||
The verdaccio CLI is your go start the application.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: configuration
|
||||
title: Archivo de Configuración
|
||||
title: "Archivo de Configuración"
|
||||
---
|
||||
Este archivo es la piedra angular de verdaccio donde puedes modificar su comportamiento por defecto, activar plugins y características externas.
|
||||
|
||||
|
|
@ -134,9 +134,9 @@ Para habilitar`https` en `verdaccio` es suficiente con definir en `listen` en su
|
|||
|
||||
```yaml
|
||||
https:
|
||||
key: path/to/server.key
|
||||
cert: path/to/server.crt
|
||||
ca: path/to/server.pem
|
||||
key: ./path/verdaccio-key.pem
|
||||
cert: ./path/verdaccio-cert.pem
|
||||
ca: ./path/verdaccio-csr.pem
|
||||
```
|
||||
|
||||
### Proxy
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: contributing
|
||||
title: Contribuyendo en Verdaccio
|
||||
title: "Contribuyendo en Verdaccio"
|
||||
---
|
||||
Primero lo primero, saltar en un código desconocido no es tarea fácil, pero estamos aquí para ayudarte.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: dev-plugins
|
||||
title: Developing Plugins
|
||||
title: "Developing Plugins"
|
||||
---
|
||||
There are many ways to extend `verdaccio`, currently we support `authentication plugins`, `middleware plugins` (since `v2.7.0`) and `storage plugins` since (`v3.x`).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: home
|
||||
title: Verdaccio npm proxy private registry
|
||||
title: "Verdaccio npm proxy private registry"
|
||||
---
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: iss-server
|
||||
title: Installing on IIS server
|
||||
title: "Installing on IIS server"
|
||||
---
|
||||
These instructions were written for Windows Server 2012, IIS 8, [Node.js 0.12.3](https://nodejs.org/), [iisnode 0.2.16](https://github.com/tjanczuk/iisnode) and [verdaccio 2.1.0](https://github.com/verdaccio/verdaccio).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: installation
|
||||
title: Installation
|
||||
title: "Installation"
|
||||
---
|
||||
Verdaccio es una aplicación web multiplataforma, para instalarla al menos necesitas ciertos prerrequisitos.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: kubernetes
|
||||
title: 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.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: logger
|
||||
title: Logger
|
||||
title: "Logger"
|
||||
---
|
||||
As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: node-api
|
||||
title: Node API
|
||||
title: "Node API"
|
||||
---
|
||||
Verdaccio can be invoqued programmatically. The node API was introduced after version `verdaccio@3.0.0-alpha.10`.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: notifications
|
||||
title: Notifications
|
||||
title: "Notifications"
|
||||
---
|
||||
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 `publish` / `create` commands.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: packages
|
||||
title: Package Access
|
||||
title: "Package Access"
|
||||
---
|
||||
It's a series of contrains that allow or restrict access to the local storage based in specific criteria.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: plugins
|
||||
title: Plugins
|
||||
title: "Plugins"
|
||||
---
|
||||
Verdaccio is an plugabble aplication. Currently supports multiple plugins only for [Authentication](auth.md) but there are plans to [improve the plugin system](https://github.com/verdaccio/verdaccio/issues/169). If you are interested to develop your own plugin, read the [development](development.md) section.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: protect-your-dependencies
|
||||
title: Protecting packages
|
||||
title: "Protecting packages"
|
||||
---
|
||||
`verdaccio` allows you protect publish, to achieve that you will need to set up correctly your [packages acces](packages).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: source-code
|
||||
title: Source Code
|
||||
title: "Source Code"
|
||||
---
|
||||
`verdaccio` is composed or multiple repositories you might contribute. Look into the **issues** tab whether there is a ticket waiting for you
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: reverse-proxy
|
||||
title: Reverse Proxy Setup
|
||||
title: "Reverse Proxy Setup"
|
||||
---
|
||||
## Apache
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: server-configuration
|
||||
title: Server Configuration
|
||||
title: "Server Configuration"
|
||||
---
|
||||
This is mostly basic linux server configuration stuff but I felt it important to document and share the steps I took to get verdaccio running permanently on my server. You will need root (or sudo) permissions for the following.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: ssl
|
||||
title: Set up the SSL Certificates
|
||||
title: "Set up the SSL Certificates"
|
||||
---
|
||||
Follow this instructions to configure a SSL certificate to serve NPM registry under HTTPS.
|
||||
|
||||
|
|
@ -13,22 +13,22 @@ Once you update the listen and try to run verdaccio again will ask for certifica
|
|||
|
||||
* Generate your certificates
|
||||
|
||||
$ openssl genrsa -out ~/.config/verdaccio/verdaccio-key.pem 2048
|
||||
$ openssl req -new -sha256 -key ~/.config/verdaccio/verdaccio-key.pem -out ~/.config/verdaccio/verdaccio-csr.pem
|
||||
$ openssl x509 -req -in ~/.config/verdaccio/verdaccio-csr.pem -signkey ~/.config/verdaccio/verdaccio-key.pem -out ~/.config/verdaccio/verdaccio-cert.pem
|
||||
$ openssl genrsa -out /Users/user/.config/verdaccio/verdaccio-key.pem 2048
|
||||
$ openssl req -new -sha256 -key /Users/user/.config/verdaccio/verdaccio-key.pem -out /Users/user/.config/verdaccio/verdaccio-csr.pem
|
||||
$ openssl x509 -req -in /Users/user/.config/verdaccio/verdaccio-csr.pem -signkey /Users/user/.config/verdaccio/verdaccio-key.pem -out /Users/user/.config/verdaccio/verdaccio-cert.pem
|
||||
````
|
||||
|
||||
* Edit your config file `~/.config/verdaccio/config.yaml` and add the following section
|
||||
* Edit your config file `/Users/user/.config/verdaccio/config.yaml` and add the following section
|
||||
|
||||
|
||||
|
||||
https: key: ~/.config/verdaccio/server.key cert: ~/.config/verdaccio/server.crt ca: ~/.config/verdaccio/server.ca
|
||||
https: key: /Users/user/.config/verdaccio/verdaccio-key.pem cert: /Users/user/.config/verdaccio/verdaccio-cert.pem ca: /Users/user/.config/verdaccio/verdaccio-csr.pem
|
||||
|
||||
<br />Alternatively, if you have a certificate as `server.pfx` format, you can add the following configuration section. The passphrase is optional and only needed, if your certificate is encrypted.
|
||||
|
||||
|
||||
|
||||
https: pfx: ~/.config/verdaccio/server.pfx passphrase: 'secret' ````
|
||||
https: pfx: /Users/user/.config/verdaccio/server.pfx passphrase: 'secret' ````
|
||||
|
||||
More info on the `key`, `cert`, `ca`, `pfx` and `passphrase` arguments on the [Node documentation](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: unit-testing
|
||||
title: Unit Testing
|
||||
title: "Unit Testing"
|
||||
---
|
||||
All tests are split in three folders:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: uplinks
|
||||
title: Uplinks
|
||||
title: "Uplinks"
|
||||
---
|
||||
An *uplink* is a link with an external registry that provides acccess to external packages.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: use-cases
|
||||
title: Use Cases
|
||||
title: "Use Cases"
|
||||
---
|
||||
## Using private packages
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: webui
|
||||
title: Interfaz Web de Usuario
|
||||
title: "Interfaz Web de Usuario"
|
||||
---
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: what-is-verdaccio
|
||||
title: Qué es Verdaccio?
|
||||
title: "Qué es Verdaccio?"
|
||||
---
|
||||
## En pocas palabras
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: windows
|
||||
title: Installing As a Windows Service
|
||||
title: "Installing As a Windows Service"
|
||||
---
|
||||
Loosely based upon the instructions found [here](http://asysadmin.tumblr.com/post/32941224574/running-nginx-on-windows-as-a-service). I crafted the following and it provided me with a fully working verdaccio service installation:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: ansible
|
||||
title: Installing with Ansible
|
||||
title: "Installing with Ansible"
|
||||
---
|
||||
We have a customised solution for `verdaccio` in our organization.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: authentification
|
||||
title: Authentification
|
||||
title: "Authentification"
|
||||
---
|
||||
The authentification is tied to the auth [plugin](plugins.md) you are using. The package restrictions also is handled by the [Package Access](packages.md).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: build
|
||||
title: Build the source code
|
||||
title: "Build the source code"
|
||||
---
|
||||
Verdaccio relies on `yarn` instead `npm` to download depenedencies.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: cli
|
||||
title: Utilitário na Linha de Comando
|
||||
title: "Utilitário na Linha de Comando"
|
||||
---
|
||||
A linha de comando é por onde você pode controlar toda a sua instalação Verdaccio.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: configuration
|
||||
title: Arquivo de Configuração
|
||||
title: "Arquivo de Configuração"
|
||||
---
|
||||
This file is the cornerstone of verdaccio where you can modify the default behaviour, enable plugins and extend features.
|
||||
|
||||
|
|
@ -134,9 +134,9 @@ To enable `https` in `verdaccio` enough with set your `listen` domain with the p
|
|||
|
||||
```yaml
|
||||
https:
|
||||
key: path/to/server.key
|
||||
cert: path/to/server.crt
|
||||
ca: path/to/server.pem
|
||||
key: ./path/verdaccio-key.pem
|
||||
cert: ./path/verdaccio-cert.pem
|
||||
ca: ./path/verdaccio-csr.pem
|
||||
```
|
||||
|
||||
### Proxy
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: contributing
|
||||
title: Contributing Verdaccio
|
||||
title: "Contributing Verdaccio"
|
||||
---
|
||||
First of all Jumping into an unfamiliar code base is not easy but we are here to help you.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: dev-plugins
|
||||
title: Developing Plugins
|
||||
title: "Developing Plugins"
|
||||
---
|
||||
There are many ways to extend `verdaccio`, currently we support `authentication plugins`, `middleware plugins` (since `v2.7.0`) and `storage plugins` since (`v3.x`).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: home
|
||||
title: Verdaccio registro privado e proxy npm
|
||||
title: "Verdaccio registro privado e proxy npm"
|
||||
---
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: iss-server
|
||||
title: Installing on IIS server
|
||||
title: "Installing on IIS server"
|
||||
---
|
||||
These instructions were written for Windows Server 2012, IIS 8, [Node.js 0.12.3](https://nodejs.org/), [iisnode 0.2.16](https://github.com/tjanczuk/iisnode) and [verdaccio 2.1.0](https://github.com/verdaccio/verdaccio).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: installation
|
||||
title: Instalação
|
||||
title: "Instalação"
|
||||
---
|
||||
Verdaccio is a multiplatform web application, to install you need at least some prerequisites.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: kubernetes
|
||||
title: 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.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: logger
|
||||
title: Logger
|
||||
title: "Logger"
|
||||
---
|
||||
As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: node-api
|
||||
title: Api Node
|
||||
title: "Api Node"
|
||||
---
|
||||
Verdaccio pode ser inicializado de forma customizada através de um script utilizando a nova API implementada a partir da `verdaccio@3.0.0-alpha.10`.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: notifications
|
||||
title: Notifications
|
||||
title: "Notifications"
|
||||
---
|
||||
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 `publish` / `create` commands.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: packages
|
||||
title: Package Access
|
||||
title: "Package Access"
|
||||
---
|
||||
It's a series of contrains that allow or restrict access to the local storage based in specific criteria.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: plugins
|
||||
title: Plugins
|
||||
title: "Plugins"
|
||||
---
|
||||
Verdaccio is an plugabble aplication. Currently supports multiple plugins only for [Authentication](auth.md) but there are plans to [improve the plugin system](https://github.com/verdaccio/verdaccio/issues/169). If you are interested to develop your own plugin, read the [development](development.md) section.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: protect-your-dependencies
|
||||
title: Protecting packages
|
||||
title: "Protecting packages"
|
||||
---
|
||||
`verdaccio` allows you protect publish, to achieve that you will need to set up correctly your [packages acces](packages).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: source-code
|
||||
title: Source Code
|
||||
title: "Source Code"
|
||||
---
|
||||
`verdaccio` is composed or multiple repositories you might contribute. Look into the **issues** tab whether there is a ticket waiting for you
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: reverse-proxy
|
||||
title: Reverse Proxy Setup
|
||||
title: "Reverse Proxy Setup"
|
||||
---
|
||||
## Apache
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: server-configuration
|
||||
title: Server Configuration
|
||||
title: "Server Configuration"
|
||||
---
|
||||
This is mostly basic linux server configuration stuff but I felt it important to document and share the steps I took to get verdaccio running permanently on my server. You will need root (or sudo) permissions for the following.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: ssl
|
||||
title: Set up the SSL Certificates
|
||||
title: "Set up the SSL Certificates"
|
||||
---
|
||||
Follow this instructions to configure a SSL certificate to serve NPM registry under HTTPS.
|
||||
|
||||
|
|
@ -13,22 +13,22 @@ Once you update the listen and try to run verdaccio again will ask for certifica
|
|||
|
||||
* Generate your certificates
|
||||
|
||||
$ openssl genrsa -out ~/.config/verdaccio/verdaccio-key.pem 2048
|
||||
$ openssl req -new -sha256 -key ~/.config/verdaccio/verdaccio-key.pem -out ~/.config/verdaccio/verdaccio-csr.pem
|
||||
$ openssl x509 -req -in ~/.config/verdaccio/verdaccio-csr.pem -signkey ~/.config/verdaccio/verdaccio-key.pem -out ~/.config/verdaccio/verdaccio-cert.pem
|
||||
$ openssl genrsa -out /Users/user/.config/verdaccio/verdaccio-key.pem 2048
|
||||
$ openssl req -new -sha256 -key /Users/user/.config/verdaccio/verdaccio-key.pem -out /Users/user/.config/verdaccio/verdaccio-csr.pem
|
||||
$ openssl x509 -req -in /Users/user/.config/verdaccio/verdaccio-csr.pem -signkey /Users/user/.config/verdaccio/verdaccio-key.pem -out /Users/user/.config/verdaccio/verdaccio-cert.pem
|
||||
````
|
||||
|
||||
* Edit your config file `~/.config/verdaccio/config.yaml` and add the following section
|
||||
* Edit your config file `/Users/user/.config/verdaccio/config.yaml` and add the following section
|
||||
|
||||
|
||||
|
||||
https: key: ~/.config/verdaccio/server.key cert: ~/.config/verdaccio/server.crt ca: ~/.config/verdaccio/server.ca
|
||||
https: key: /Users/user/.config/verdaccio/verdaccio-key.pem cert: /Users/user/.config/verdaccio/verdaccio-cert.pem ca: /Users/user/.config/verdaccio/verdaccio-csr.pem
|
||||
|
||||
<br />Alternatively, if you have a certificate as `server.pfx` format, you can add the following configuration section. The passphrase is optional and only needed, if your certificate is encrypted.
|
||||
|
||||
|
||||
|
||||
https: pfx: ~/.config/verdaccio/server.pfx passphrase: 'secret' ````
|
||||
https: pfx: /Users/user/.config/verdaccio/server.pfx passphrase: 'secret' ````
|
||||
|
||||
More info on the `key`, `cert`, `ca`, `pfx` and `passphrase` arguments on the [Node documentation](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: unit-testing
|
||||
title: Unit Testing
|
||||
title: "Unit Testing"
|
||||
---
|
||||
All tests are split in three folders:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: uplinks
|
||||
title: Uplinks
|
||||
title: "Uplinks"
|
||||
---
|
||||
An *uplink* is a link with an external registry that provides acccess to external packages.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: use-cases
|
||||
title: Use Cases
|
||||
title: "Use Cases"
|
||||
---
|
||||
## Using private packages
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: webui
|
||||
title: Web User Interface
|
||||
title: "Web User Interface"
|
||||
---
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: what-is-verdaccio
|
||||
title: O que é o Verdaccio?
|
||||
title: "O que é o Verdaccio?"
|
||||
---
|
||||
## Em poucas palavras
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: windows
|
||||
title: Installing As a Windows Service
|
||||
title: "Installing As a Windows Service"
|
||||
---
|
||||
Loosely based upon the instructions found [here](http://asysadmin.tumblr.com/post/32941224574/running-nginx-on-windows-as-a-service). I crafted the following and it provided me with a fully working verdaccio service installation:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: ansible
|
||||
title: Installing with Ansible
|
||||
title: "Installing with Ansible"
|
||||
---
|
||||
We have a customised solution for `verdaccio` in our organization.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: authentification
|
||||
title: Authentification
|
||||
title: "Authentification"
|
||||
---
|
||||
The authentification is tied to the auth [plugin](plugins.md) you are using. The package restrictions also is handled by the [Package Access](packages.md).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: build
|
||||
title: Build the source code
|
||||
title: "Build the source code"
|
||||
---
|
||||
Verdaccio relies on `yarn` instead `npm` to download depenedencies.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: cli
|
||||
title: Command Line Tool
|
||||
title: "Command Line Tool"
|
||||
---
|
||||
The verdaccio CLI is your go start the application.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: configuration
|
||||
title: Configuration File
|
||||
title: "Configuration File"
|
||||
---
|
||||
This file is the cornerstone of verdaccio where you can modify the default behaviour, enable plugins and extend features.
|
||||
|
||||
|
|
@ -134,9 +134,9 @@ To enable `https` in `verdaccio` enough with set your `listen` domain with the p
|
|||
|
||||
```yaml
|
||||
https:
|
||||
key: path/to/server.key
|
||||
cert: path/to/server.crt
|
||||
ca: path/to/server.pem
|
||||
key: ./path/verdaccio-key.pem
|
||||
cert: ./path/verdaccio-cert.pem
|
||||
ca: ./path/verdaccio-csr.pem
|
||||
```
|
||||
|
||||
### Proxy
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: contributing
|
||||
title: Contributing Verdaccio
|
||||
title: "Contributing Verdaccio"
|
||||
---
|
||||
First of all Jumping into an unfamiliar code base is not easy but we are here to help you.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: dev-plugins
|
||||
title: Developing Plugins
|
||||
title: "Developing Plugins"
|
||||
---
|
||||
There are many ways to extend `verdaccio`, currently we support `authentication plugins`, `middleware plugins` (since `v2.7.0`) and `storage plugins` since (`v3.x`).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: home
|
||||
title: Verdaccio npm proxy private registry
|
||||
title: "Verdaccio npm proxy private registry"
|
||||
---
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: iss-server
|
||||
title: Installing on IIS server
|
||||
title: "Installing on IIS server"
|
||||
---
|
||||
These instructions were written for Windows Server 2012, IIS 8, [Node.js 0.12.3](https://nodejs.org/), [iisnode 0.2.16](https://github.com/tjanczuk/iisnode) and [verdaccio 2.1.0](https://github.com/verdaccio/verdaccio).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: installation
|
||||
title: Installation
|
||||
title: "Installation"
|
||||
---
|
||||
Verdaccio is a multiplatform web application, to install you need at least some prerequisites.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: kubernetes
|
||||
title: 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.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: logger
|
||||
title: Logger
|
||||
title: "Logger"
|
||||
---
|
||||
As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: node-api
|
||||
title: Node API
|
||||
title: "Node API"
|
||||
---
|
||||
Verdaccio can be invoqued programmatically. The node API was introduced after version `verdaccio@3.0.0-alpha.10`.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: notifications
|
||||
title: Notifications
|
||||
title: "Notifications"
|
||||
---
|
||||
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 `publish` / `create` commands.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: packages
|
||||
title: Package Access
|
||||
title: "Package Access"
|
||||
---
|
||||
It's a series of contrains that allow or restrict access to the local storage based in specific criteria.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: plugins
|
||||
title: Plugins
|
||||
title: "Plugins"
|
||||
---
|
||||
Verdaccio is an plugabble aplication. Currently supports multiple plugins only for [Authentication](auth.md) but there are plans to [improve the plugin system](https://github.com/verdaccio/verdaccio/issues/169). If you are interested to develop your own plugin, read the [development](development.md) section.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: protect-your-dependencies
|
||||
title: Protecting packages
|
||||
title: "Protecting packages"
|
||||
---
|
||||
`verdaccio` allows you protect publish, to achieve that you will need to set up correctly your [packages acces](packages).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: source-code
|
||||
title: Source Code
|
||||
title: "Source Code"
|
||||
---
|
||||
`verdaccio` is composed or multiple repositories you might contribute. Look into the **issues** tab whether there is a ticket waiting for you
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: reverse-proxy
|
||||
title: Reverse Proxy Setup
|
||||
title: "Reverse Proxy Setup"
|
||||
---
|
||||
## Apache
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: server-configuration
|
||||
title: Server Configuration
|
||||
title: "Server Configuration"
|
||||
---
|
||||
This is mostly basic linux server configuration stuff but I felt it important to document and share the steps I took to get verdaccio running permanently on my server. You will need root (or sudo) permissions for the following.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: ssl
|
||||
title: Set up the SSL Certificates
|
||||
title: "Set up the SSL Certificates"
|
||||
---
|
||||
Follow this instructions to configure a SSL certificate to serve NPM registry under HTTPS.
|
||||
|
||||
|
|
@ -13,22 +13,22 @@ Once you update the listen and try to run verdaccio again will ask for certifica
|
|||
|
||||
* Generate your certificates
|
||||
|
||||
$ openssl genrsa -out ~/.config/verdaccio/verdaccio-key.pem 2048
|
||||
$ openssl req -new -sha256 -key ~/.config/verdaccio/verdaccio-key.pem -out ~/.config/verdaccio/verdaccio-csr.pem
|
||||
$ openssl x509 -req -in ~/.config/verdaccio/verdaccio-csr.pem -signkey ~/.config/verdaccio/verdaccio-key.pem -out ~/.config/verdaccio/verdaccio-cert.pem
|
||||
$ openssl genrsa -out /Users/user/.config/verdaccio/verdaccio-key.pem 2048
|
||||
$ openssl req -new -sha256 -key /Users/user/.config/verdaccio/verdaccio-key.pem -out /Users/user/.config/verdaccio/verdaccio-csr.pem
|
||||
$ openssl x509 -req -in /Users/user/.config/verdaccio/verdaccio-csr.pem -signkey /Users/user/.config/verdaccio/verdaccio-key.pem -out /Users/user/.config/verdaccio/verdaccio-cert.pem
|
||||
````
|
||||
|
||||
* Edit your config file `~/.config/verdaccio/config.yaml` and add the following section
|
||||
* Edit your config file `/Users/user/.config/verdaccio/config.yaml` and add the following section
|
||||
|
||||
|
||||
|
||||
https: key: ~/.config/verdaccio/server.key cert: ~/.config/verdaccio/server.crt ca: ~/.config/verdaccio/server.ca
|
||||
https: key: /Users/user/.config/verdaccio/verdaccio-key.pem cert: /Users/user/.config/verdaccio/verdaccio-cert.pem ca: /Users/user/.config/verdaccio/verdaccio-csr.pem
|
||||
|
||||
<br />Alternatively, if you have a certificate as `server.pfx` format, you can add the following configuration section. The passphrase is optional and only needed, if your certificate is encrypted.
|
||||
|
||||
|
||||
|
||||
https: pfx: ~/.config/verdaccio/server.pfx passphrase: 'secret' ````
|
||||
https: pfx: /Users/user/.config/verdaccio/server.pfx passphrase: 'secret' ````
|
||||
|
||||
More info on the `key`, `cert`, `ca`, `pfx` and `passphrase` arguments on the [Node documentation](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: unit-testing
|
||||
title: Unit Testing
|
||||
title: "Unit Testing"
|
||||
---
|
||||
All tests are split in three folders:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: uplinks
|
||||
title: Uplinks
|
||||
title: "Uplinks"
|
||||
---
|
||||
An *uplink* is a link with an external registry that provides acccess to external packages.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: use-cases
|
||||
title: Use Cases
|
||||
title: "Use Cases"
|
||||
---
|
||||
## Using private packages
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: webui
|
||||
title: Web User Interface
|
||||
title: "Web User Interface"
|
||||
---
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: what-is-verdaccio
|
||||
title: What is Verdaccio?
|
||||
title: "What is Verdaccio?"
|
||||
---
|
||||
## In a nutshell
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: windows
|
||||
title: Installing As a Windows Service
|
||||
title: "Installing As a Windows Service"
|
||||
---
|
||||
Loosely based upon the instructions found [here](http://asysadmin.tumblr.com/post/32941224574/running-nginx-on-windows-as-a-service). I crafted the following and it provided me with a fully working verdaccio service installation:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: ansible
|
||||
title: Installing with Ansible
|
||||
title: "Installing with Ansible"
|
||||
---
|
||||
We have a customised solution for `verdaccio` in our organization.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: authentification
|
||||
title: Authentification
|
||||
title: "Authentification"
|
||||
---
|
||||
The authentification is tied to the auth [plugin](plugins.md) you are using. The package restrictions also is handled by the [Package Access](packages.md).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: build
|
||||
title: Build the source code
|
||||
title: "Build the source code"
|
||||
---
|
||||
Verdaccio relies on `yarn` instead `npm` to download depenedencies.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: cli
|
||||
title: Command Line Tool
|
||||
title: "Command Line Tool"
|
||||
---
|
||||
The verdaccio CLI is your go start the application.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: configuration
|
||||
title: Configuration File
|
||||
title: "Configuration File"
|
||||
---
|
||||
This file is the cornerstone of verdaccio where you can modify the default behaviour, enable plugins and extend features.
|
||||
|
||||
|
|
@ -134,9 +134,9 @@ To enable `https` in `verdaccio` enough with set your `listen` domain with the p
|
|||
|
||||
```yaml
|
||||
https:
|
||||
key: path/to/server.key
|
||||
cert: path/to/server.crt
|
||||
ca: path/to/server.pem
|
||||
key: ./path/verdaccio-key.pem
|
||||
cert: ./path/verdaccio-cert.pem
|
||||
ca: ./path/verdaccio-csr.pem
|
||||
```
|
||||
|
||||
### Proxy
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: contributing
|
||||
title: Contributing Verdaccio
|
||||
title: "Contributing Verdaccio"
|
||||
---
|
||||
First of all Jumping into an unfamiliar code base is not easy but we are here to help you.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: dev-plugins
|
||||
title: Developing Plugins
|
||||
title: "Developing Plugins"
|
||||
---
|
||||
There are many ways to extend `verdaccio`, currently we support `authentication plugins`, `middleware plugins` (since `v2.7.0`) and `storage plugins` since (`v3.x`).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: home
|
||||
title: Verdaccio npm proxy private registry
|
||||
title: "Verdaccio npm proxy private registry"
|
||||
---
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: iss-server
|
||||
title: Installing on IIS server
|
||||
title: "Installing on IIS server"
|
||||
---
|
||||
These instructions were written for Windows Server 2012, IIS 8, [Node.js 0.12.3](https://nodejs.org/), [iisnode 0.2.16](https://github.com/tjanczuk/iisnode) and [verdaccio 2.1.0](https://github.com/verdaccio/verdaccio).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: installation
|
||||
title: Installation
|
||||
title: "Installation"
|
||||
---
|
||||
Verdaccio is a multiplatform web application, to install you need at least some prerequisites.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: kubernetes
|
||||
title: 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.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: logger
|
||||
title: Logger
|
||||
title: "Logger"
|
||||
---
|
||||
As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: node-api
|
||||
title: Node API
|
||||
title: "Node API"
|
||||
---
|
||||
Verdaccio can be invoqued programmatically. The node API was introduced after version `verdaccio@3.0.0-alpha.10`.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: notifications
|
||||
title: Notifications
|
||||
title: "Notifications"
|
||||
---
|
||||
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 `publish` / `create` commands.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: packages
|
||||
title: Package Access
|
||||
title: "Package Access"
|
||||
---
|
||||
It's a series of contrains that allow or restrict access to the local storage based in specific criteria.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: plugins
|
||||
title: Plugins
|
||||
title: "Plugins"
|
||||
---
|
||||
Verdaccio is an plugabble aplication. Currently supports multiple plugins only for [Authentication](auth.md) but there are plans to [improve the plugin system](https://github.com/verdaccio/verdaccio/issues/169). If you are interested to develop your own plugin, read the [development](development.md) section.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: protect-your-dependencies
|
||||
title: Protecting packages
|
||||
title: "Protecting packages"
|
||||
---
|
||||
`verdaccio` allows you protect publish, to achieve that you will need to set up correctly your [packages acces](packages).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: source-code
|
||||
title: Source Code
|
||||
title: "Source Code"
|
||||
---
|
||||
`verdaccio` is composed or multiple repositories you might contribute. Look into the **issues** tab whether there is a ticket waiting for you
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: reverse-proxy
|
||||
title: Reverse Proxy Setup
|
||||
title: "Reverse Proxy Setup"
|
||||
---
|
||||
## Apache
|
||||
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Reference in a new issue