New Crowdin translations (#461)
* New translations ansible.md (Chinese Traditional) * New translations uplinks.md (Chinese Traditional, Hong Kong) * New translations ssl.md (Urdu (Pakistan)) * New translations test.md (Chinese Traditional) * New translations test.md (Chinese Traditional, Hong Kong) * New translations test.md (Portuguese, Brazilian) * New translations test.md (Spanish) * New translations test.md (Urdu (Pakistan)) * New translations uplinks.md (Chinese Traditional) * New translations uplinks.md (Portuguese, Brazilian) * New translations ssl.md (Portuguese, Brazilian) * New translations uplinks.md (Spanish) * New translations uplinks.md (Urdu (Pakistan)) * New translations use-cases.md (Chinese Traditional) * New translations use-cases.md (Chinese Traditional, Hong Kong) * New translations use-cases.md (Portuguese, Brazilian) * New translations use-cases.md (Spanish) * New translations use-cases.md (Urdu (Pakistan)) * New translations ssl.md (Spanish) * New translations ssl.md (Chinese Traditional, Hong Kong) * New translations web.md (Chinese Traditional, Hong Kong) * New translations reverse-proxy.md (Chinese Traditional, Hong Kong) * New translations protect-your-dependencies.md (Urdu (Pakistan)) * New translations repositories.md (Chinese Traditional) * New translations repositories.md (Chinese Traditional, Hong Kong) * New translations repositories.md (Portuguese, Brazilian) * New translations repositories.md (Spanish) * New translations repositories.md (Urdu (Pakistan)) * New translations reverse-proxy.md (Chinese Traditional) * New translations reverse-proxy.md (Portuguese, Brazilian) * New translations ssl.md (Chinese Traditional) * New translations reverse-proxy.md (Spanish) * New translations reverse-proxy.md (Urdu (Pakistan)) * New translations server.md (Chinese Traditional) * New translations server.md (Chinese Traditional, Hong Kong) * New translations server.md (Portuguese, Brazilian) * New translations server.md (Spanish) * New translations server.md (Urdu (Pakistan)) * New translations web.md (Chinese Traditional) * New translations web.md (Portuguese, Brazilian) * New translations protect-your-dependencies.md (Portuguese, Brazilian) * New translations repositories.md (Chinese Simplified) * New translations install.md (Chinese Simplified) * New translations kubernetes.md (Chinese Simplified) * New translations logger.md (Chinese Simplified) * New translations notifications.md (Chinese Simplified) * New translations packages.md (Chinese Simplified) * New translations plugins.md (Chinese Simplified) * New translations protect-your-dependencies.md (Chinese Simplified) * New translations reverse-proxy.md (Chinese Simplified) * New translations home.md (Chinese Simplified) * New translations server.md (Chinese Simplified) * New translations ssl.md (Chinese Simplified) * New translations test.md (Chinese Simplified) * New translations uplinks.md (Chinese Simplified) * New translations use-cases.md (Chinese Simplified) * New translations web.md (Chinese Simplified) * New translations windows.md (Chinese Simplified) * New translations iis-server.md (Chinese Simplified) * New translations docker.md (Chinese Simplified) * New translations web.md (Spanish) * New translations web.md (Urdu (Pakistan)) * New translations windows.md (Chinese Traditional) * New translations windows.md (Chinese Traditional, Hong Kong) * New translations windows.md (Portuguese, Brazilian) * New translations windows.md (Spanish) * New translations windows.md (Urdu (Pakistan)) * New translations dev-plugins.md (Chinese Simplified) * New translations ansible.md (Chinese Simplified) * New translations auth.md (Chinese Simplified) * New translations cli.md (Chinese Simplified) * New translations config.md (Chinese Simplified) * New translations contributing.md (Chinese Simplified) * New translations protect-your-dependencies.md (Spanish) * New translations protect-your-dependencies.md (Chinese Traditional, Hong Kong) * New translations ansible.md (Chinese Traditional, Hong Kong) * New translations dev-plugins.md (Chinese Traditional) * New translations config.md (Spanish) * New translations config.md (Urdu (Pakistan)) * New translations contributing.md (Chinese Traditional) * New translations contributing.md (Chinese Traditional, Hong Kong) * New translations contributing.md (Portuguese, Brazilian) * New translations contributing.md (Spanish) * New translations contributing.md (Urdu (Pakistan)) * New translations dev-plugins.md (Chinese Traditional, Hong Kong) * New translations config.md (Chinese Traditional, Hong Kong) * New translations dev-plugins.md (Portuguese, Brazilian) * New translations dev-plugins.md (Spanish) * New translations dev-plugins.md (Urdu (Pakistan)) * New translations docker.md (Chinese Traditional) * New translations docker.md (Chinese Traditional, Hong Kong) * New translations docker.md (Portuguese, Brazilian) * New translations docker.md (Spanish) * New translations config.md (Portuguese, Brazilian) * New translations config.md (Chinese Traditional) * New translations home.md (Chinese Traditional) * New translations auth.md (Urdu (Pakistan)) * New translations ansible.md (Portuguese, Brazilian) * New translations ansible.md (Spanish) * New translations ansible.md (Urdu (Pakistan)) * New translations auth.md (Chinese Traditional) * New translations auth.md (Chinese Traditional, Hong Kong) * New translations auth.md (Portuguese, Brazilian) * New translations auth.md (Spanish) * New translations cli.md (Urdu (Pakistan)) * New translations cli.md (Chinese Traditional) * New translations cli.md (Chinese Traditional, Hong Kong) * New translations cli.md (Portuguese, Brazilian) * New translations cli.md (Spanish) * New translations docker.md (Urdu (Pakistan)) * New translations home.md (Chinese Traditional, Hong Kong) * New translations protect-your-dependencies.md (Chinese Traditional) * New translations packages.md (Chinese Traditional, Hong Kong) * New translations logger.md (Urdu (Pakistan)) * New translations notifications.md (Chinese Traditional) * New translations notifications.md (Chinese Traditional, Hong Kong) * New translations notifications.md (Portuguese, Brazilian) * New translations notifications.md (Spanish) * New translations notifications.md (Urdu (Pakistan)) * New translations packages.md (Chinese Traditional) * New translations packages.md (Portuguese, Brazilian) * New translations logger.md (Portuguese, Brazilian) * New translations packages.md (Spanish) * New translations packages.md (Urdu (Pakistan)) * New translations plugins.md (Chinese Traditional) * New translations plugins.md (Chinese Traditional, Hong Kong) * New translations plugins.md (Portuguese, Brazilian) * New translations plugins.md (Spanish) * New translations plugins.md (Urdu (Pakistan)) * New translations logger.md (Spanish) * New translations logger.md (Chinese Traditional, Hong Kong) * New translations home.md (Portuguese, Brazilian) * New translations install.md (Chinese Traditional) * New translations home.md (Spanish) * New translations home.md (Urdu (Pakistan)) * New translations iis-server.md (Chinese Traditional) * New translations iis-server.md (Chinese Traditional, Hong Kong) * New translations iis-server.md (Portuguese, Brazilian) * New translations iis-server.md (Spanish) * New translations iis-server.md (Urdu (Pakistan)) * New translations install.md (Chinese Traditional, Hong Kong) * New translations logger.md (Chinese Traditional) * New translations install.md (Portuguese, Brazilian) * New translations install.md (Spanish) * New translations install.md (Urdu (Pakistan)) * New translations kubernetes.md (Chinese Traditional) * New translations kubernetes.md (Chinese Traditional, Hong Kong) * New translations kubernetes.md (Portuguese, Brazilian) * New translations kubernetes.md (Spanish) * New translations kubernetes.md (Urdu (Pakistan))
This commit is contained in:
parent
84733c100f
commit
66b2175584
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: ansible
|
id: ansible
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Installing with Ansible
|
title: Installing with Ansible
|
||||||
---
|
---
|
||||||
We have a customised solution for `verdaccio` in our organization.
|
We have a customised solution for `verdaccio` in our organization.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: authentification
|
id: authentification
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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).
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: cli
|
id: cli
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Command Line Tool
|
title: Command Line Tool
|
||||||
---
|
---
|
||||||
The verdaccio CLI is your go start the application.
|
The verdaccio CLI is your go start the application.
|
||||||
|
@ -11,7 +10,7 @@ The verdaccio CLI is your go start the application.
|
||||||
$ verdaccio --listen 4000 --config ./config.yaml
|
$ verdaccio --listen 4000 --config ./config.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
| Command | Default | Example | Description |
|
| Command | Default | Example | Description |
|
||||||
| ------------------ | ---------------------------------------- | -------------------- | ---------------------- |
|
| ------------------ | ------------------------------ | ------------- | ---------------------- |
|
||||||
| --listen \ **-l** | 4873 | -p 7000 | http port |
|
| --listen \ **-l** | 4873 | -p 7000 | http port |
|
||||||
| --config \ **-c** | ~/home/user/.local/verdaccio/config.yaml | /foo/bar/config.yaml | the configuration file |
|
| --config \ **-c** | ~/.local/verdaccio/config.yaml | ~/config.yaml | the configuration file |
|
|
@ -1,7 +1,6 @@
|
||||||
---
|
---
|
||||||
id: configuration
|
id: configuration
|
||||||
date: 2017-07-10T23:36:56.503Z
|
title: Configuration File
|
||||||
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.
|
Este archivo es la piedra angular de verdaccio donde puedes modificar su comportamiento por defecto, activar plugins y características externas.
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: contributing
|
id: contributing
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
First of all Jumping into an unfamiliar code base is not easy but we are here to help you.
|
||||||
|
@ -10,7 +9,7 @@ First of all Jumping into an unfamiliar code base is not easy but we are here to
|
||||||
If you are willing for asking, we use two channels for discussions:
|
If you are willing for asking, we use two channels for discussions:
|
||||||
|
|
||||||
* [Public Gitter channel](https://gitter.im/verdaccio/)
|
* [Public Gitter channel](https://gitter.im/verdaccio/)
|
||||||
* [Contributors Slack channel](https://verdaccio-npm.slack.com) (unfortunately only by email invitation, you might ask in Gitter to be included)
|
* [Contributors Slack channel](https://verdaccio-npm.slack.com) (unfortunately only by email invitation, you might ask in **Gitter** to be included)
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
|
@ -28,7 +27,7 @@ We have a long [list of plugins](https://github.com/verdaccio/verdaccio/blob/mas
|
||||||
|
|
||||||
### I would prefer to work in the User Interface
|
### I would prefer to work in the User Interface
|
||||||
|
|
||||||
Recently we have moved to modern techonologies as `React` and `element-react`.
|
Recently we have moved to modern techonologies as `React` and `element-react`. We are looking forward to see new ideas how to improve the UI.
|
||||||
|
|
||||||
### I feel more confortable improving the stack
|
### I feel more confortable improving the stack
|
||||||
|
|
||||||
|
@ -39,9 +38,9 @@ Here some ideas:
|
||||||
* Create a common eslint rules to be used across all dependencies or plugins
|
* Create a common eslint rules to be used across all dependencies or plugins
|
||||||
* Improve Flow types definitions delivery
|
* Improve Flow types definitions delivery
|
||||||
* Moving to Webpack 4
|
* Moving to Webpack 4
|
||||||
* Update to React 16
|
|
||||||
* Improve hot reload with Webpack
|
* Improve hot reload with Webpack
|
||||||
* We use babel and webpack across all dependencies, why not a common preset?
|
* We use babel and webpack across all dependencies, why not a common preset?
|
||||||
|
* Improve continous integration delivery
|
||||||
|
|
||||||
### I do great Documentation
|
### I do great Documentation
|
||||||
|
|
||||||
|
@ -51,12 +50,24 @@ Many contributors find typos and grammar issues, that also helps to improve the
|
||||||
|
|
||||||
We have a frontend website <http://www.verdaccio.org/> that will be happy to see your ideas.
|
We have a frontend website <http://www.verdaccio.org/> that will be happy to see your ideas.
|
||||||
|
|
||||||
|
Our website is based on [Docusaurus](https://docusaurus.io/).
|
||||||
|
|
||||||
### I am a DevOps
|
### I am a DevOps
|
||||||
|
|
||||||
We have a widely popular Docker image <https://hub.docker.com/r/verdaccio/verdaccio/> that need maintenance and pretty likely huge improvements, we need your knowledge for the benefits of all users.
|
We have a widely popular Docker image <https://hub.docker.com/r/verdaccio/verdaccio/> that need maintenance and pretty likely huge improvements, we need your knowledge for the benefits of all users.
|
||||||
|
|
||||||
We have support for **Kubernetes**, **Puppet**, **Ansible** and **Cheff** and we need help in those fields, feel free to see all repositories.
|
We have support for **Kubernetes**, **Puppet**, **Ansible** and **Cheff** and we need help in those fields, feel free to see all repositories.
|
||||||
|
|
||||||
|
### I can do translations
|
||||||
|
|
||||||
|
Verdaccio aims to be multilingual, in order to achieve it we have the awesome support of [Crowdin](https://crowdin.com) that is an amazing platform for translations.
|
||||||
|
|
||||||
|
![](https://d3n8a8pro7vhmx.cloudfront.net/uridu/pages/144/attachments/original/1485948891/Crowdin.png?1485948891 | width=100)
|
||||||
|
|
||||||
|
We have setup a project where you can choose your favourite language, if you do not find your language feel free to request one [creating a ticket](https://github.com/verdaccio/verdaccio/issues/new).
|
||||||
|
|
||||||
|
[Go to Crowdin Verdaccio](https://crowdin.com/project/verdaccio)
|
||||||
|
|
||||||
## I'm ready to contribute
|
## I'm ready to contribute
|
||||||
|
|
||||||
If you are thinking *"I've seen already the [repositories](repositories.md) and I'm willing to start right away"* then I have good news for you, that's the next step.
|
If you are thinking *"I've seen already the [repositories](repositories.md) and I'm willing to start right away"* then I have good news for you, that's the next step.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: dev-plugins
|
id: dev-plugins
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Developing Plugins
|
title: Developing Plugins
|
||||||
---
|
---
|
||||||
There are many ways to extend `verdaccio`, currently we only support `authentication plugins`
|
There are many ways to extend `verdaccio`, currently we only support `authentication plugins`
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: docker
|
id: docker
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Docker
|
title: Docker
|
||||||
---
|
---
|
||||||
To pull the latest pre-built [docker image](https://hub.docker.com/r/verdaccio/verdaccio/):
|
To pull the latest pre-built [docker image](https://hub.docker.com/r/verdaccio/verdaccio/):
|
||||||
|
@ -41,7 +40,7 @@ The Canary version (master branch) is tagged as `next`
|
||||||
docker pull verdaccio/verdaccio:next
|
docker pull verdaccio/verdaccio:next
|
||||||
```
|
```
|
||||||
|
|
||||||
# Running verdaccio using Docker
|
## Running verdaccio using Docker
|
||||||
|
|
||||||
To run the docker container:
|
To run the docker container:
|
||||||
|
|
||||||
|
@ -62,7 +61,7 @@ V_PATH=/path/for/verdaccio; docker run -it --rm --name verdaccio -p 4873:4873 \
|
||||||
verdaccio/verdaccio
|
verdaccio/verdaccio
|
||||||
```
|
```
|
||||||
|
|
||||||
## Docker and custom port configuration
|
### Docker and custom port configuration
|
||||||
|
|
||||||
Any `host:port` configured in `conf/config.yaml` under `listen` is currently ignored when using docker.
|
Any `host:port` configured in `conf/config.yaml` under `listen` is currently ignored when using docker.
|
||||||
|
|
||||||
|
@ -78,7 +77,7 @@ PORT=5000; docker run -it --rm --name verdaccio \
|
||||||
verdaccio/verdaccio
|
verdaccio/verdaccio
|
||||||
```
|
```
|
||||||
|
|
||||||
## Using HTTPS with Docker
|
### Using HTTPS with Docker
|
||||||
|
|
||||||
You can configure the protocol verdaccio is going to listen on, similarly to the port configuration. You have to overwrite the default value("http") of the `PROTOCOL` environment variable to "https", after you specified the certificates in the config.yaml.
|
You can configure the protocol verdaccio is going to listen on, similarly to the port configuration. You have to overwrite the default value("http") of the `PROTOCOL` environment variable to "https", after you specified the certificates in the config.yaml.
|
||||||
|
|
||||||
|
@ -88,7 +87,7 @@ PROTOCOL=https; docker run -it --rm --name verdaccio \
|
||||||
verdaccio/verdaccio
|
verdaccio/verdaccio
|
||||||
```
|
```
|
||||||
|
|
||||||
## Using docker-compose
|
### Using docker-compose
|
||||||
|
|
||||||
1. Get the latest version of [docker-compose](https://github.com/docker/compose).
|
1. Get the latest version of [docker-compose](https://github.com/docker/compose).
|
||||||
2. Build and run the container:
|
2. Build and run the container:
|
||||||
|
@ -114,7 +113,7 @@ Docker will generate a named volume in which to store persistent application dat
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Build your own Docker image
|
## Build your own Docker image
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker build -t verdaccio .
|
docker build -t verdaccio .
|
||||||
|
@ -136,7 +135,7 @@ npm run build:docker:rpi
|
||||||
|
|
||||||
Please note that for any of the above docker commands you need to have docker installed on your machine and the docker executable should be available on your `$PATH`.
|
Please note that for any of the above docker commands you need to have docker installed on your machine and the docker executable should be available on your `$PATH`.
|
||||||
|
|
||||||
# Docker Examples
|
## Docker Examples
|
||||||
|
|
||||||
There is a separate repository that hosts multiple configurations to compose Docker images with `verdaccio`, for instance, as reverse proxy:
|
There is a separate repository that hosts multiple configurations to compose Docker images with `verdaccio`, for instance, as reverse proxy:
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: home
|
id: home
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Verdaccio npm proxy private registry
|
title: Verdaccio npm proxy private registry
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: iss-server
|
id: iss-server
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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).
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: installation
|
id: installation
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Installation
|
title: Installation
|
||||||
---
|
---
|
||||||
Verdaccio is a multiplatform web application, to install you need at least some prerequisites.
|
Verdaccio is a multiplatform web application, to install you need at least some prerequisites.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: kubernetes
|
id: kubernetes
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: logger
|
id: logger
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Logger
|
title: Logger
|
||||||
---
|
---
|
||||||
As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs.
|
As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: notifications
|
id: notifications
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: packages
|
id: packages
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
It's a series of contrains that allow or restrict access to the local storage based in specific criteria.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: plugins
|
id: plugins
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: protect-your-dependencies
|
id: protect-your-dependencies
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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).
|
`verdaccio` allows you protect publish, to achieve that you will need to set up correctly your [packages acces](packages).
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: source-code
|
id: source-code
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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
|
`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,5 @@
|
||||||
---
|
---
|
||||||
id: reverse-proxy
|
id: reverse-proxy
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Reverse Proxy Setup
|
title: Reverse Proxy Setup
|
||||||
---
|
---
|
||||||
## Apache
|
## Apache
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: server-configuration
|
id: server-configuration
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: ssl
|
id: ssl
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
Follow this instructions to configure a SSL certificate to serve NPM registry under HTTPS.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: unit-testing
|
id: unit-testing
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Unit Testing
|
title: Unit Testing
|
||||||
---
|
---
|
||||||
All tests are split in three folders:
|
All tests are split in three folders:
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: uplinks
|
id: uplinks
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Uplinks
|
title: Uplinks
|
||||||
---
|
---
|
||||||
An *uplink* is a link with an external registry that provides acccess to external packages.
|
An *uplink* is a link with an external registry that provides acccess to external packages.
|
||||||
|
@ -24,16 +23,16 @@ uplinks:
|
||||||
|
|
||||||
You can define mutiple uplinks and each of them must have an unique name (key). They can have two properties:
|
You can define mutiple uplinks and each of them must have an unique name (key). They can have two properties:
|
||||||
|
|
||||||
| Property | Type | Required | Example | Support | Description | Default |
|
| Property | Type | Required | Example | Support | Description | Default |
|
||||||
| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | ------- |
|
| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | -------- |
|
||||||
| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | |
|
| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | npmjs |
|
||||||
| timeout | string | No | 100ms | all | set new timeout for the request | 30s |
|
| timeout | string | No | 100ms | all | set new timeout for the request | 30s |
|
||||||
| maxage | string | No | 10m | all | limit maximun failure request | 2m |
|
| maxage | string | No | 10m | all | limit maximun failure request | 2m |
|
||||||
| fail_timeout | string | No | 10m | all | defines max time when a request becomes a failure | 5m |
|
| fail_timeout | string | No | 10m | all | defines max time when a request becomes a failure | 5m |
|
||||||
| max_fails | number | No | 2 | all | limit maximun failure request | 2 |
|
| max_fails | number | No | 2 | all | limit maximun failure request | 2 |
|
||||||
| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true |
|
| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true |
|
||||||
| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\<get name process.env\>]] | >= 2.5 | assigns the header 'Authorization' see: http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules | |
|
| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\<get name process.env\>]] | >= 2.5 | assigns the header 'Authorization' see: http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules | disabled |
|
||||||
| headers | list | No | authorization: "Basic YourBase64EncodedCredentials==" | all | list of custom headers for the uplink | |
|
| headers | list | No | authorization: "Basic YourBase64EncodedCredentials==" | all | list of custom headers for the uplink | disabled |
|
||||||
|
|
||||||
### You Must know
|
### You Must know
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: use-cases
|
id: use-cases
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Use Cases
|
title: Use Cases
|
||||||
---
|
---
|
||||||
## Using private packages
|
## Using private packages
|
||||||
|
|
|
@ -1,7 +1,6 @@
|
||||||
---
|
---
|
||||||
id: webui
|
id: webui
|
||||||
date: 2017-07-10T23:36:56.503Z
|
title: Web User Interface
|
||||||
title: Interfaz Web de Usuario
|
|
||||||
---
|
---
|
||||||
Verdaccio contiene una interfaz web para mostrar paquetes privados, puede ser personalizable.
|
Verdaccio contiene una interfaz web para mostrar paquetes privados, puede ser personalizable.
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: windows
|
id: windows
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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:
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: ansible
|
id: ansible
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Installing with Ansible
|
title: Installing with Ansible
|
||||||
---
|
---
|
||||||
We have a customised solution for `verdaccio` in our organization.
|
We have a customised solution for `verdaccio` in our organization.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: authentification
|
id: authentification
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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).
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: cli
|
id: cli
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Command Line Tool
|
title: Command Line Tool
|
||||||
---
|
---
|
||||||
The verdaccio CLI is your go start the application.
|
The verdaccio CLI is your go start the application.
|
||||||
|
@ -11,7 +10,7 @@ The verdaccio CLI is your go start the application.
|
||||||
$ verdaccio --listen 4000 --config ./config.yaml
|
$ verdaccio --listen 4000 --config ./config.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
| Command | Default | Example | Description |
|
| Command | Default | Example | Description |
|
||||||
| ------------------ | ---------------------------------------- | -------------------- | ---------------------- |
|
| ------------------ | ------------------------------ | ------------- | ---------------------- |
|
||||||
| --listen \ **-l** | 4873 | -p 7000 | http port |
|
| --listen \ **-l** | 4873 | -p 7000 | http port |
|
||||||
| --config \ **-c** | ~/home/user/.local/verdaccio/config.yaml | /foo/bar/config.yaml | the configuration file |
|
| --config \ **-c** | ~/.local/verdaccio/config.yaml | ~/config.yaml | the configuration file |
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: configuration
|
id: configuration
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
This file is the cornerstone of verdaccio where you can modify the default behaviour, enable plugins and extend features.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: contributing
|
id: contributing
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
First of all Jumping into an unfamiliar code base is not easy but we are here to help you.
|
||||||
|
@ -10,7 +9,7 @@ First of all Jumping into an unfamiliar code base is not easy but we are here to
|
||||||
If you are willing for asking, we use two channels for discussions:
|
If you are willing for asking, we use two channels for discussions:
|
||||||
|
|
||||||
* [Public Gitter channel](https://gitter.im/verdaccio/)
|
* [Public Gitter channel](https://gitter.im/verdaccio/)
|
||||||
* [Contributors Slack channel](https://verdaccio-npm.slack.com) (unfortunately only by email invitation, you might ask in Gitter to be included)
|
* [Contributors Slack channel](https://verdaccio-npm.slack.com) (unfortunately only by email invitation, you might ask in **Gitter** to be included)
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
|
@ -28,7 +27,7 @@ We have a long [list of plugins](https://github.com/verdaccio/verdaccio/blob/mas
|
||||||
|
|
||||||
### I would prefer to work in the User Interface
|
### I would prefer to work in the User Interface
|
||||||
|
|
||||||
Recently we have moved to modern techonologies as `React` and `element-react`.
|
Recently we have moved to modern techonologies as `React` and `element-react`. We are looking forward to see new ideas how to improve the UI.
|
||||||
|
|
||||||
### I feel more confortable improving the stack
|
### I feel more confortable improving the stack
|
||||||
|
|
||||||
|
@ -39,9 +38,9 @@ Here some ideas:
|
||||||
* Create a common eslint rules to be used across all dependencies or plugins
|
* Create a common eslint rules to be used across all dependencies or plugins
|
||||||
* Improve Flow types definitions delivery
|
* Improve Flow types definitions delivery
|
||||||
* Moving to Webpack 4
|
* Moving to Webpack 4
|
||||||
* Update to React 16
|
|
||||||
* Improve hot reload with Webpack
|
* Improve hot reload with Webpack
|
||||||
* We use babel and webpack across all dependencies, why not a common preset?
|
* We use babel and webpack across all dependencies, why not a common preset?
|
||||||
|
* Improve continous integration delivery
|
||||||
|
|
||||||
### I do great Documentation
|
### I do great Documentation
|
||||||
|
|
||||||
|
@ -51,12 +50,24 @@ Many contributors find typos and grammar issues, that also helps to improve the
|
||||||
|
|
||||||
We have a frontend website <http://www.verdaccio.org/> that will be happy to see your ideas.
|
We have a frontend website <http://www.verdaccio.org/> that will be happy to see your ideas.
|
||||||
|
|
||||||
|
Our website is based on [Docusaurus](https://docusaurus.io/).
|
||||||
|
|
||||||
### I am a DevOps
|
### I am a DevOps
|
||||||
|
|
||||||
We have a widely popular Docker image <https://hub.docker.com/r/verdaccio/verdaccio/> that need maintenance and pretty likely huge improvements, we need your knowledge for the benefits of all users.
|
We have a widely popular Docker image <https://hub.docker.com/r/verdaccio/verdaccio/> that need maintenance and pretty likely huge improvements, we need your knowledge for the benefits of all users.
|
||||||
|
|
||||||
We have support for **Kubernetes**, **Puppet**, **Ansible** and **Cheff** and we need help in those fields, feel free to see all repositories.
|
We have support for **Kubernetes**, **Puppet**, **Ansible** and **Cheff** and we need help in those fields, feel free to see all repositories.
|
||||||
|
|
||||||
|
### I can do translations
|
||||||
|
|
||||||
|
Verdaccio aims to be multilingual, in order to achieve it we have the awesome support of [Crowdin](https://crowdin.com) that is an amazing platform for translations.
|
||||||
|
|
||||||
|
![](https://d3n8a8pro7vhmx.cloudfront.net/uridu/pages/144/attachments/original/1485948891/Crowdin.png?1485948891 | width=100)
|
||||||
|
|
||||||
|
We have setup a project where you can choose your favourite language, if you do not find your language feel free to request one [creating a ticket](https://github.com/verdaccio/verdaccio/issues/new).
|
||||||
|
|
||||||
|
[Go to Crowdin Verdaccio](https://crowdin.com/project/verdaccio)
|
||||||
|
|
||||||
## I'm ready to contribute
|
## I'm ready to contribute
|
||||||
|
|
||||||
If you are thinking *"I've seen already the [repositories](repositories.md) and I'm willing to start right away"* then I have good news for you, that's the next step.
|
If you are thinking *"I've seen already the [repositories](repositories.md) and I'm willing to start right away"* then I have good news for you, that's the next step.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: dev-plugins
|
id: dev-plugins
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Developing Plugins
|
title: Developing Plugins
|
||||||
---
|
---
|
||||||
There are many ways to extend `verdaccio`, currently we only support `authentication plugins`
|
There are many ways to extend `verdaccio`, currently we only support `authentication plugins`
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: docker
|
id: docker
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Docker
|
title: Docker
|
||||||
---
|
---
|
||||||
To pull the latest pre-built [docker image](https://hub.docker.com/r/verdaccio/verdaccio/):
|
To pull the latest pre-built [docker image](https://hub.docker.com/r/verdaccio/verdaccio/):
|
||||||
|
@ -41,7 +40,7 @@ The Canary version (master branch) is tagged as `next`
|
||||||
docker pull verdaccio/verdaccio:next
|
docker pull verdaccio/verdaccio:next
|
||||||
```
|
```
|
||||||
|
|
||||||
# Running verdaccio using Docker
|
## Running verdaccio using Docker
|
||||||
|
|
||||||
To run the docker container:
|
To run the docker container:
|
||||||
|
|
||||||
|
@ -62,7 +61,7 @@ V_PATH=/path/for/verdaccio; docker run -it --rm --name verdaccio -p 4873:4873 \
|
||||||
verdaccio/verdaccio
|
verdaccio/verdaccio
|
||||||
```
|
```
|
||||||
|
|
||||||
## Docker and custom port configuration
|
### Docker and custom port configuration
|
||||||
|
|
||||||
Any `host:port` configured in `conf/config.yaml` under `listen` is currently ignored when using docker.
|
Any `host:port` configured in `conf/config.yaml` under `listen` is currently ignored when using docker.
|
||||||
|
|
||||||
|
@ -78,7 +77,7 @@ PORT=5000; docker run -it --rm --name verdaccio \
|
||||||
verdaccio/verdaccio
|
verdaccio/verdaccio
|
||||||
```
|
```
|
||||||
|
|
||||||
## Using HTTPS with Docker
|
### Using HTTPS with Docker
|
||||||
|
|
||||||
You can configure the protocol verdaccio is going to listen on, similarly to the port configuration. You have to overwrite the default value("http") of the `PROTOCOL` environment variable to "https", after you specified the certificates in the config.yaml.
|
You can configure the protocol verdaccio is going to listen on, similarly to the port configuration. You have to overwrite the default value("http") of the `PROTOCOL` environment variable to "https", after you specified the certificates in the config.yaml.
|
||||||
|
|
||||||
|
@ -88,7 +87,7 @@ PROTOCOL=https; docker run -it --rm --name verdaccio \
|
||||||
verdaccio/verdaccio
|
verdaccio/verdaccio
|
||||||
```
|
```
|
||||||
|
|
||||||
## Using docker-compose
|
### Using docker-compose
|
||||||
|
|
||||||
1. Get the latest version of [docker-compose](https://github.com/docker/compose).
|
1. Get the latest version of [docker-compose](https://github.com/docker/compose).
|
||||||
2. Build and run the container:
|
2. Build and run the container:
|
||||||
|
@ -114,7 +113,7 @@ Docker will generate a named volume in which to store persistent application dat
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Build your own Docker image
|
## Build your own Docker image
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker build -t verdaccio .
|
docker build -t verdaccio .
|
||||||
|
@ -136,7 +135,7 @@ npm run build:docker:rpi
|
||||||
|
|
||||||
Please note that for any of the above docker commands you need to have docker installed on your machine and the docker executable should be available on your `$PATH`.
|
Please note that for any of the above docker commands you need to have docker installed on your machine and the docker executable should be available on your `$PATH`.
|
||||||
|
|
||||||
# Docker Examples
|
## Docker Examples
|
||||||
|
|
||||||
There is a separate repository that hosts multiple configurations to compose Docker images with `verdaccio`, for instance, as reverse proxy:
|
There is a separate repository that hosts multiple configurations to compose Docker images with `verdaccio`, for instance, as reverse proxy:
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: home
|
id: home
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Verdaccio npm proxy private registry
|
title: Verdaccio npm proxy private registry
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: iss-server
|
id: iss-server
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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).
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: installation
|
id: installation
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Installation
|
title: Installation
|
||||||
---
|
---
|
||||||
Verdaccio is a multiplatform web application, to install you need at least some prerequisites.
|
Verdaccio is a multiplatform web application, to install you need at least some prerequisites.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: kubernetes
|
id: kubernetes
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: logger
|
id: logger
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Logger
|
title: Logger
|
||||||
---
|
---
|
||||||
As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs.
|
As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: notifications
|
id: notifications
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: packages
|
id: packages
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
It's a series of contrains that allow or restrict access to the local storage based in specific criteria.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: plugins
|
id: plugins
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: protect-your-dependencies
|
id: protect-your-dependencies
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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).
|
`verdaccio` allows you protect publish, to achieve that you will need to set up correctly your [packages acces](packages).
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: source-code
|
id: source-code
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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
|
`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,5 @@
|
||||||
---
|
---
|
||||||
id: reverse-proxy
|
id: reverse-proxy
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Reverse Proxy Setup
|
title: Reverse Proxy Setup
|
||||||
---
|
---
|
||||||
## Apache
|
## Apache
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: server-configuration
|
id: server-configuration
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: ssl
|
id: ssl
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
Follow this instructions to configure a SSL certificate to serve NPM registry under HTTPS.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: unit-testing
|
id: unit-testing
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Unit Testing
|
title: Unit Testing
|
||||||
---
|
---
|
||||||
All tests are split in three folders:
|
All tests are split in three folders:
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: uplinks
|
id: uplinks
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Uplinks
|
title: Uplinks
|
||||||
---
|
---
|
||||||
An *uplink* is a link with an external registry that provides acccess to external packages.
|
An *uplink* is a link with an external registry that provides acccess to external packages.
|
||||||
|
@ -24,16 +23,16 @@ uplinks:
|
||||||
|
|
||||||
You can define mutiple uplinks and each of them must have an unique name (key). They can have two properties:
|
You can define mutiple uplinks and each of them must have an unique name (key). They can have two properties:
|
||||||
|
|
||||||
| Property | Type | Required | Example | Support | Description | Default |
|
| Property | Type | Required | Example | Support | Description | Default |
|
||||||
| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | ------- |
|
| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | -------- |
|
||||||
| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | |
|
| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | npmjs |
|
||||||
| timeout | string | No | 100ms | all | set new timeout for the request | 30s |
|
| timeout | string | No | 100ms | all | set new timeout for the request | 30s |
|
||||||
| maxage | string | No | 10m | all | limit maximun failure request | 2m |
|
| maxage | string | No | 10m | all | limit maximun failure request | 2m |
|
||||||
| fail_timeout | string | No | 10m | all | defines max time when a request becomes a failure | 5m |
|
| fail_timeout | string | No | 10m | all | defines max time when a request becomes a failure | 5m |
|
||||||
| max_fails | number | No | 2 | all | limit maximun failure request | 2 |
|
| max_fails | number | No | 2 | all | limit maximun failure request | 2 |
|
||||||
| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true |
|
| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true |
|
||||||
| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\<get name process.env\>]] | >= 2.5 | assigns the header 'Authorization' see: http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules | |
|
| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\<get name process.env\>]] | >= 2.5 | assigns the header 'Authorization' see: http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules | disabled |
|
||||||
| headers | list | No | authorization: "Basic YourBase64EncodedCredentials==" | all | list of custom headers for the uplink | |
|
| headers | list | No | authorization: "Basic YourBase64EncodedCredentials==" | all | list of custom headers for the uplink | disabled |
|
||||||
|
|
||||||
### You Must know
|
### You Must know
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: use-cases
|
id: use-cases
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Use Cases
|
title: Use Cases
|
||||||
---
|
---
|
||||||
## Using private packages
|
## Using private packages
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: webui
|
id: webui
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Web User Interface
|
title: Web User Interface
|
||||||
---
|
---
|
||||||
Verdaccio has a web user interface to display only the private packges and can be customisable.
|
Verdaccio has a web user interface to display only the private packges and can be customisable.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: windows
|
id: windows
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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:
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: ansible
|
id: ansible
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Installing with Ansible
|
title: Installing with Ansible
|
||||||
---
|
---
|
||||||
We have a customised solution for `verdaccio` in our organization.
|
We have a customised solution for `verdaccio` in our organization.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: authentification
|
id: authentification
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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).
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: cli
|
id: cli
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Command Line Tool
|
title: Command Line Tool
|
||||||
---
|
---
|
||||||
The verdaccio CLI is your go start the application.
|
The verdaccio CLI is your go start the application.
|
||||||
|
@ -11,7 +10,7 @@ The verdaccio CLI is your go start the application.
|
||||||
$ verdaccio --listen 4000 --config ./config.yaml
|
$ verdaccio --listen 4000 --config ./config.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
| Command | Default | Example | Description |
|
| Command | Default | Example | Description |
|
||||||
| ------------------ | ---------------------------------------- | -------------------- | ---------------------- |
|
| ------------------ | ------------------------------ | ------------- | ---------------------- |
|
||||||
| --listen \ **-l** | 4873 | -p 7000 | http port |
|
| --listen \ **-l** | 4873 | -p 7000 | http port |
|
||||||
| --config \ **-c** | ~/home/user/.local/verdaccio/config.yaml | /foo/bar/config.yaml | the configuration file |
|
| --config \ **-c** | ~/.local/verdaccio/config.yaml | ~/config.yaml | the configuration file |
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: configuration
|
id: configuration
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
This file is the cornerstone of verdaccio where you can modify the default behaviour, enable plugins and extend features.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: contributing
|
id: contributing
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
First of all Jumping into an unfamiliar code base is not easy but we are here to help you.
|
||||||
|
@ -10,7 +9,7 @@ First of all Jumping into an unfamiliar code base is not easy but we are here to
|
||||||
If you are willing for asking, we use two channels for discussions:
|
If you are willing for asking, we use two channels for discussions:
|
||||||
|
|
||||||
* [Public Gitter channel](https://gitter.im/verdaccio/)
|
* [Public Gitter channel](https://gitter.im/verdaccio/)
|
||||||
* [Contributors Slack channel](https://verdaccio-npm.slack.com) (unfortunately only by email invitation, you might ask in Gitter to be included)
|
* [Contributors Slack channel](https://verdaccio-npm.slack.com) (unfortunately only by email invitation, you might ask in **Gitter** to be included)
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
|
@ -28,7 +27,7 @@ We have a long [list of plugins](https://github.com/verdaccio/verdaccio/blob/mas
|
||||||
|
|
||||||
### I would prefer to work in the User Interface
|
### I would prefer to work in the User Interface
|
||||||
|
|
||||||
Recently we have moved to modern techonologies as `React` and `element-react`.
|
Recently we have moved to modern techonologies as `React` and `element-react`. We are looking forward to see new ideas how to improve the UI.
|
||||||
|
|
||||||
### I feel more confortable improving the stack
|
### I feel more confortable improving the stack
|
||||||
|
|
||||||
|
@ -39,9 +38,9 @@ Here some ideas:
|
||||||
* Create a common eslint rules to be used across all dependencies or plugins
|
* Create a common eslint rules to be used across all dependencies or plugins
|
||||||
* Improve Flow types definitions delivery
|
* Improve Flow types definitions delivery
|
||||||
* Moving to Webpack 4
|
* Moving to Webpack 4
|
||||||
* Update to React 16
|
|
||||||
* Improve hot reload with Webpack
|
* Improve hot reload with Webpack
|
||||||
* We use babel and webpack across all dependencies, why not a common preset?
|
* We use babel and webpack across all dependencies, why not a common preset?
|
||||||
|
* Improve continous integration delivery
|
||||||
|
|
||||||
### I do great Documentation
|
### I do great Documentation
|
||||||
|
|
||||||
|
@ -51,12 +50,24 @@ Many contributors find typos and grammar issues, that also helps to improve the
|
||||||
|
|
||||||
We have a frontend website <http://www.verdaccio.org/> that will be happy to see your ideas.
|
We have a frontend website <http://www.verdaccio.org/> that will be happy to see your ideas.
|
||||||
|
|
||||||
|
Our website is based on [Docusaurus](https://docusaurus.io/).
|
||||||
|
|
||||||
### I am a DevOps
|
### I am a DevOps
|
||||||
|
|
||||||
We have a widely popular Docker image <https://hub.docker.com/r/verdaccio/verdaccio/> that need maintenance and pretty likely huge improvements, we need your knowledge for the benefits of all users.
|
We have a widely popular Docker image <https://hub.docker.com/r/verdaccio/verdaccio/> that need maintenance and pretty likely huge improvements, we need your knowledge for the benefits of all users.
|
||||||
|
|
||||||
We have support for **Kubernetes**, **Puppet**, **Ansible** and **Cheff** and we need help in those fields, feel free to see all repositories.
|
We have support for **Kubernetes**, **Puppet**, **Ansible** and **Cheff** and we need help in those fields, feel free to see all repositories.
|
||||||
|
|
||||||
|
### I can do translations
|
||||||
|
|
||||||
|
Verdaccio aims to be multilingual, in order to achieve it we have the awesome support of [Crowdin](https://crowdin.com) that is an amazing platform for translations.
|
||||||
|
|
||||||
|
![](https://d3n8a8pro7vhmx.cloudfront.net/uridu/pages/144/attachments/original/1485948891/Crowdin.png?1485948891 | width=100)
|
||||||
|
|
||||||
|
We have setup a project where you can choose your favourite language, if you do not find your language feel free to request one [creating a ticket](https://github.com/verdaccio/verdaccio/issues/new).
|
||||||
|
|
||||||
|
[Go to Crowdin Verdaccio](https://crowdin.com/project/verdaccio)
|
||||||
|
|
||||||
## I'm ready to contribute
|
## I'm ready to contribute
|
||||||
|
|
||||||
If you are thinking *"I've seen already the [repositories](repositories.md) and I'm willing to start right away"* then I have good news for you, that's the next step.
|
If you are thinking *"I've seen already the [repositories](repositories.md) and I'm willing to start right away"* then I have good news for you, that's the next step.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: dev-plugins
|
id: dev-plugins
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Developing Plugins
|
title: Developing Plugins
|
||||||
---
|
---
|
||||||
There are many ways to extend `verdaccio`, currently we only support `authentication plugins`
|
There are many ways to extend `verdaccio`, currently we only support `authentication plugins`
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: docker
|
id: docker
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Docker
|
title: Docker
|
||||||
---
|
---
|
||||||
To pull the latest pre-built [docker image](https://hub.docker.com/r/verdaccio/verdaccio/):
|
To pull the latest pre-built [docker image](https://hub.docker.com/r/verdaccio/verdaccio/):
|
||||||
|
@ -41,7 +40,7 @@ The Canary version (master branch) is tagged as `next`
|
||||||
docker pull verdaccio/verdaccio:next
|
docker pull verdaccio/verdaccio:next
|
||||||
```
|
```
|
||||||
|
|
||||||
# Running verdaccio using Docker
|
## Running verdaccio using Docker
|
||||||
|
|
||||||
To run the docker container:
|
To run the docker container:
|
||||||
|
|
||||||
|
@ -62,7 +61,7 @@ V_PATH=/path/for/verdaccio; docker run -it --rm --name verdaccio -p 4873:4873 \
|
||||||
verdaccio/verdaccio
|
verdaccio/verdaccio
|
||||||
```
|
```
|
||||||
|
|
||||||
## Docker and custom port configuration
|
### Docker and custom port configuration
|
||||||
|
|
||||||
Any `host:port` configured in `conf/config.yaml` under `listen` is currently ignored when using docker.
|
Any `host:port` configured in `conf/config.yaml` under `listen` is currently ignored when using docker.
|
||||||
|
|
||||||
|
@ -78,7 +77,7 @@ PORT=5000; docker run -it --rm --name verdaccio \
|
||||||
verdaccio/verdaccio
|
verdaccio/verdaccio
|
||||||
```
|
```
|
||||||
|
|
||||||
## Using HTTPS with Docker
|
### Using HTTPS with Docker
|
||||||
|
|
||||||
You can configure the protocol verdaccio is going to listen on, similarly to the port configuration. You have to overwrite the default value("http") of the `PROTOCOL` environment variable to "https", after you specified the certificates in the config.yaml.
|
You can configure the protocol verdaccio is going to listen on, similarly to the port configuration. You have to overwrite the default value("http") of the `PROTOCOL` environment variable to "https", after you specified the certificates in the config.yaml.
|
||||||
|
|
||||||
|
@ -88,7 +87,7 @@ PROTOCOL=https; docker run -it --rm --name verdaccio \
|
||||||
verdaccio/verdaccio
|
verdaccio/verdaccio
|
||||||
```
|
```
|
||||||
|
|
||||||
## Using docker-compose
|
### Using docker-compose
|
||||||
|
|
||||||
1. Get the latest version of [docker-compose](https://github.com/docker/compose).
|
1. Get the latest version of [docker-compose](https://github.com/docker/compose).
|
||||||
2. Build and run the container:
|
2. Build and run the container:
|
||||||
|
@ -114,7 +113,7 @@ Docker will generate a named volume in which to store persistent application dat
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Build your own Docker image
|
## Build your own Docker image
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker build -t verdaccio .
|
docker build -t verdaccio .
|
||||||
|
@ -136,7 +135,7 @@ npm run build:docker:rpi
|
||||||
|
|
||||||
Please note that for any of the above docker commands you need to have docker installed on your machine and the docker executable should be available on your `$PATH`.
|
Please note that for any of the above docker commands you need to have docker installed on your machine and the docker executable should be available on your `$PATH`.
|
||||||
|
|
||||||
# Docker Examples
|
## Docker Examples
|
||||||
|
|
||||||
There is a separate repository that hosts multiple configurations to compose Docker images with `verdaccio`, for instance, as reverse proxy:
|
There is a separate repository that hosts multiple configurations to compose Docker images with `verdaccio`, for instance, as reverse proxy:
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: home
|
id: home
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Verdaccio npm proxy private registry
|
title: Verdaccio npm proxy private registry
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: iss-server
|
id: iss-server
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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).
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: installation
|
id: installation
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Installation
|
title: Installation
|
||||||
---
|
---
|
||||||
Verdaccio is a multiplatform web application, to install you need at least some prerequisites.
|
Verdaccio is a multiplatform web application, to install you need at least some prerequisites.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: kubernetes
|
id: kubernetes
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: logger
|
id: logger
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Logger
|
title: Logger
|
||||||
---
|
---
|
||||||
As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs.
|
As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: notifications
|
id: notifications
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: packages
|
id: packages
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
It's a series of contrains that allow or restrict access to the local storage based in specific criteria.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: plugins
|
id: plugins
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: protect-your-dependencies
|
id: protect-your-dependencies
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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).
|
`verdaccio` allows you protect publish, to achieve that you will need to set up correctly your [packages acces](packages).
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: source-code
|
id: source-code
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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
|
`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,5 @@
|
||||||
---
|
---
|
||||||
id: reverse-proxy
|
id: reverse-proxy
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Reverse Proxy Setup
|
title: Reverse Proxy Setup
|
||||||
---
|
---
|
||||||
## Apache
|
## Apache
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: server-configuration
|
id: server-configuration
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: ssl
|
id: ssl
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
Follow this instructions to configure a SSL certificate to serve NPM registry under HTTPS.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: unit-testing
|
id: unit-testing
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Unit Testing
|
title: Unit Testing
|
||||||
---
|
---
|
||||||
All tests are split in three folders:
|
All tests are split in three folders:
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: uplinks
|
id: uplinks
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Uplinks
|
title: Uplinks
|
||||||
---
|
---
|
||||||
An *uplink* is a link with an external registry that provides acccess to external packages.
|
An *uplink* is a link with an external registry that provides acccess to external packages.
|
||||||
|
@ -24,16 +23,16 @@ uplinks:
|
||||||
|
|
||||||
You can define mutiple uplinks and each of them must have an unique name (key). They can have two properties:
|
You can define mutiple uplinks and each of them must have an unique name (key). They can have two properties:
|
||||||
|
|
||||||
| Property | Type | Required | Example | Support | Description | Default |
|
| Property | Type | Required | Example | Support | Description | Default |
|
||||||
| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | ------- |
|
| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | -------- |
|
||||||
| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | |
|
| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | npmjs |
|
||||||
| timeout | string | No | 100ms | all | set new timeout for the request | 30s |
|
| timeout | string | No | 100ms | all | set new timeout for the request | 30s |
|
||||||
| maxage | string | No | 10m | all | limit maximun failure request | 2m |
|
| maxage | string | No | 10m | all | limit maximun failure request | 2m |
|
||||||
| fail_timeout | string | No | 10m | all | defines max time when a request becomes a failure | 5m |
|
| fail_timeout | string | No | 10m | all | defines max time when a request becomes a failure | 5m |
|
||||||
| max_fails | number | No | 2 | all | limit maximun failure request | 2 |
|
| max_fails | number | No | 2 | all | limit maximun failure request | 2 |
|
||||||
| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true |
|
| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true |
|
||||||
| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\<get name process.env\>]] | >= 2.5 | assigns the header 'Authorization' see: http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules | |
|
| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\<get name process.env\>]] | >= 2.5 | assigns the header 'Authorization' see: http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules | disabled |
|
||||||
| headers | list | No | authorization: "Basic YourBase64EncodedCredentials==" | all | list of custom headers for the uplink | |
|
| headers | list | No | authorization: "Basic YourBase64EncodedCredentials==" | all | list of custom headers for the uplink | disabled |
|
||||||
|
|
||||||
### You Must know
|
### You Must know
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: use-cases
|
id: use-cases
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Use Cases
|
title: Use Cases
|
||||||
---
|
---
|
||||||
## Using private packages
|
## Using private packages
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: webui
|
id: webui
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Web User Interface
|
title: Web User Interface
|
||||||
---
|
---
|
||||||
Verdaccio has a web user interface to display only the private packges and can be customisable.
|
Verdaccio has a web user interface to display only the private packges and can be customisable.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: windows
|
id: windows
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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:
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: ansible
|
id: ansible
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Installing with Ansible
|
title: Installing with Ansible
|
||||||
---
|
---
|
||||||
We have a customised solution for `verdaccio` in our organization.
|
We have a customised solution for `verdaccio` in our organization.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: authentification
|
id: authentification
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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).
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: cli
|
id: cli
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Command Line Tool
|
title: Command Line Tool
|
||||||
---
|
---
|
||||||
The verdaccio CLI is your go start the application.
|
The verdaccio CLI is your go start the application.
|
||||||
|
@ -11,7 +10,7 @@ The verdaccio CLI is your go start the application.
|
||||||
$ verdaccio --listen 4000 --config ./config.yaml
|
$ verdaccio --listen 4000 --config ./config.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
| Command | Default | Example | Description |
|
| Command | Default | Example | Description |
|
||||||
| ------------------ | ---------------------------------------- | -------------------- | ---------------------- |
|
| ------------------ | ------------------------------ | ------------- | ---------------------- |
|
||||||
| --listen \ **-l** | 4873 | -p 7000 | http port |
|
| --listen \ **-l** | 4873 | -p 7000 | http port |
|
||||||
| --config \ **-c** | ~/home/user/.local/verdaccio/config.yaml | /foo/bar/config.yaml | the configuration file |
|
| --config \ **-c** | ~/.local/verdaccio/config.yaml | ~/config.yaml | the configuration file |
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: configuration
|
id: configuration
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
This file is the cornerstone of verdaccio where you can modify the default behaviour, enable plugins and extend features.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: contributing
|
id: contributing
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
First of all Jumping into an unfamiliar code base is not easy but we are here to help you.
|
||||||
|
@ -10,7 +9,7 @@ First of all Jumping into an unfamiliar code base is not easy but we are here to
|
||||||
If you are willing for asking, we use two channels for discussions:
|
If you are willing for asking, we use two channels for discussions:
|
||||||
|
|
||||||
* [Public Gitter channel](https://gitter.im/verdaccio/)
|
* [Public Gitter channel](https://gitter.im/verdaccio/)
|
||||||
* [Contributors Slack channel](https://verdaccio-npm.slack.com) (unfortunately only by email invitation, you might ask in Gitter to be included)
|
* [Contributors Slack channel](https://verdaccio-npm.slack.com) (unfortunately only by email invitation, you might ask in **Gitter** to be included)
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
|
@ -28,7 +27,7 @@ We have a long [list of plugins](https://github.com/verdaccio/verdaccio/blob/mas
|
||||||
|
|
||||||
### I would prefer to work in the User Interface
|
### I would prefer to work in the User Interface
|
||||||
|
|
||||||
Recently we have moved to modern techonologies as `React` and `element-react`.
|
Recently we have moved to modern techonologies as `React` and `element-react`. We are looking forward to see new ideas how to improve the UI.
|
||||||
|
|
||||||
### I feel more confortable improving the stack
|
### I feel more confortable improving the stack
|
||||||
|
|
||||||
|
@ -39,9 +38,9 @@ Here some ideas:
|
||||||
* Create a common eslint rules to be used across all dependencies or plugins
|
* Create a common eslint rules to be used across all dependencies or plugins
|
||||||
* Improve Flow types definitions delivery
|
* Improve Flow types definitions delivery
|
||||||
* Moving to Webpack 4
|
* Moving to Webpack 4
|
||||||
* Update to React 16
|
|
||||||
* Improve hot reload with Webpack
|
* Improve hot reload with Webpack
|
||||||
* We use babel and webpack across all dependencies, why not a common preset?
|
* We use babel and webpack across all dependencies, why not a common preset?
|
||||||
|
* Improve continous integration delivery
|
||||||
|
|
||||||
### I do great Documentation
|
### I do great Documentation
|
||||||
|
|
||||||
|
@ -51,12 +50,24 @@ Many contributors find typos and grammar issues, that also helps to improve the
|
||||||
|
|
||||||
We have a frontend website <http://www.verdaccio.org/> that will be happy to see your ideas.
|
We have a frontend website <http://www.verdaccio.org/> that will be happy to see your ideas.
|
||||||
|
|
||||||
|
Our website is based on [Docusaurus](https://docusaurus.io/).
|
||||||
|
|
||||||
### I am a DevOps
|
### I am a DevOps
|
||||||
|
|
||||||
We have a widely popular Docker image <https://hub.docker.com/r/verdaccio/verdaccio/> that need maintenance and pretty likely huge improvements, we need your knowledge for the benefits of all users.
|
We have a widely popular Docker image <https://hub.docker.com/r/verdaccio/verdaccio/> that need maintenance and pretty likely huge improvements, we need your knowledge for the benefits of all users.
|
||||||
|
|
||||||
We have support for **Kubernetes**, **Puppet**, **Ansible** and **Cheff** and we need help in those fields, feel free to see all repositories.
|
We have support for **Kubernetes**, **Puppet**, **Ansible** and **Cheff** and we need help in those fields, feel free to see all repositories.
|
||||||
|
|
||||||
|
### I can do translations
|
||||||
|
|
||||||
|
Verdaccio aims to be multilingual, in order to achieve it we have the awesome support of [Crowdin](https://crowdin.com) that is an amazing platform for translations.
|
||||||
|
|
||||||
|
![](https://d3n8a8pro7vhmx.cloudfront.net/uridu/pages/144/attachments/original/1485948891/Crowdin.png?1485948891 | width=100)
|
||||||
|
|
||||||
|
We have setup a project where you can choose your favourite language, if you do not find your language feel free to request one [creating a ticket](https://github.com/verdaccio/verdaccio/issues/new).
|
||||||
|
|
||||||
|
[Go to Crowdin Verdaccio](https://crowdin.com/project/verdaccio)
|
||||||
|
|
||||||
## I'm ready to contribute
|
## I'm ready to contribute
|
||||||
|
|
||||||
If you are thinking *"I've seen already the [repositories](repositories.md) and I'm willing to start right away"* then I have good news for you, that's the next step.
|
If you are thinking *"I've seen already the [repositories](repositories.md) and I'm willing to start right away"* then I have good news for you, that's the next step.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: dev-plugins
|
id: dev-plugins
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Developing Plugins
|
title: Developing Plugins
|
||||||
---
|
---
|
||||||
There are many ways to extend `verdaccio`, currently we only support `authentication plugins`
|
There are many ways to extend `verdaccio`, currently we only support `authentication plugins`
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: docker
|
id: docker
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Docker
|
title: Docker
|
||||||
---
|
---
|
||||||
To pull the latest pre-built [docker image](https://hub.docker.com/r/verdaccio/verdaccio/):
|
To pull the latest pre-built [docker image](https://hub.docker.com/r/verdaccio/verdaccio/):
|
||||||
|
@ -41,7 +40,7 @@ The Canary version (master branch) is tagged as `next`
|
||||||
docker pull verdaccio/verdaccio:next
|
docker pull verdaccio/verdaccio:next
|
||||||
```
|
```
|
||||||
|
|
||||||
# Running verdaccio using Docker
|
## Running verdaccio using Docker
|
||||||
|
|
||||||
To run the docker container:
|
To run the docker container:
|
||||||
|
|
||||||
|
@ -62,7 +61,7 @@ V_PATH=/path/for/verdaccio; docker run -it --rm --name verdaccio -p 4873:4873 \
|
||||||
verdaccio/verdaccio
|
verdaccio/verdaccio
|
||||||
```
|
```
|
||||||
|
|
||||||
## Docker and custom port configuration
|
### Docker and custom port configuration
|
||||||
|
|
||||||
Any `host:port` configured in `conf/config.yaml` under `listen` is currently ignored when using docker.
|
Any `host:port` configured in `conf/config.yaml` under `listen` is currently ignored when using docker.
|
||||||
|
|
||||||
|
@ -78,7 +77,7 @@ PORT=5000; docker run -it --rm --name verdaccio \
|
||||||
verdaccio/verdaccio
|
verdaccio/verdaccio
|
||||||
```
|
```
|
||||||
|
|
||||||
## Using HTTPS with Docker
|
### Using HTTPS with Docker
|
||||||
|
|
||||||
You can configure the protocol verdaccio is going to listen on, similarly to the port configuration. You have to overwrite the default value("http") of the `PROTOCOL` environment variable to "https", after you specified the certificates in the config.yaml.
|
You can configure the protocol verdaccio is going to listen on, similarly to the port configuration. You have to overwrite the default value("http") of the `PROTOCOL` environment variable to "https", after you specified the certificates in the config.yaml.
|
||||||
|
|
||||||
|
@ -88,7 +87,7 @@ PROTOCOL=https; docker run -it --rm --name verdaccio \
|
||||||
verdaccio/verdaccio
|
verdaccio/verdaccio
|
||||||
```
|
```
|
||||||
|
|
||||||
## Using docker-compose
|
### Using docker-compose
|
||||||
|
|
||||||
1. Get the latest version of [docker-compose](https://github.com/docker/compose).
|
1. Get the latest version of [docker-compose](https://github.com/docker/compose).
|
||||||
2. Build and run the container:
|
2. Build and run the container:
|
||||||
|
@ -114,7 +113,7 @@ Docker will generate a named volume in which to store persistent application dat
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Build your own Docker image
|
## Build your own Docker image
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker build -t verdaccio .
|
docker build -t verdaccio .
|
||||||
|
@ -136,7 +135,7 @@ npm run build:docker:rpi
|
||||||
|
|
||||||
Please note that for any of the above docker commands you need to have docker installed on your machine and the docker executable should be available on your `$PATH`.
|
Please note that for any of the above docker commands you need to have docker installed on your machine and the docker executable should be available on your `$PATH`.
|
||||||
|
|
||||||
# Docker Examples
|
## Docker Examples
|
||||||
|
|
||||||
There is a separate repository that hosts multiple configurations to compose Docker images with `verdaccio`, for instance, as reverse proxy:
|
There is a separate repository that hosts multiple configurations to compose Docker images with `verdaccio`, for instance, as reverse proxy:
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: home
|
id: home
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Verdaccio npm proxy private registry
|
title: Verdaccio npm proxy private registry
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: iss-server
|
id: iss-server
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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).
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: installation
|
id: installation
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Installation
|
title: Installation
|
||||||
---
|
---
|
||||||
Verdaccio is a multiplatform web application, to install you need at least some prerequisites.
|
Verdaccio is a multiplatform web application, to install you need at least some prerequisites.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: kubernetes
|
id: kubernetes
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: logger
|
id: logger
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Logger
|
title: Logger
|
||||||
---
|
---
|
||||||
As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs.
|
As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: notifications
|
id: notifications
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: packages
|
id: packages
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
It's a series of contrains that allow or restrict access to the local storage based in specific criteria.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: plugins
|
id: plugins
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: protect-your-dependencies
|
id: protect-your-dependencies
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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).
|
`verdaccio` allows you protect publish, to achieve that you will need to set up correctly your [packages acces](packages).
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: source-code
|
id: source-code
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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
|
`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,5 @@
|
||||||
---
|
---
|
||||||
id: reverse-proxy
|
id: reverse-proxy
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Reverse Proxy Setup
|
title: Reverse Proxy Setup
|
||||||
---
|
---
|
||||||
## Apache
|
## Apache
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: server-configuration
|
id: server-configuration
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
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,5 @@
|
||||||
---
|
---
|
||||||
id: ssl
|
id: ssl
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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.
|
Follow this instructions to configure a SSL certificate to serve NPM registry under HTTPS.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: unit-testing
|
id: unit-testing
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Unit Testing
|
title: Unit Testing
|
||||||
---
|
---
|
||||||
All tests are split in three folders:
|
All tests are split in three folders:
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: uplinks
|
id: uplinks
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Uplinks
|
title: Uplinks
|
||||||
---
|
---
|
||||||
An *uplink* is a link with an external registry that provides acccess to external packages.
|
An *uplink* is a link with an external registry that provides acccess to external packages.
|
||||||
|
@ -24,16 +23,16 @@ uplinks:
|
||||||
|
|
||||||
You can define mutiple uplinks and each of them must have an unique name (key). They can have two properties:
|
You can define mutiple uplinks and each of them must have an unique name (key). They can have two properties:
|
||||||
|
|
||||||
| Property | Type | Required | Example | Support | Description | Default |
|
| Property | Type | Required | Example | Support | Description | Default |
|
||||||
| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | ------- |
|
| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | -------- |
|
||||||
| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | |
|
| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | npmjs |
|
||||||
| timeout | string | No | 100ms | all | set new timeout for the request | 30s |
|
| timeout | string | No | 100ms | all | set new timeout for the request | 30s |
|
||||||
| maxage | string | No | 10m | all | limit maximun failure request | 2m |
|
| maxage | string | No | 10m | all | limit maximun failure request | 2m |
|
||||||
| fail_timeout | string | No | 10m | all | defines max time when a request becomes a failure | 5m |
|
| fail_timeout | string | No | 10m | all | defines max time when a request becomes a failure | 5m |
|
||||||
| max_fails | number | No | 2 | all | limit maximun failure request | 2 |
|
| max_fails | number | No | 2 | all | limit maximun failure request | 2 |
|
||||||
| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true |
|
| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true |
|
||||||
| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\<get name process.env\>]] | >= 2.5 | assigns the header 'Authorization' see: http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules | |
|
| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\<get name process.env\>]] | >= 2.5 | assigns the header 'Authorization' see: http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules | disabled |
|
||||||
| headers | list | No | authorization: "Basic YourBase64EncodedCredentials==" | all | list of custom headers for the uplink | |
|
| headers | list | No | authorization: "Basic YourBase64EncodedCredentials==" | all | list of custom headers for the uplink | disabled |
|
||||||
|
|
||||||
### You Must know
|
### You Must know
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: use-cases
|
id: use-cases
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Use Cases
|
title: Use Cases
|
||||||
---
|
---
|
||||||
## Using private packages
|
## Using private packages
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: webui
|
id: webui
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
title: Web User Interface
|
title: Web User Interface
|
||||||
---
|
---
|
||||||
Verdaccio has a web user interface to display only the private packges and can be customisable.
|
Verdaccio has a web user interface to display only the private packges and can be customisable.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
id: windows
|
id: windows
|
||||||
date: 2017-07-10T23:36:56.503Z
|
|
||||||
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:
|
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:
|
||||||
|
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue