diff --git a/website/translated_docs/es-ES/ansible.md b/website/translated_docs/es-ES/ansible.md index 5a01c3f9a..a198dc20e 100644 --- a/website/translated_docs/es-ES/ansible.md +++ b/website/translated_docs/es-ES/ansible.md @@ -1,6 +1,5 @@ --- id: ansible -date: 2017-07-10T23:36:56.503Z title: Installing with Ansible --- We have a customised solution for `verdaccio` in our organization. diff --git a/website/translated_docs/es-ES/auth.md b/website/translated_docs/es-ES/auth.md index 77d83ce0b..ca09f4a5e 100644 --- a/website/translated_docs/es-ES/auth.md +++ b/website/translated_docs/es-ES/auth.md @@ -1,6 +1,5 @@ --- id: authentification -date: 2017-07-10T23:36:56.503Z 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). diff --git a/website/translated_docs/es-ES/cli.md b/website/translated_docs/es-ES/cli.md index 71da2790b..4b8cf3371 100644 --- a/website/translated_docs/es-ES/cli.md +++ b/website/translated_docs/es-ES/cli.md @@ -1,6 +1,5 @@ --- id: cli -date: 2017-07-10T23:36:56.503Z title: Command Line Tool --- 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 ``` -| Command | Default | Example | Description | -| ------------------ | ---------------------------------------- | -------------------- | ---------------------- | -| --listen \ **-l** | 4873 | -p 7000 | http port | -| --config \ **-c** | ~/home/user/.local/verdaccio/config.yaml | /foo/bar/config.yaml | the configuration file | \ No newline at end of file +| Command | Default | Example | Description | +| ------------------ | ------------------------------ | ------------- | ---------------------- | +| --listen \ **-l** | 4873 | -p 7000 | http port | +| --config \ **-c** | ~/.local/verdaccio/config.yaml | ~/config.yaml | the configuration file | \ No newline at end of file diff --git a/website/translated_docs/es-ES/config.md b/website/translated_docs/es-ES/config.md index fa301aa95..e6ebc8378 100644 --- a/website/translated_docs/es-ES/config.md +++ b/website/translated_docs/es-ES/config.md @@ -1,7 +1,6 @@ --- id: configuration -date: 2017-07-10T23:36:56.503Z -title: Archivo de Configuración +title: Configuration File --- Este archivo es la piedra angular de verdaccio donde puedes modificar su comportamiento por defecto, activar plugins y características externas. diff --git a/website/translated_docs/es-ES/contributing.md b/website/translated_docs/es-ES/contributing.md index 8b31b1029..b834509cc 100644 --- a/website/translated_docs/es-ES/contributing.md +++ b/website/translated_docs/es-ES/contributing.md @@ -1,6 +1,5 @@ --- id: contributing -date: 2017-07-10T23:36:56.503Z title: Contributing Verdaccio --- 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: * [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 @@ -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 -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 @@ -39,9 +38,9 @@ Here some ideas: * Create a common eslint rules to be used across all dependencies or plugins * Improve Flow types definitions delivery * Moving to Webpack 4 -* Update to React 16 * Improve hot reload with Webpack * We use babel and webpack across all dependencies, why not a common preset? +* Improve continous integration delivery ### 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 that will be happy to see your ideas. +Our website is based on [Docusaurus](https://docusaurus.io/). + ### I am a DevOps We have a widely popular Docker image 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. +### 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 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. diff --git a/website/translated_docs/es-ES/dev-plugins.md b/website/translated_docs/es-ES/dev-plugins.md index 6b5ba47a3..cc19d7b21 100644 --- a/website/translated_docs/es-ES/dev-plugins.md +++ b/website/translated_docs/es-ES/dev-plugins.md @@ -1,6 +1,5 @@ --- id: dev-plugins -date: 2017-07-10T23:36:56.503Z title: Developing Plugins --- There are many ways to extend `verdaccio`, currently we only support `authentication plugins` diff --git a/website/translated_docs/es-ES/docker.md b/website/translated_docs/es-ES/docker.md index 08d7ad699..bd8a94d5c 100644 --- a/website/translated_docs/es-ES/docker.md +++ b/website/translated_docs/es-ES/docker.md @@ -1,6 +1,5 @@ --- id: docker -date: 2017-07-10T23:36:56.503Z title: Docker --- 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 ``` -# Running verdaccio using Docker +## Running verdaccio using Docker 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 ``` -## 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. @@ -78,7 +77,7 @@ PORT=5000; docker run -it --rm --name 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. @@ -88,7 +87,7 @@ PROTOCOL=https; docker run -it --rm --name verdaccio \ verdaccio/verdaccio ``` -## Using docker-compose +### Using docker-compose 1. Get the latest version of [docker-compose](https://github.com/docker/compose). 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 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`. -# Docker Examples +## Docker Examples There is a separate repository that hosts multiple configurations to compose Docker images with `verdaccio`, for instance, as reverse proxy: diff --git a/website/translated_docs/es-ES/home.md b/website/translated_docs/es-ES/home.md index b41817e54..d392e09ad 100644 --- a/website/translated_docs/es-ES/home.md +++ b/website/translated_docs/es-ES/home.md @@ -1,6 +1,5 @@ --- id: home -date: 2017-07-10T23:36:56.503Z title: Verdaccio npm proxy private registry --- diff --git a/website/translated_docs/es-ES/iis-server.md b/website/translated_docs/es-ES/iis-server.md index 69435eba0..2b94eded0 100644 --- a/website/translated_docs/es-ES/iis-server.md +++ b/website/translated_docs/es-ES/iis-server.md @@ -1,6 +1,5 @@ --- id: iss-server -date: 2017-07-10T23:36:56.503Z 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). diff --git a/website/translated_docs/es-ES/install.md b/website/translated_docs/es-ES/install.md index 9d50e01e5..065f261aa 100644 --- a/website/translated_docs/es-ES/install.md +++ b/website/translated_docs/es-ES/install.md @@ -1,6 +1,5 @@ --- id: installation -date: 2017-07-10T23:36:56.503Z title: Installation --- Verdaccio is a multiplatform web application, to install you need at least some prerequisites. diff --git a/website/translated_docs/es-ES/kubernetes.md b/website/translated_docs/es-ES/kubernetes.md index a60d4a156..278288b43 100644 --- a/website/translated_docs/es-ES/kubernetes.md +++ b/website/translated_docs/es-ES/kubernetes.md @@ -1,6 +1,5 @@ --- id: kubernetes -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/es-ES/logger.md b/website/translated_docs/es-ES/logger.md index 8da65db62..e7a39f54c 100644 --- a/website/translated_docs/es-ES/logger.md +++ b/website/translated_docs/es-ES/logger.md @@ -1,6 +1,5 @@ --- id: logger -date: 2017-07-10T23:36:56.503Z title: Logger --- As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs. diff --git a/website/translated_docs/es-ES/notifications.md b/website/translated_docs/es-ES/notifications.md index cbf3f4933..dc283190f 100644 --- a/website/translated_docs/es-ES/notifications.md +++ b/website/translated_docs/es-ES/notifications.md @@ -1,6 +1,5 @@ --- id: notifications -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/es-ES/packages.md b/website/translated_docs/es-ES/packages.md index 4a3dcf37c..3c8175110 100644 --- a/website/translated_docs/es-ES/packages.md +++ b/website/translated_docs/es-ES/packages.md @@ -1,6 +1,5 @@ --- id: packages -date: 2017-07-10T23:36:56.503Z title: Package Access --- It's a series of contrains that allow or restrict access to the local storage based in specific criteria. diff --git a/website/translated_docs/es-ES/plugins.md b/website/translated_docs/es-ES/plugins.md index 6062772ea..a81264eab 100644 --- a/website/translated_docs/es-ES/plugins.md +++ b/website/translated_docs/es-ES/plugins.md @@ -1,6 +1,5 @@ --- id: plugins -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/es-ES/protect-your-dependencies.md b/website/translated_docs/es-ES/protect-your-dependencies.md index 2545cf347..b03b1d6e5 100644 --- a/website/translated_docs/es-ES/protect-your-dependencies.md +++ b/website/translated_docs/es-ES/protect-your-dependencies.md @@ -1,6 +1,5 @@ --- id: protect-your-dependencies -date: 2017-07-10T23:36:56.503Z title: Protecting packages --- `verdaccio` allows you protect publish, to achieve that you will need to set up correctly your [packages acces](packages). diff --git a/website/translated_docs/es-ES/repositories.md b/website/translated_docs/es-ES/repositories.md index 66dd434ad..0056ee5bf 100644 --- a/website/translated_docs/es-ES/repositories.md +++ b/website/translated_docs/es-ES/repositories.md @@ -1,6 +1,5 @@ --- id: source-code -date: 2017-07-10T23:36:56.503Z 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 diff --git a/website/translated_docs/es-ES/reverse-proxy.md b/website/translated_docs/es-ES/reverse-proxy.md index 1b689b573..bbbba2575 100644 --- a/website/translated_docs/es-ES/reverse-proxy.md +++ b/website/translated_docs/es-ES/reverse-proxy.md @@ -1,6 +1,5 @@ --- id: reverse-proxy -date: 2017-07-10T23:36:56.503Z title: Reverse Proxy Setup --- ## Apache diff --git a/website/translated_docs/es-ES/server.md b/website/translated_docs/es-ES/server.md index 4f1e2b139..7f18f5cae 100644 --- a/website/translated_docs/es-ES/server.md +++ b/website/translated_docs/es-ES/server.md @@ -1,6 +1,5 @@ --- id: server-configuration -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/es-ES/ssl.md b/website/translated_docs/es-ES/ssl.md index c118f534d..bda2c9cb6 100644 --- a/website/translated_docs/es-ES/ssl.md +++ b/website/translated_docs/es-ES/ssl.md @@ -1,6 +1,5 @@ --- id: ssl -date: 2017-07-10T23:36:56.503Z title: Set up the SSL Certificates --- Follow this instructions to configure a SSL certificate to serve NPM registry under HTTPS. diff --git a/website/translated_docs/es-ES/test.md b/website/translated_docs/es-ES/test.md index ed1a40bf2..14899af35 100644 --- a/website/translated_docs/es-ES/test.md +++ b/website/translated_docs/es-ES/test.md @@ -1,6 +1,5 @@ --- id: unit-testing -date: 2017-07-10T23:36:56.503Z title: Unit Testing --- All tests are split in three folders: diff --git a/website/translated_docs/es-ES/uplinks.md b/website/translated_docs/es-ES/uplinks.md index 335c6cca5..68c9c8e17 100644 --- a/website/translated_docs/es-ES/uplinks.md +++ b/website/translated_docs/es-ES/uplinks.md @@ -1,6 +1,5 @@ --- id: uplinks -date: 2017-07-10T23:36:56.503Z title: Uplinks --- 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: -| Property | Type | Required | Example | Support | Description | Default | -| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | ------- | -| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | | -| timeout | string | No | 100ms | all | set new timeout for the request | 30s | -| 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 | -| max_fails | number | No | 2 | all | limit maximun failure request | 2 | -| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true | -| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\]] | >= 2.5 | assigns the header 'Authorization' see: http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules | | -| headers | list | No | authorization: "Basic YourBase64EncodedCredentials==" | all | list of custom headers for the uplink | | +| Property | Type | Required | Example | Support | Description | Default | +| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | -------- | +| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | npmjs | +| timeout | string | No | 100ms | all | set new timeout for the request | 30s | +| 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 | +| max_fails | number | No | 2 | all | limit maximun failure request | 2 | +| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true | +| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\]] | >= 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 | disabled | ### You Must know diff --git a/website/translated_docs/es-ES/use-cases.md b/website/translated_docs/es-ES/use-cases.md index 5bb3a708c..b98dc1f13 100644 --- a/website/translated_docs/es-ES/use-cases.md +++ b/website/translated_docs/es-ES/use-cases.md @@ -1,6 +1,5 @@ --- id: use-cases -date: 2017-07-10T23:36:56.503Z title: Use Cases --- ## Using private packages diff --git a/website/translated_docs/es-ES/web.md b/website/translated_docs/es-ES/web.md index 61a969cd9..789047f18 100644 --- a/website/translated_docs/es-ES/web.md +++ b/website/translated_docs/es-ES/web.md @@ -1,7 +1,6 @@ --- id: webui -date: 2017-07-10T23:36:56.503Z -title: Interfaz Web de Usuario +title: Web User Interface --- Verdaccio contiene una interfaz web para mostrar paquetes privados, puede ser personalizable. diff --git a/website/translated_docs/es-ES/windows.md b/website/translated_docs/es-ES/windows.md index a1c2c8506..d00273ba0 100644 --- a/website/translated_docs/es-ES/windows.md +++ b/website/translated_docs/es-ES/windows.md @@ -1,6 +1,5 @@ --- id: windows -date: 2017-07-10T23:36:56.503Z 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: diff --git a/website/translated_docs/pt-BR/ansible.md b/website/translated_docs/pt-BR/ansible.md index 5a01c3f9a..a198dc20e 100644 --- a/website/translated_docs/pt-BR/ansible.md +++ b/website/translated_docs/pt-BR/ansible.md @@ -1,6 +1,5 @@ --- id: ansible -date: 2017-07-10T23:36:56.503Z title: Installing with Ansible --- We have a customised solution for `verdaccio` in our organization. diff --git a/website/translated_docs/pt-BR/auth.md b/website/translated_docs/pt-BR/auth.md index 77d83ce0b..ca09f4a5e 100644 --- a/website/translated_docs/pt-BR/auth.md +++ b/website/translated_docs/pt-BR/auth.md @@ -1,6 +1,5 @@ --- id: authentification -date: 2017-07-10T23:36:56.503Z 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). diff --git a/website/translated_docs/pt-BR/cli.md b/website/translated_docs/pt-BR/cli.md index 71da2790b..4b8cf3371 100644 --- a/website/translated_docs/pt-BR/cli.md +++ b/website/translated_docs/pt-BR/cli.md @@ -1,6 +1,5 @@ --- id: cli -date: 2017-07-10T23:36:56.503Z title: Command Line Tool --- 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 ``` -| Command | Default | Example | Description | -| ------------------ | ---------------------------------------- | -------------------- | ---------------------- | -| --listen \ **-l** | 4873 | -p 7000 | http port | -| --config \ **-c** | ~/home/user/.local/verdaccio/config.yaml | /foo/bar/config.yaml | the configuration file | \ No newline at end of file +| Command | Default | Example | Description | +| ------------------ | ------------------------------ | ------------- | ---------------------- | +| --listen \ **-l** | 4873 | -p 7000 | http port | +| --config \ **-c** | ~/.local/verdaccio/config.yaml | ~/config.yaml | the configuration file | \ No newline at end of file diff --git a/website/translated_docs/pt-BR/config.md b/website/translated_docs/pt-BR/config.md index 8c7f8c24a..2c4e5f61f 100644 --- a/website/translated_docs/pt-BR/config.md +++ b/website/translated_docs/pt-BR/config.md @@ -1,6 +1,5 @@ --- id: configuration -date: 2017-07-10T23:36:56.503Z title: Configuration File --- This file is the cornerstone of verdaccio where you can modify the default behaviour, enable plugins and extend features. diff --git a/website/translated_docs/pt-BR/contributing.md b/website/translated_docs/pt-BR/contributing.md index 8b31b1029..b834509cc 100644 --- a/website/translated_docs/pt-BR/contributing.md +++ b/website/translated_docs/pt-BR/contributing.md @@ -1,6 +1,5 @@ --- id: contributing -date: 2017-07-10T23:36:56.503Z title: Contributing Verdaccio --- 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: * [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 @@ -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 -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 @@ -39,9 +38,9 @@ Here some ideas: * Create a common eslint rules to be used across all dependencies or plugins * Improve Flow types definitions delivery * Moving to Webpack 4 -* Update to React 16 * Improve hot reload with Webpack * We use babel and webpack across all dependencies, why not a common preset? +* Improve continous integration delivery ### 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 that will be happy to see your ideas. +Our website is based on [Docusaurus](https://docusaurus.io/). + ### I am a DevOps We have a widely popular Docker image 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. +### 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 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. diff --git a/website/translated_docs/pt-BR/dev-plugins.md b/website/translated_docs/pt-BR/dev-plugins.md index 6b5ba47a3..cc19d7b21 100644 --- a/website/translated_docs/pt-BR/dev-plugins.md +++ b/website/translated_docs/pt-BR/dev-plugins.md @@ -1,6 +1,5 @@ --- id: dev-plugins -date: 2017-07-10T23:36:56.503Z title: Developing Plugins --- There are many ways to extend `verdaccio`, currently we only support `authentication plugins` diff --git a/website/translated_docs/pt-BR/docker.md b/website/translated_docs/pt-BR/docker.md index 08d7ad699..bd8a94d5c 100644 --- a/website/translated_docs/pt-BR/docker.md +++ b/website/translated_docs/pt-BR/docker.md @@ -1,6 +1,5 @@ --- id: docker -date: 2017-07-10T23:36:56.503Z title: Docker --- 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 ``` -# Running verdaccio using Docker +## Running verdaccio using Docker 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 ``` -## 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. @@ -78,7 +77,7 @@ PORT=5000; docker run -it --rm --name 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. @@ -88,7 +87,7 @@ PROTOCOL=https; docker run -it --rm --name verdaccio \ verdaccio/verdaccio ``` -## Using docker-compose +### Using docker-compose 1. Get the latest version of [docker-compose](https://github.com/docker/compose). 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 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`. -# Docker Examples +## Docker Examples There is a separate repository that hosts multiple configurations to compose Docker images with `verdaccio`, for instance, as reverse proxy: diff --git a/website/translated_docs/pt-BR/home.md b/website/translated_docs/pt-BR/home.md index b41817e54..d392e09ad 100644 --- a/website/translated_docs/pt-BR/home.md +++ b/website/translated_docs/pt-BR/home.md @@ -1,6 +1,5 @@ --- id: home -date: 2017-07-10T23:36:56.503Z title: Verdaccio npm proxy private registry --- diff --git a/website/translated_docs/pt-BR/iis-server.md b/website/translated_docs/pt-BR/iis-server.md index 69435eba0..2b94eded0 100644 --- a/website/translated_docs/pt-BR/iis-server.md +++ b/website/translated_docs/pt-BR/iis-server.md @@ -1,6 +1,5 @@ --- id: iss-server -date: 2017-07-10T23:36:56.503Z 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). diff --git a/website/translated_docs/pt-BR/install.md b/website/translated_docs/pt-BR/install.md index 9d50e01e5..065f261aa 100644 --- a/website/translated_docs/pt-BR/install.md +++ b/website/translated_docs/pt-BR/install.md @@ -1,6 +1,5 @@ --- id: installation -date: 2017-07-10T23:36:56.503Z title: Installation --- Verdaccio is a multiplatform web application, to install you need at least some prerequisites. diff --git a/website/translated_docs/pt-BR/kubernetes.md b/website/translated_docs/pt-BR/kubernetes.md index a60d4a156..278288b43 100644 --- a/website/translated_docs/pt-BR/kubernetes.md +++ b/website/translated_docs/pt-BR/kubernetes.md @@ -1,6 +1,5 @@ --- id: kubernetes -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/pt-BR/logger.md b/website/translated_docs/pt-BR/logger.md index 8da65db62..e7a39f54c 100644 --- a/website/translated_docs/pt-BR/logger.md +++ b/website/translated_docs/pt-BR/logger.md @@ -1,6 +1,5 @@ --- id: logger -date: 2017-07-10T23:36:56.503Z title: Logger --- As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs. diff --git a/website/translated_docs/pt-BR/notifications.md b/website/translated_docs/pt-BR/notifications.md index cbf3f4933..dc283190f 100644 --- a/website/translated_docs/pt-BR/notifications.md +++ b/website/translated_docs/pt-BR/notifications.md @@ -1,6 +1,5 @@ --- id: notifications -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/pt-BR/packages.md b/website/translated_docs/pt-BR/packages.md index 4a3dcf37c..3c8175110 100644 --- a/website/translated_docs/pt-BR/packages.md +++ b/website/translated_docs/pt-BR/packages.md @@ -1,6 +1,5 @@ --- id: packages -date: 2017-07-10T23:36:56.503Z title: Package Access --- It's a series of contrains that allow or restrict access to the local storage based in specific criteria. diff --git a/website/translated_docs/pt-BR/plugins.md b/website/translated_docs/pt-BR/plugins.md index 6062772ea..a81264eab 100644 --- a/website/translated_docs/pt-BR/plugins.md +++ b/website/translated_docs/pt-BR/plugins.md @@ -1,6 +1,5 @@ --- id: plugins -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/pt-BR/protect-your-dependencies.md b/website/translated_docs/pt-BR/protect-your-dependencies.md index 2545cf347..b03b1d6e5 100644 --- a/website/translated_docs/pt-BR/protect-your-dependencies.md +++ b/website/translated_docs/pt-BR/protect-your-dependencies.md @@ -1,6 +1,5 @@ --- id: protect-your-dependencies -date: 2017-07-10T23:36:56.503Z title: Protecting packages --- `verdaccio` allows you protect publish, to achieve that you will need to set up correctly your [packages acces](packages). diff --git a/website/translated_docs/pt-BR/repositories.md b/website/translated_docs/pt-BR/repositories.md index 66dd434ad..0056ee5bf 100644 --- a/website/translated_docs/pt-BR/repositories.md +++ b/website/translated_docs/pt-BR/repositories.md @@ -1,6 +1,5 @@ --- id: source-code -date: 2017-07-10T23:36:56.503Z 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 diff --git a/website/translated_docs/pt-BR/reverse-proxy.md b/website/translated_docs/pt-BR/reverse-proxy.md index 1b689b573..bbbba2575 100644 --- a/website/translated_docs/pt-BR/reverse-proxy.md +++ b/website/translated_docs/pt-BR/reverse-proxy.md @@ -1,6 +1,5 @@ --- id: reverse-proxy -date: 2017-07-10T23:36:56.503Z title: Reverse Proxy Setup --- ## Apache diff --git a/website/translated_docs/pt-BR/server.md b/website/translated_docs/pt-BR/server.md index 4f1e2b139..7f18f5cae 100644 --- a/website/translated_docs/pt-BR/server.md +++ b/website/translated_docs/pt-BR/server.md @@ -1,6 +1,5 @@ --- id: server-configuration -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/pt-BR/ssl.md b/website/translated_docs/pt-BR/ssl.md index c118f534d..bda2c9cb6 100644 --- a/website/translated_docs/pt-BR/ssl.md +++ b/website/translated_docs/pt-BR/ssl.md @@ -1,6 +1,5 @@ --- id: ssl -date: 2017-07-10T23:36:56.503Z title: Set up the SSL Certificates --- Follow this instructions to configure a SSL certificate to serve NPM registry under HTTPS. diff --git a/website/translated_docs/pt-BR/test.md b/website/translated_docs/pt-BR/test.md index ed1a40bf2..14899af35 100644 --- a/website/translated_docs/pt-BR/test.md +++ b/website/translated_docs/pt-BR/test.md @@ -1,6 +1,5 @@ --- id: unit-testing -date: 2017-07-10T23:36:56.503Z title: Unit Testing --- All tests are split in three folders: diff --git a/website/translated_docs/pt-BR/uplinks.md b/website/translated_docs/pt-BR/uplinks.md index 335c6cca5..68c9c8e17 100644 --- a/website/translated_docs/pt-BR/uplinks.md +++ b/website/translated_docs/pt-BR/uplinks.md @@ -1,6 +1,5 @@ --- id: uplinks -date: 2017-07-10T23:36:56.503Z title: Uplinks --- 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: -| Property | Type | Required | Example | Support | Description | Default | -| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | ------- | -| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | | -| timeout | string | No | 100ms | all | set new timeout for the request | 30s | -| 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 | -| max_fails | number | No | 2 | all | limit maximun failure request | 2 | -| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true | -| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\]] | >= 2.5 | assigns the header 'Authorization' see: http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules | | -| headers | list | No | authorization: "Basic YourBase64EncodedCredentials==" | all | list of custom headers for the uplink | | +| Property | Type | Required | Example | Support | Description | Default | +| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | -------- | +| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | npmjs | +| timeout | string | No | 100ms | all | set new timeout for the request | 30s | +| 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 | +| max_fails | number | No | 2 | all | limit maximun failure request | 2 | +| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true | +| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\]] | >= 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 | disabled | ### You Must know diff --git a/website/translated_docs/pt-BR/use-cases.md b/website/translated_docs/pt-BR/use-cases.md index 5bb3a708c..b98dc1f13 100644 --- a/website/translated_docs/pt-BR/use-cases.md +++ b/website/translated_docs/pt-BR/use-cases.md @@ -1,6 +1,5 @@ --- id: use-cases -date: 2017-07-10T23:36:56.503Z title: Use Cases --- ## Using private packages diff --git a/website/translated_docs/pt-BR/web.md b/website/translated_docs/pt-BR/web.md index 1fceb6580..86b44d985 100644 --- a/website/translated_docs/pt-BR/web.md +++ b/website/translated_docs/pt-BR/web.md @@ -1,6 +1,5 @@ --- id: webui -date: 2017-07-10T23:36:56.503Z title: Web User Interface --- Verdaccio has a web user interface to display only the private packges and can be customisable. diff --git a/website/translated_docs/pt-BR/windows.md b/website/translated_docs/pt-BR/windows.md index a1c2c8506..d00273ba0 100644 --- a/website/translated_docs/pt-BR/windows.md +++ b/website/translated_docs/pt-BR/windows.md @@ -1,6 +1,5 @@ --- id: windows -date: 2017-07-10T23:36:56.503Z 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: diff --git a/website/translated_docs/ur-PK/ansible.md b/website/translated_docs/ur-PK/ansible.md index 5a01c3f9a..a198dc20e 100644 --- a/website/translated_docs/ur-PK/ansible.md +++ b/website/translated_docs/ur-PK/ansible.md @@ -1,6 +1,5 @@ --- id: ansible -date: 2017-07-10T23:36:56.503Z title: Installing with Ansible --- We have a customised solution for `verdaccio` in our organization. diff --git a/website/translated_docs/ur-PK/auth.md b/website/translated_docs/ur-PK/auth.md index 77d83ce0b..ca09f4a5e 100644 --- a/website/translated_docs/ur-PK/auth.md +++ b/website/translated_docs/ur-PK/auth.md @@ -1,6 +1,5 @@ --- id: authentification -date: 2017-07-10T23:36:56.503Z 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). diff --git a/website/translated_docs/ur-PK/cli.md b/website/translated_docs/ur-PK/cli.md index 71da2790b..4b8cf3371 100644 --- a/website/translated_docs/ur-PK/cli.md +++ b/website/translated_docs/ur-PK/cli.md @@ -1,6 +1,5 @@ --- id: cli -date: 2017-07-10T23:36:56.503Z title: Command Line Tool --- 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 ``` -| Command | Default | Example | Description | -| ------------------ | ---------------------------------------- | -------------------- | ---------------------- | -| --listen \ **-l** | 4873 | -p 7000 | http port | -| --config \ **-c** | ~/home/user/.local/verdaccio/config.yaml | /foo/bar/config.yaml | the configuration file | \ No newline at end of file +| Command | Default | Example | Description | +| ------------------ | ------------------------------ | ------------- | ---------------------- | +| --listen \ **-l** | 4873 | -p 7000 | http port | +| --config \ **-c** | ~/.local/verdaccio/config.yaml | ~/config.yaml | the configuration file | \ No newline at end of file diff --git a/website/translated_docs/ur-PK/config.md b/website/translated_docs/ur-PK/config.md index 8c7f8c24a..2c4e5f61f 100644 --- a/website/translated_docs/ur-PK/config.md +++ b/website/translated_docs/ur-PK/config.md @@ -1,6 +1,5 @@ --- id: configuration -date: 2017-07-10T23:36:56.503Z title: Configuration File --- This file is the cornerstone of verdaccio where you can modify the default behaviour, enable plugins and extend features. diff --git a/website/translated_docs/ur-PK/contributing.md b/website/translated_docs/ur-PK/contributing.md index 8b31b1029..b834509cc 100644 --- a/website/translated_docs/ur-PK/contributing.md +++ b/website/translated_docs/ur-PK/contributing.md @@ -1,6 +1,5 @@ --- id: contributing -date: 2017-07-10T23:36:56.503Z title: Contributing Verdaccio --- 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: * [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 @@ -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 -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 @@ -39,9 +38,9 @@ Here some ideas: * Create a common eslint rules to be used across all dependencies or plugins * Improve Flow types definitions delivery * Moving to Webpack 4 -* Update to React 16 * Improve hot reload with Webpack * We use babel and webpack across all dependencies, why not a common preset? +* Improve continous integration delivery ### 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 that will be happy to see your ideas. +Our website is based on [Docusaurus](https://docusaurus.io/). + ### I am a DevOps We have a widely popular Docker image 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. +### 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 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. diff --git a/website/translated_docs/ur-PK/dev-plugins.md b/website/translated_docs/ur-PK/dev-plugins.md index 6b5ba47a3..cc19d7b21 100644 --- a/website/translated_docs/ur-PK/dev-plugins.md +++ b/website/translated_docs/ur-PK/dev-plugins.md @@ -1,6 +1,5 @@ --- id: dev-plugins -date: 2017-07-10T23:36:56.503Z title: Developing Plugins --- There are many ways to extend `verdaccio`, currently we only support `authentication plugins` diff --git a/website/translated_docs/ur-PK/docker.md b/website/translated_docs/ur-PK/docker.md index 08d7ad699..bd8a94d5c 100644 --- a/website/translated_docs/ur-PK/docker.md +++ b/website/translated_docs/ur-PK/docker.md @@ -1,6 +1,5 @@ --- id: docker -date: 2017-07-10T23:36:56.503Z title: Docker --- 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 ``` -# Running verdaccio using Docker +## Running verdaccio using Docker 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 ``` -## 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. @@ -78,7 +77,7 @@ PORT=5000; docker run -it --rm --name 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. @@ -88,7 +87,7 @@ PROTOCOL=https; docker run -it --rm --name verdaccio \ verdaccio/verdaccio ``` -## Using docker-compose +### Using docker-compose 1. Get the latest version of [docker-compose](https://github.com/docker/compose). 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 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`. -# Docker Examples +## Docker Examples There is a separate repository that hosts multiple configurations to compose Docker images with `verdaccio`, for instance, as reverse proxy: diff --git a/website/translated_docs/ur-PK/home.md b/website/translated_docs/ur-PK/home.md index b41817e54..d392e09ad 100644 --- a/website/translated_docs/ur-PK/home.md +++ b/website/translated_docs/ur-PK/home.md @@ -1,6 +1,5 @@ --- id: home -date: 2017-07-10T23:36:56.503Z title: Verdaccio npm proxy private registry --- diff --git a/website/translated_docs/ur-PK/iis-server.md b/website/translated_docs/ur-PK/iis-server.md index 69435eba0..2b94eded0 100644 --- a/website/translated_docs/ur-PK/iis-server.md +++ b/website/translated_docs/ur-PK/iis-server.md @@ -1,6 +1,5 @@ --- id: iss-server -date: 2017-07-10T23:36:56.503Z 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). diff --git a/website/translated_docs/ur-PK/install.md b/website/translated_docs/ur-PK/install.md index 9d50e01e5..065f261aa 100644 --- a/website/translated_docs/ur-PK/install.md +++ b/website/translated_docs/ur-PK/install.md @@ -1,6 +1,5 @@ --- id: installation -date: 2017-07-10T23:36:56.503Z title: Installation --- Verdaccio is a multiplatform web application, to install you need at least some prerequisites. diff --git a/website/translated_docs/ur-PK/kubernetes.md b/website/translated_docs/ur-PK/kubernetes.md index a60d4a156..278288b43 100644 --- a/website/translated_docs/ur-PK/kubernetes.md +++ b/website/translated_docs/ur-PK/kubernetes.md @@ -1,6 +1,5 @@ --- id: kubernetes -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/ur-PK/logger.md b/website/translated_docs/ur-PK/logger.md index 8da65db62..e7a39f54c 100644 --- a/website/translated_docs/ur-PK/logger.md +++ b/website/translated_docs/ur-PK/logger.md @@ -1,6 +1,5 @@ --- id: logger -date: 2017-07-10T23:36:56.503Z title: Logger --- As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs. diff --git a/website/translated_docs/ur-PK/notifications.md b/website/translated_docs/ur-PK/notifications.md index cbf3f4933..dc283190f 100644 --- a/website/translated_docs/ur-PK/notifications.md +++ b/website/translated_docs/ur-PK/notifications.md @@ -1,6 +1,5 @@ --- id: notifications -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/ur-PK/packages.md b/website/translated_docs/ur-PK/packages.md index 4a3dcf37c..3c8175110 100644 --- a/website/translated_docs/ur-PK/packages.md +++ b/website/translated_docs/ur-PK/packages.md @@ -1,6 +1,5 @@ --- id: packages -date: 2017-07-10T23:36:56.503Z title: Package Access --- It's a series of contrains that allow or restrict access to the local storage based in specific criteria. diff --git a/website/translated_docs/ur-PK/plugins.md b/website/translated_docs/ur-PK/plugins.md index 6062772ea..a81264eab 100644 --- a/website/translated_docs/ur-PK/plugins.md +++ b/website/translated_docs/ur-PK/plugins.md @@ -1,6 +1,5 @@ --- id: plugins -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/ur-PK/protect-your-dependencies.md b/website/translated_docs/ur-PK/protect-your-dependencies.md index 2545cf347..b03b1d6e5 100644 --- a/website/translated_docs/ur-PK/protect-your-dependencies.md +++ b/website/translated_docs/ur-PK/protect-your-dependencies.md @@ -1,6 +1,5 @@ --- id: protect-your-dependencies -date: 2017-07-10T23:36:56.503Z title: Protecting packages --- `verdaccio` allows you protect publish, to achieve that you will need to set up correctly your [packages acces](packages). diff --git a/website/translated_docs/ur-PK/repositories.md b/website/translated_docs/ur-PK/repositories.md index 66dd434ad..0056ee5bf 100644 --- a/website/translated_docs/ur-PK/repositories.md +++ b/website/translated_docs/ur-PK/repositories.md @@ -1,6 +1,5 @@ --- id: source-code -date: 2017-07-10T23:36:56.503Z 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 diff --git a/website/translated_docs/ur-PK/reverse-proxy.md b/website/translated_docs/ur-PK/reverse-proxy.md index 1b689b573..bbbba2575 100644 --- a/website/translated_docs/ur-PK/reverse-proxy.md +++ b/website/translated_docs/ur-PK/reverse-proxy.md @@ -1,6 +1,5 @@ --- id: reverse-proxy -date: 2017-07-10T23:36:56.503Z title: Reverse Proxy Setup --- ## Apache diff --git a/website/translated_docs/ur-PK/server.md b/website/translated_docs/ur-PK/server.md index 4f1e2b139..7f18f5cae 100644 --- a/website/translated_docs/ur-PK/server.md +++ b/website/translated_docs/ur-PK/server.md @@ -1,6 +1,5 @@ --- id: server-configuration -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/ur-PK/ssl.md b/website/translated_docs/ur-PK/ssl.md index c118f534d..bda2c9cb6 100644 --- a/website/translated_docs/ur-PK/ssl.md +++ b/website/translated_docs/ur-PK/ssl.md @@ -1,6 +1,5 @@ --- id: ssl -date: 2017-07-10T23:36:56.503Z title: Set up the SSL Certificates --- Follow this instructions to configure a SSL certificate to serve NPM registry under HTTPS. diff --git a/website/translated_docs/ur-PK/test.md b/website/translated_docs/ur-PK/test.md index ed1a40bf2..14899af35 100644 --- a/website/translated_docs/ur-PK/test.md +++ b/website/translated_docs/ur-PK/test.md @@ -1,6 +1,5 @@ --- id: unit-testing -date: 2017-07-10T23:36:56.503Z title: Unit Testing --- All tests are split in three folders: diff --git a/website/translated_docs/ur-PK/uplinks.md b/website/translated_docs/ur-PK/uplinks.md index 335c6cca5..68c9c8e17 100644 --- a/website/translated_docs/ur-PK/uplinks.md +++ b/website/translated_docs/ur-PK/uplinks.md @@ -1,6 +1,5 @@ --- id: uplinks -date: 2017-07-10T23:36:56.503Z title: Uplinks --- 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: -| Property | Type | Required | Example | Support | Description | Default | -| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | ------- | -| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | | -| timeout | string | No | 100ms | all | set new timeout for the request | 30s | -| 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 | -| max_fails | number | No | 2 | all | limit maximun failure request | 2 | -| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true | -| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\]] | >= 2.5 | assigns the header 'Authorization' see: http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules | | -| headers | list | No | authorization: "Basic YourBase64EncodedCredentials==" | all | list of custom headers for the uplink | | +| Property | Type | Required | Example | Support | Description | Default | +| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | -------- | +| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | npmjs | +| timeout | string | No | 100ms | all | set new timeout for the request | 30s | +| 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 | +| max_fails | number | No | 2 | all | limit maximun failure request | 2 | +| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true | +| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\]] | >= 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 | disabled | ### You Must know diff --git a/website/translated_docs/ur-PK/use-cases.md b/website/translated_docs/ur-PK/use-cases.md index 5bb3a708c..b98dc1f13 100644 --- a/website/translated_docs/ur-PK/use-cases.md +++ b/website/translated_docs/ur-PK/use-cases.md @@ -1,6 +1,5 @@ --- id: use-cases -date: 2017-07-10T23:36:56.503Z title: Use Cases --- ## Using private packages diff --git a/website/translated_docs/ur-PK/web.md b/website/translated_docs/ur-PK/web.md index 1fceb6580..86b44d985 100644 --- a/website/translated_docs/ur-PK/web.md +++ b/website/translated_docs/ur-PK/web.md @@ -1,6 +1,5 @@ --- id: webui -date: 2017-07-10T23:36:56.503Z title: Web User Interface --- Verdaccio has a web user interface to display only the private packges and can be customisable. diff --git a/website/translated_docs/ur-PK/windows.md b/website/translated_docs/ur-PK/windows.md index a1c2c8506..d00273ba0 100644 --- a/website/translated_docs/ur-PK/windows.md +++ b/website/translated_docs/ur-PK/windows.md @@ -1,6 +1,5 @@ --- id: windows -date: 2017-07-10T23:36:56.503Z 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: diff --git a/website/translated_docs/zh-HK/ansible.md b/website/translated_docs/zh-HK/ansible.md index 5a01c3f9a..a198dc20e 100644 --- a/website/translated_docs/zh-HK/ansible.md +++ b/website/translated_docs/zh-HK/ansible.md @@ -1,6 +1,5 @@ --- id: ansible -date: 2017-07-10T23:36:56.503Z title: Installing with Ansible --- We have a customised solution for `verdaccio` in our organization. diff --git a/website/translated_docs/zh-HK/auth.md b/website/translated_docs/zh-HK/auth.md index 77d83ce0b..ca09f4a5e 100644 --- a/website/translated_docs/zh-HK/auth.md +++ b/website/translated_docs/zh-HK/auth.md @@ -1,6 +1,5 @@ --- id: authentification -date: 2017-07-10T23:36:56.503Z 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). diff --git a/website/translated_docs/zh-HK/cli.md b/website/translated_docs/zh-HK/cli.md index 71da2790b..4b8cf3371 100644 --- a/website/translated_docs/zh-HK/cli.md +++ b/website/translated_docs/zh-HK/cli.md @@ -1,6 +1,5 @@ --- id: cli -date: 2017-07-10T23:36:56.503Z title: Command Line Tool --- 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 ``` -| Command | Default | Example | Description | -| ------------------ | ---------------------------------------- | -------------------- | ---------------------- | -| --listen \ **-l** | 4873 | -p 7000 | http port | -| --config \ **-c** | ~/home/user/.local/verdaccio/config.yaml | /foo/bar/config.yaml | the configuration file | \ No newline at end of file +| Command | Default | Example | Description | +| ------------------ | ------------------------------ | ------------- | ---------------------- | +| --listen \ **-l** | 4873 | -p 7000 | http port | +| --config \ **-c** | ~/.local/verdaccio/config.yaml | ~/config.yaml | the configuration file | \ No newline at end of file diff --git a/website/translated_docs/zh-HK/config.md b/website/translated_docs/zh-HK/config.md index 8c7f8c24a..2c4e5f61f 100644 --- a/website/translated_docs/zh-HK/config.md +++ b/website/translated_docs/zh-HK/config.md @@ -1,6 +1,5 @@ --- id: configuration -date: 2017-07-10T23:36:56.503Z title: Configuration File --- This file is the cornerstone of verdaccio where you can modify the default behaviour, enable plugins and extend features. diff --git a/website/translated_docs/zh-HK/contributing.md b/website/translated_docs/zh-HK/contributing.md index 8b31b1029..b834509cc 100644 --- a/website/translated_docs/zh-HK/contributing.md +++ b/website/translated_docs/zh-HK/contributing.md @@ -1,6 +1,5 @@ --- id: contributing -date: 2017-07-10T23:36:56.503Z title: Contributing Verdaccio --- 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: * [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 @@ -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 -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 @@ -39,9 +38,9 @@ Here some ideas: * Create a common eslint rules to be used across all dependencies or plugins * Improve Flow types definitions delivery * Moving to Webpack 4 -* Update to React 16 * Improve hot reload with Webpack * We use babel and webpack across all dependencies, why not a common preset? +* Improve continous integration delivery ### 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 that will be happy to see your ideas. +Our website is based on [Docusaurus](https://docusaurus.io/). + ### I am a DevOps We have a widely popular Docker image 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. +### 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 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. diff --git a/website/translated_docs/zh-HK/dev-plugins.md b/website/translated_docs/zh-HK/dev-plugins.md index 6b5ba47a3..cc19d7b21 100644 --- a/website/translated_docs/zh-HK/dev-plugins.md +++ b/website/translated_docs/zh-HK/dev-plugins.md @@ -1,6 +1,5 @@ --- id: dev-plugins -date: 2017-07-10T23:36:56.503Z title: Developing Plugins --- There are many ways to extend `verdaccio`, currently we only support `authentication plugins` diff --git a/website/translated_docs/zh-HK/docker.md b/website/translated_docs/zh-HK/docker.md index 08d7ad699..bd8a94d5c 100644 --- a/website/translated_docs/zh-HK/docker.md +++ b/website/translated_docs/zh-HK/docker.md @@ -1,6 +1,5 @@ --- id: docker -date: 2017-07-10T23:36:56.503Z title: Docker --- 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 ``` -# Running verdaccio using Docker +## Running verdaccio using Docker 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 ``` -## 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. @@ -78,7 +77,7 @@ PORT=5000; docker run -it --rm --name 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. @@ -88,7 +87,7 @@ PROTOCOL=https; docker run -it --rm --name verdaccio \ verdaccio/verdaccio ``` -## Using docker-compose +### Using docker-compose 1. Get the latest version of [docker-compose](https://github.com/docker/compose). 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 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`. -# Docker Examples +## Docker Examples There is a separate repository that hosts multiple configurations to compose Docker images with `verdaccio`, for instance, as reverse proxy: diff --git a/website/translated_docs/zh-HK/home.md b/website/translated_docs/zh-HK/home.md index b41817e54..d392e09ad 100644 --- a/website/translated_docs/zh-HK/home.md +++ b/website/translated_docs/zh-HK/home.md @@ -1,6 +1,5 @@ --- id: home -date: 2017-07-10T23:36:56.503Z title: Verdaccio npm proxy private registry --- diff --git a/website/translated_docs/zh-HK/iis-server.md b/website/translated_docs/zh-HK/iis-server.md index 69435eba0..2b94eded0 100644 --- a/website/translated_docs/zh-HK/iis-server.md +++ b/website/translated_docs/zh-HK/iis-server.md @@ -1,6 +1,5 @@ --- id: iss-server -date: 2017-07-10T23:36:56.503Z 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). diff --git a/website/translated_docs/zh-HK/install.md b/website/translated_docs/zh-HK/install.md index 9d50e01e5..065f261aa 100644 --- a/website/translated_docs/zh-HK/install.md +++ b/website/translated_docs/zh-HK/install.md @@ -1,6 +1,5 @@ --- id: installation -date: 2017-07-10T23:36:56.503Z title: Installation --- Verdaccio is a multiplatform web application, to install you need at least some prerequisites. diff --git a/website/translated_docs/zh-HK/kubernetes.md b/website/translated_docs/zh-HK/kubernetes.md index a60d4a156..278288b43 100644 --- a/website/translated_docs/zh-HK/kubernetes.md +++ b/website/translated_docs/zh-HK/kubernetes.md @@ -1,6 +1,5 @@ --- id: kubernetes -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/zh-HK/logger.md b/website/translated_docs/zh-HK/logger.md index 8da65db62..e7a39f54c 100644 --- a/website/translated_docs/zh-HK/logger.md +++ b/website/translated_docs/zh-HK/logger.md @@ -1,6 +1,5 @@ --- id: logger -date: 2017-07-10T23:36:56.503Z title: Logger --- As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs. diff --git a/website/translated_docs/zh-HK/notifications.md b/website/translated_docs/zh-HK/notifications.md index cbf3f4933..dc283190f 100644 --- a/website/translated_docs/zh-HK/notifications.md +++ b/website/translated_docs/zh-HK/notifications.md @@ -1,6 +1,5 @@ --- id: notifications -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/zh-HK/packages.md b/website/translated_docs/zh-HK/packages.md index 4a3dcf37c..3c8175110 100644 --- a/website/translated_docs/zh-HK/packages.md +++ b/website/translated_docs/zh-HK/packages.md @@ -1,6 +1,5 @@ --- id: packages -date: 2017-07-10T23:36:56.503Z title: Package Access --- It's a series of contrains that allow or restrict access to the local storage based in specific criteria. diff --git a/website/translated_docs/zh-HK/plugins.md b/website/translated_docs/zh-HK/plugins.md index 6062772ea..a81264eab 100644 --- a/website/translated_docs/zh-HK/plugins.md +++ b/website/translated_docs/zh-HK/plugins.md @@ -1,6 +1,5 @@ --- id: plugins -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/zh-HK/protect-your-dependencies.md b/website/translated_docs/zh-HK/protect-your-dependencies.md index 2545cf347..b03b1d6e5 100644 --- a/website/translated_docs/zh-HK/protect-your-dependencies.md +++ b/website/translated_docs/zh-HK/protect-your-dependencies.md @@ -1,6 +1,5 @@ --- id: protect-your-dependencies -date: 2017-07-10T23:36:56.503Z title: Protecting packages --- `verdaccio` allows you protect publish, to achieve that you will need to set up correctly your [packages acces](packages). diff --git a/website/translated_docs/zh-HK/repositories.md b/website/translated_docs/zh-HK/repositories.md index 66dd434ad..0056ee5bf 100644 --- a/website/translated_docs/zh-HK/repositories.md +++ b/website/translated_docs/zh-HK/repositories.md @@ -1,6 +1,5 @@ --- id: source-code -date: 2017-07-10T23:36:56.503Z 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 diff --git a/website/translated_docs/zh-HK/reverse-proxy.md b/website/translated_docs/zh-HK/reverse-proxy.md index 1b689b573..bbbba2575 100644 --- a/website/translated_docs/zh-HK/reverse-proxy.md +++ b/website/translated_docs/zh-HK/reverse-proxy.md @@ -1,6 +1,5 @@ --- id: reverse-proxy -date: 2017-07-10T23:36:56.503Z title: Reverse Proxy Setup --- ## Apache diff --git a/website/translated_docs/zh-HK/server.md b/website/translated_docs/zh-HK/server.md index 4f1e2b139..7f18f5cae 100644 --- a/website/translated_docs/zh-HK/server.md +++ b/website/translated_docs/zh-HK/server.md @@ -1,6 +1,5 @@ --- id: server-configuration -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/zh-HK/ssl.md b/website/translated_docs/zh-HK/ssl.md index c118f534d..bda2c9cb6 100644 --- a/website/translated_docs/zh-HK/ssl.md +++ b/website/translated_docs/zh-HK/ssl.md @@ -1,6 +1,5 @@ --- id: ssl -date: 2017-07-10T23:36:56.503Z title: Set up the SSL Certificates --- Follow this instructions to configure a SSL certificate to serve NPM registry under HTTPS. diff --git a/website/translated_docs/zh-HK/test.md b/website/translated_docs/zh-HK/test.md index ed1a40bf2..14899af35 100644 --- a/website/translated_docs/zh-HK/test.md +++ b/website/translated_docs/zh-HK/test.md @@ -1,6 +1,5 @@ --- id: unit-testing -date: 2017-07-10T23:36:56.503Z title: Unit Testing --- All tests are split in three folders: diff --git a/website/translated_docs/zh-HK/uplinks.md b/website/translated_docs/zh-HK/uplinks.md index 335c6cca5..68c9c8e17 100644 --- a/website/translated_docs/zh-HK/uplinks.md +++ b/website/translated_docs/zh-HK/uplinks.md @@ -1,6 +1,5 @@ --- id: uplinks -date: 2017-07-10T23:36:56.503Z title: Uplinks --- 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: -| Property | Type | Required | Example | Support | Description | Default | -| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | ------- | -| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | | -| timeout | string | No | 100ms | all | set new timeout for the request | 30s | -| 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 | -| max_fails | number | No | 2 | all | limit maximun failure request | 2 | -| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true | -| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\]] | >= 2.5 | assigns the header 'Authorization' see: http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules | | -| headers | list | No | authorization: "Basic YourBase64EncodedCredentials==" | all | list of custom headers for the uplink | | +| Property | Type | Required | Example | Support | Description | Default | +| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | -------- | +| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | npmjs | +| timeout | string | No | 100ms | all | set new timeout for the request | 30s | +| 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 | +| max_fails | number | No | 2 | all | limit maximun failure request | 2 | +| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true | +| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\]] | >= 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 | disabled | ### You Must know diff --git a/website/translated_docs/zh-HK/use-cases.md b/website/translated_docs/zh-HK/use-cases.md index 5bb3a708c..b98dc1f13 100644 --- a/website/translated_docs/zh-HK/use-cases.md +++ b/website/translated_docs/zh-HK/use-cases.md @@ -1,6 +1,5 @@ --- id: use-cases -date: 2017-07-10T23:36:56.503Z title: Use Cases --- ## Using private packages diff --git a/website/translated_docs/zh-HK/web.md b/website/translated_docs/zh-HK/web.md index 1fceb6580..86b44d985 100644 --- a/website/translated_docs/zh-HK/web.md +++ b/website/translated_docs/zh-HK/web.md @@ -1,6 +1,5 @@ --- id: webui -date: 2017-07-10T23:36:56.503Z title: Web User Interface --- Verdaccio has a web user interface to display only the private packges and can be customisable. diff --git a/website/translated_docs/zh-HK/windows.md b/website/translated_docs/zh-HK/windows.md index a1c2c8506..d00273ba0 100644 --- a/website/translated_docs/zh-HK/windows.md +++ b/website/translated_docs/zh-HK/windows.md @@ -1,6 +1,5 @@ --- id: windows -date: 2017-07-10T23:36:56.503Z 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: diff --git a/website/translated_docs/zh-Hans/ansible.md b/website/translated_docs/zh-Hans/ansible.md index 5a01c3f9a..a198dc20e 100644 --- a/website/translated_docs/zh-Hans/ansible.md +++ b/website/translated_docs/zh-Hans/ansible.md @@ -1,6 +1,5 @@ --- id: ansible -date: 2017-07-10T23:36:56.503Z title: Installing with Ansible --- We have a customised solution for `verdaccio` in our organization. diff --git a/website/translated_docs/zh-Hans/auth.md b/website/translated_docs/zh-Hans/auth.md index 2c1f6da24..ceea9d62c 100644 --- a/website/translated_docs/zh-Hans/auth.md +++ b/website/translated_docs/zh-Hans/auth.md @@ -1,7 +1,6 @@ --- id: authentification -date: 2017-07-10T23:36:56.503Z -title: 认证 +title: Authentification --- 认证部分设置与 "Auth" [ 插件 ](plugins.md)息息相关。包的访问限制也同时通过 [ 包访问权限](packages.md) 控制。 diff --git a/website/translated_docs/zh-Hans/cli.md b/website/translated_docs/zh-Hans/cli.md index abf6e34bb..f325ddc0f 100644 --- a/website/translated_docs/zh-Hans/cli.md +++ b/website/translated_docs/zh-Hans/cli.md @@ -1,7 +1,6 @@ --- id: cli -date: 2017-07-10T23:36:56.503Z -title: 命令行工具 +title: Command Line Tool --- Verdaccio 命令行是启动和控制此应用的工具 @@ -11,7 +10,7 @@ Verdaccio 命令行是启动和控制此应用的工具 $ verdaccio --listen 4000 --config ./config.yaml ``` -| 参数 | 默认值 | 示例 | 描述 | -| ------------------ | ---------------------------------------- | -------------------- | --------- | -| --listen \ **-l** | 4873 | -p 7000 | HTTP 监听端口 | -| --config \ **-c** | ~/home/user/.local/verdaccio/config.yaml | /foo/bar/config.yaml | 配置文件路径 | \ No newline at end of file +| 参数 | 默认值 | 示例 | 描述 | +| ------------------ | ------------------------------ | ------------- | --------- | +| --listen \ **-l** | 4873 | -p 7000 | HTTP 监听端口 | +| --config \ **-c** | ~/.local/verdaccio/config.yaml | ~/config.yaml | 配置文件路径 | \ No newline at end of file diff --git a/website/translated_docs/zh-Hans/config.md b/website/translated_docs/zh-Hans/config.md index 926f7ce17..7456c18d7 100644 --- a/website/translated_docs/zh-Hans/config.md +++ b/website/translated_docs/zh-Hans/config.md @@ -1,7 +1,6 @@ --- id: configuration -date: 2017-07-10T23:36:56.503Z -title: 配置文件 +title: Configuration File --- 此文件是 Verdaccio 的重要部分, 您可以在其中修改默认行为, 启用插件并扩展功能。 diff --git a/website/translated_docs/zh-Hans/contributing.md b/website/translated_docs/zh-Hans/contributing.md index 8b31b1029..b834509cc 100644 --- a/website/translated_docs/zh-Hans/contributing.md +++ b/website/translated_docs/zh-Hans/contributing.md @@ -1,6 +1,5 @@ --- id: contributing -date: 2017-07-10T23:36:56.503Z title: Contributing Verdaccio --- 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: * [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 @@ -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 -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 @@ -39,9 +38,9 @@ Here some ideas: * Create a common eslint rules to be used across all dependencies or plugins * Improve Flow types definitions delivery * Moving to Webpack 4 -* Update to React 16 * Improve hot reload with Webpack * We use babel and webpack across all dependencies, why not a common preset? +* Improve continous integration delivery ### 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 that will be happy to see your ideas. +Our website is based on [Docusaurus](https://docusaurus.io/). + ### I am a DevOps We have a widely popular Docker image 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. +### 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 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. diff --git a/website/translated_docs/zh-Hans/dev-plugins.md b/website/translated_docs/zh-Hans/dev-plugins.md index 6b5ba47a3..cc19d7b21 100644 --- a/website/translated_docs/zh-Hans/dev-plugins.md +++ b/website/translated_docs/zh-Hans/dev-plugins.md @@ -1,6 +1,5 @@ --- id: dev-plugins -date: 2017-07-10T23:36:56.503Z title: Developing Plugins --- There are many ways to extend `verdaccio`, currently we only support `authentication plugins` diff --git a/website/translated_docs/zh-Hans/docker.md b/website/translated_docs/zh-Hans/docker.md index 08d7ad699..bd8a94d5c 100644 --- a/website/translated_docs/zh-Hans/docker.md +++ b/website/translated_docs/zh-Hans/docker.md @@ -1,6 +1,5 @@ --- id: docker -date: 2017-07-10T23:36:56.503Z title: Docker --- 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 ``` -# Running verdaccio using Docker +## Running verdaccio using Docker 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 ``` -## 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. @@ -78,7 +77,7 @@ PORT=5000; docker run -it --rm --name 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. @@ -88,7 +87,7 @@ PROTOCOL=https; docker run -it --rm --name verdaccio \ verdaccio/verdaccio ``` -## Using docker-compose +### Using docker-compose 1. Get the latest version of [docker-compose](https://github.com/docker/compose). 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 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`. -# Docker Examples +## Docker Examples There is a separate repository that hosts multiple configurations to compose Docker images with `verdaccio`, for instance, as reverse proxy: diff --git a/website/translated_docs/zh-Hans/home.md b/website/translated_docs/zh-Hans/home.md index efb24b899..1f4eba2f5 100644 --- a/website/translated_docs/zh-Hans/home.md +++ b/website/translated_docs/zh-Hans/home.md @@ -1,7 +1,6 @@ --- id: home -date: 2017-07-10T23:36:56.503Z -title: Verdaccio 私有 npm 代理仓库 +title: Verdaccio npm proxy private registry --- diff --git a/website/translated_docs/zh-Hans/iis-server.md b/website/translated_docs/zh-Hans/iis-server.md index 69435eba0..2b94eded0 100644 --- a/website/translated_docs/zh-Hans/iis-server.md +++ b/website/translated_docs/zh-Hans/iis-server.md @@ -1,6 +1,5 @@ --- id: iss-server -date: 2017-07-10T23:36:56.503Z 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). diff --git a/website/translated_docs/zh-Hans/install.md b/website/translated_docs/zh-Hans/install.md index ac53bfdf9..72ce48199 100644 --- a/website/translated_docs/zh-Hans/install.md +++ b/website/translated_docs/zh-Hans/install.md @@ -1,7 +1,6 @@ --- id: installation -date: 2017-07-10T23:36:56.503Z -title: 安装 +title: Installation --- Verdaccio 是一个基于 Web 技术的跨平台应用，在安装它之前你需要确保满足以下前提条件 diff --git a/website/translated_docs/zh-Hans/kubernetes.md b/website/translated_docs/zh-Hans/kubernetes.md index a60d4a156..278288b43 100644 --- a/website/translated_docs/zh-Hans/kubernetes.md +++ b/website/translated_docs/zh-Hans/kubernetes.md @@ -1,6 +1,5 @@ --- id: kubernetes -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/zh-Hans/logger.md b/website/translated_docs/zh-Hans/logger.md index 8da65db62..e7a39f54c 100644 --- a/website/translated_docs/zh-Hans/logger.md +++ b/website/translated_docs/zh-Hans/logger.md @@ -1,6 +1,5 @@ --- id: logger -date: 2017-07-10T23:36:56.503Z title: Logger --- As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs. diff --git a/website/translated_docs/zh-Hans/notifications.md b/website/translated_docs/zh-Hans/notifications.md index cbf3f4933..dc283190f 100644 --- a/website/translated_docs/zh-Hans/notifications.md +++ b/website/translated_docs/zh-Hans/notifications.md @@ -1,6 +1,5 @@ --- id: notifications -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/zh-Hans/packages.md b/website/translated_docs/zh-Hans/packages.md index 4a3dcf37c..3c8175110 100644 --- a/website/translated_docs/zh-Hans/packages.md +++ b/website/translated_docs/zh-Hans/packages.md @@ -1,6 +1,5 @@ --- id: packages -date: 2017-07-10T23:36:56.503Z title: Package Access --- It's a series of contrains that allow or restrict access to the local storage based in specific criteria. diff --git a/website/translated_docs/zh-Hans/plugins.md b/website/translated_docs/zh-Hans/plugins.md index 6062772ea..a81264eab 100644 --- a/website/translated_docs/zh-Hans/plugins.md +++ b/website/translated_docs/zh-Hans/plugins.md @@ -1,6 +1,5 @@ --- id: plugins -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/zh-Hans/protect-your-dependencies.md b/website/translated_docs/zh-Hans/protect-your-dependencies.md index 2545cf347..b03b1d6e5 100644 --- a/website/translated_docs/zh-Hans/protect-your-dependencies.md +++ b/website/translated_docs/zh-Hans/protect-your-dependencies.md @@ -1,6 +1,5 @@ --- id: protect-your-dependencies -date: 2017-07-10T23:36:56.503Z title: Protecting packages --- `verdaccio` allows you protect publish, to achieve that you will need to set up correctly your [packages acces](packages). diff --git a/website/translated_docs/zh-Hans/repositories.md b/website/translated_docs/zh-Hans/repositories.md index 66dd434ad..0056ee5bf 100644 --- a/website/translated_docs/zh-Hans/repositories.md +++ b/website/translated_docs/zh-Hans/repositories.md @@ -1,6 +1,5 @@ --- id: source-code -date: 2017-07-10T23:36:56.503Z 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 diff --git a/website/translated_docs/zh-Hans/reverse-proxy.md b/website/translated_docs/zh-Hans/reverse-proxy.md index 1b689b573..bbbba2575 100644 --- a/website/translated_docs/zh-Hans/reverse-proxy.md +++ b/website/translated_docs/zh-Hans/reverse-proxy.md @@ -1,6 +1,5 @@ --- id: reverse-proxy -date: 2017-07-10T23:36:56.503Z title: Reverse Proxy Setup --- ## Apache diff --git a/website/translated_docs/zh-Hans/server.md b/website/translated_docs/zh-Hans/server.md index 4f1e2b139..7f18f5cae 100644 --- a/website/translated_docs/zh-Hans/server.md +++ b/website/translated_docs/zh-Hans/server.md @@ -1,6 +1,5 @@ --- id: server-configuration -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/zh-Hans/ssl.md b/website/translated_docs/zh-Hans/ssl.md index c118f534d..bda2c9cb6 100644 --- a/website/translated_docs/zh-Hans/ssl.md +++ b/website/translated_docs/zh-Hans/ssl.md @@ -1,6 +1,5 @@ --- id: ssl -date: 2017-07-10T23:36:56.503Z title: Set up the SSL Certificates --- Follow this instructions to configure a SSL certificate to serve NPM registry under HTTPS. diff --git a/website/translated_docs/zh-Hans/test.md b/website/translated_docs/zh-Hans/test.md index ed1a40bf2..14899af35 100644 --- a/website/translated_docs/zh-Hans/test.md +++ b/website/translated_docs/zh-Hans/test.md @@ -1,6 +1,5 @@ --- id: unit-testing -date: 2017-07-10T23:36:56.503Z title: Unit Testing --- All tests are split in three folders: diff --git a/website/translated_docs/zh-Hans/uplinks.md b/website/translated_docs/zh-Hans/uplinks.md index 335c6cca5..68c9c8e17 100644 --- a/website/translated_docs/zh-Hans/uplinks.md +++ b/website/translated_docs/zh-Hans/uplinks.md @@ -1,6 +1,5 @@ --- id: uplinks -date: 2017-07-10T23:36:56.503Z title: Uplinks --- 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: -| Property | Type | Required | Example | Support | Description | Default | -| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | ------- | -| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | | -| timeout | string | No | 100ms | all | set new timeout for the request | 30s | -| 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 | -| max_fails | number | No | 2 | all | limit maximun failure request | 2 | -| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true | -| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\]] | >= 2.5 | assigns the header 'Authorization' see: http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules | | -| headers | list | No | authorization: "Basic YourBase64EncodedCredentials==" | all | list of custom headers for the uplink | | +| Property | Type | Required | Example | Support | Description | Default | +| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | -------- | +| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | npmjs | +| timeout | string | No | 100ms | all | set new timeout for the request | 30s | +| 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 | +| max_fails | number | No | 2 | all | limit maximun failure request | 2 | +| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true | +| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\]] | >= 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 | disabled | ### You Must know diff --git a/website/translated_docs/zh-Hans/use-cases.md b/website/translated_docs/zh-Hans/use-cases.md index 5bb3a708c..b98dc1f13 100644 --- a/website/translated_docs/zh-Hans/use-cases.md +++ b/website/translated_docs/zh-Hans/use-cases.md @@ -1,6 +1,5 @@ --- id: use-cases -date: 2017-07-10T23:36:56.503Z title: Use Cases --- ## Using private packages diff --git a/website/translated_docs/zh-Hans/web.md b/website/translated_docs/zh-Hans/web.md index 1fceb6580..86b44d985 100644 --- a/website/translated_docs/zh-Hans/web.md +++ b/website/translated_docs/zh-Hans/web.md @@ -1,6 +1,5 @@ --- id: webui -date: 2017-07-10T23:36:56.503Z title: Web User Interface --- Verdaccio has a web user interface to display only the private packges and can be customisable. diff --git a/website/translated_docs/zh-Hans/windows.md b/website/translated_docs/zh-Hans/windows.md index a1c2c8506..d00273ba0 100644 --- a/website/translated_docs/zh-Hans/windows.md +++ b/website/translated_docs/zh-Hans/windows.md @@ -1,6 +1,5 @@ --- id: windows -date: 2017-07-10T23:36:56.503Z 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: diff --git a/website/translated_docs/zh-Hant/ansible.md b/website/translated_docs/zh-Hant/ansible.md index 5a01c3f9a..a198dc20e 100644 --- a/website/translated_docs/zh-Hant/ansible.md +++ b/website/translated_docs/zh-Hant/ansible.md @@ -1,6 +1,5 @@ --- id: ansible -date: 2017-07-10T23:36:56.503Z title: Installing with Ansible --- We have a customised solution for `verdaccio` in our organization. diff --git a/website/translated_docs/zh-Hant/auth.md b/website/translated_docs/zh-Hant/auth.md index 77d83ce0b..ca09f4a5e 100644 --- a/website/translated_docs/zh-Hant/auth.md +++ b/website/translated_docs/zh-Hant/auth.md @@ -1,6 +1,5 @@ --- id: authentification -date: 2017-07-10T23:36:56.503Z 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). diff --git a/website/translated_docs/zh-Hant/cli.md b/website/translated_docs/zh-Hant/cli.md index 71da2790b..4b8cf3371 100644 --- a/website/translated_docs/zh-Hant/cli.md +++ b/website/translated_docs/zh-Hant/cli.md @@ -1,6 +1,5 @@ --- id: cli -date: 2017-07-10T23:36:56.503Z title: Command Line Tool --- 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 ``` -| Command | Default | Example | Description | -| ------------------ | ---------------------------------------- | -------------------- | ---------------------- | -| --listen \ **-l** | 4873 | -p 7000 | http port | -| --config \ **-c** | ~/home/user/.local/verdaccio/config.yaml | /foo/bar/config.yaml | the configuration file | \ No newline at end of file +| Command | Default | Example | Description | +| ------------------ | ------------------------------ | ------------- | ---------------------- | +| --listen \ **-l** | 4873 | -p 7000 | http port | +| --config \ **-c** | ~/.local/verdaccio/config.yaml | ~/config.yaml | the configuration file | \ No newline at end of file diff --git a/website/translated_docs/zh-Hant/config.md b/website/translated_docs/zh-Hant/config.md index 8c7f8c24a..2c4e5f61f 100644 --- a/website/translated_docs/zh-Hant/config.md +++ b/website/translated_docs/zh-Hant/config.md @@ -1,6 +1,5 @@ --- id: configuration -date: 2017-07-10T23:36:56.503Z title: Configuration File --- This file is the cornerstone of verdaccio where you can modify the default behaviour, enable plugins and extend features. diff --git a/website/translated_docs/zh-Hant/contributing.md b/website/translated_docs/zh-Hant/contributing.md index 8b31b1029..b834509cc 100644 --- a/website/translated_docs/zh-Hant/contributing.md +++ b/website/translated_docs/zh-Hant/contributing.md @@ -1,6 +1,5 @@ --- id: contributing -date: 2017-07-10T23:36:56.503Z title: Contributing Verdaccio --- 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: * [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 @@ -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 -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 @@ -39,9 +38,9 @@ Here some ideas: * Create a common eslint rules to be used across all dependencies or plugins * Improve Flow types definitions delivery * Moving to Webpack 4 -* Update to React 16 * Improve hot reload with Webpack * We use babel and webpack across all dependencies, why not a common preset? +* Improve continous integration delivery ### 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 that will be happy to see your ideas. +Our website is based on [Docusaurus](https://docusaurus.io/). + ### I am a DevOps We have a widely popular Docker image 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. +### 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 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. diff --git a/website/translated_docs/zh-Hant/dev-plugins.md b/website/translated_docs/zh-Hant/dev-plugins.md index 6b5ba47a3..cc19d7b21 100644 --- a/website/translated_docs/zh-Hant/dev-plugins.md +++ b/website/translated_docs/zh-Hant/dev-plugins.md @@ -1,6 +1,5 @@ --- id: dev-plugins -date: 2017-07-10T23:36:56.503Z title: Developing Plugins --- There are many ways to extend `verdaccio`, currently we only support `authentication plugins` diff --git a/website/translated_docs/zh-Hant/docker.md b/website/translated_docs/zh-Hant/docker.md index 08d7ad699..bd8a94d5c 100644 --- a/website/translated_docs/zh-Hant/docker.md +++ b/website/translated_docs/zh-Hant/docker.md @@ -1,6 +1,5 @@ --- id: docker -date: 2017-07-10T23:36:56.503Z title: Docker --- 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 ``` -# Running verdaccio using Docker +## Running verdaccio using Docker 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 ``` -## 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. @@ -78,7 +77,7 @@ PORT=5000; docker run -it --rm --name 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. @@ -88,7 +87,7 @@ PROTOCOL=https; docker run -it --rm --name verdaccio \ verdaccio/verdaccio ``` -## Using docker-compose +### Using docker-compose 1. Get the latest version of [docker-compose](https://github.com/docker/compose). 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 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`. -# Docker Examples +## Docker Examples There is a separate repository that hosts multiple configurations to compose Docker images with `verdaccio`, for instance, as reverse proxy: diff --git a/website/translated_docs/zh-Hant/home.md b/website/translated_docs/zh-Hant/home.md index b41817e54..d392e09ad 100644 --- a/website/translated_docs/zh-Hant/home.md +++ b/website/translated_docs/zh-Hant/home.md @@ -1,6 +1,5 @@ --- id: home -date: 2017-07-10T23:36:56.503Z title: Verdaccio npm proxy private registry --- diff --git a/website/translated_docs/zh-Hant/iis-server.md b/website/translated_docs/zh-Hant/iis-server.md index 69435eba0..2b94eded0 100644 --- a/website/translated_docs/zh-Hant/iis-server.md +++ b/website/translated_docs/zh-Hant/iis-server.md @@ -1,6 +1,5 @@ --- id: iss-server -date: 2017-07-10T23:36:56.503Z 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). diff --git a/website/translated_docs/zh-Hant/install.md b/website/translated_docs/zh-Hant/install.md index 9d50e01e5..065f261aa 100644 --- a/website/translated_docs/zh-Hant/install.md +++ b/website/translated_docs/zh-Hant/install.md @@ -1,6 +1,5 @@ --- id: installation -date: 2017-07-10T23:36:56.503Z title: Installation --- Verdaccio is a multiplatform web application, to install you need at least some prerequisites. diff --git a/website/translated_docs/zh-Hant/kubernetes.md b/website/translated_docs/zh-Hant/kubernetes.md index a60d4a156..278288b43 100644 --- a/website/translated_docs/zh-Hant/kubernetes.md +++ b/website/translated_docs/zh-Hant/kubernetes.md @@ -1,6 +1,5 @@ --- id: kubernetes -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/zh-Hant/logger.md b/website/translated_docs/zh-Hant/logger.md index 8da65db62..e7a39f54c 100644 --- a/website/translated_docs/zh-Hant/logger.md +++ b/website/translated_docs/zh-Hant/logger.md @@ -1,6 +1,5 @@ --- id: logger -date: 2017-07-10T23:36:56.503Z title: Logger --- As any web application, verdaccio has a customisable built-in logger. You can define multiple types of outputs. diff --git a/website/translated_docs/zh-Hant/notifications.md b/website/translated_docs/zh-Hant/notifications.md index cbf3f4933..dc283190f 100644 --- a/website/translated_docs/zh-Hant/notifications.md +++ b/website/translated_docs/zh-Hant/notifications.md @@ -1,6 +1,5 @@ --- id: notifications -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/zh-Hant/packages.md b/website/translated_docs/zh-Hant/packages.md index 4a3dcf37c..3c8175110 100644 --- a/website/translated_docs/zh-Hant/packages.md +++ b/website/translated_docs/zh-Hant/packages.md @@ -1,6 +1,5 @@ --- id: packages -date: 2017-07-10T23:36:56.503Z title: Package Access --- It's a series of contrains that allow or restrict access to the local storage based in specific criteria. diff --git a/website/translated_docs/zh-Hant/plugins.md b/website/translated_docs/zh-Hant/plugins.md index 6062772ea..a81264eab 100644 --- a/website/translated_docs/zh-Hant/plugins.md +++ b/website/translated_docs/zh-Hant/plugins.md @@ -1,6 +1,5 @@ --- id: plugins -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/zh-Hant/protect-your-dependencies.md b/website/translated_docs/zh-Hant/protect-your-dependencies.md index 2545cf347..b03b1d6e5 100644 --- a/website/translated_docs/zh-Hant/protect-your-dependencies.md +++ b/website/translated_docs/zh-Hant/protect-your-dependencies.md @@ -1,6 +1,5 @@ --- id: protect-your-dependencies -date: 2017-07-10T23:36:56.503Z title: Protecting packages --- `verdaccio` allows you protect publish, to achieve that you will need to set up correctly your [packages acces](packages). diff --git a/website/translated_docs/zh-Hant/repositories.md b/website/translated_docs/zh-Hant/repositories.md index 66dd434ad..0056ee5bf 100644 --- a/website/translated_docs/zh-Hant/repositories.md +++ b/website/translated_docs/zh-Hant/repositories.md @@ -1,6 +1,5 @@ --- id: source-code -date: 2017-07-10T23:36:56.503Z 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 diff --git a/website/translated_docs/zh-Hant/reverse-proxy.md b/website/translated_docs/zh-Hant/reverse-proxy.md index 1b689b573..bbbba2575 100644 --- a/website/translated_docs/zh-Hant/reverse-proxy.md +++ b/website/translated_docs/zh-Hant/reverse-proxy.md @@ -1,6 +1,5 @@ --- id: reverse-proxy -date: 2017-07-10T23:36:56.503Z title: Reverse Proxy Setup --- ## Apache diff --git a/website/translated_docs/zh-Hant/server.md b/website/translated_docs/zh-Hant/server.md index 4f1e2b139..7f18f5cae 100644 --- a/website/translated_docs/zh-Hant/server.md +++ b/website/translated_docs/zh-Hant/server.md @@ -1,6 +1,5 @@ --- id: server-configuration -date: 2017-07-10T23:36:56.503Z 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. diff --git a/website/translated_docs/zh-Hant/ssl.md b/website/translated_docs/zh-Hant/ssl.md index c118f534d..bda2c9cb6 100644 --- a/website/translated_docs/zh-Hant/ssl.md +++ b/website/translated_docs/zh-Hant/ssl.md @@ -1,6 +1,5 @@ --- id: ssl -date: 2017-07-10T23:36:56.503Z title: Set up the SSL Certificates --- Follow this instructions to configure a SSL certificate to serve NPM registry under HTTPS. diff --git a/website/translated_docs/zh-Hant/test.md b/website/translated_docs/zh-Hant/test.md index ed1a40bf2..14899af35 100644 --- a/website/translated_docs/zh-Hant/test.md +++ b/website/translated_docs/zh-Hant/test.md @@ -1,6 +1,5 @@ --- id: unit-testing -date: 2017-07-10T23:36:56.503Z title: Unit Testing --- All tests are split in three folders: diff --git a/website/translated_docs/zh-Hant/uplinks.md b/website/translated_docs/zh-Hant/uplinks.md index 335c6cca5..68c9c8e17 100644 --- a/website/translated_docs/zh-Hant/uplinks.md +++ b/website/translated_docs/zh-Hant/uplinks.md @@ -1,6 +1,5 @@ --- id: uplinks -date: 2017-07-10T23:36:56.503Z title: Uplinks --- 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: -| Property | Type | Required | Example | Support | Description | Default | -| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | ------- | -| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | | -| timeout | string | No | 100ms | all | set new timeout for the request | 30s | -| 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 | -| max_fails | number | No | 2 | all | limit maximun failure request | 2 | -| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true | -| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\]] | >= 2.5 | assigns the header 'Authorization' see: http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules | | -| headers | list | No | authorization: "Basic YourBase64EncodedCredentials==" | all | list of custom headers for the uplink | | +| Property | Type | Required | Example | Support | Description | Default | +| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | -------- | +| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | npmjs | +| timeout | string | No | 100ms | all | set new timeout for the request | 30s | +| 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 | +| max_fails | number | No | 2 | all | limit maximun failure request | 2 | +| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true | +| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\]] | >= 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 | disabled | ### You Must know diff --git a/website/translated_docs/zh-Hant/use-cases.md b/website/translated_docs/zh-Hant/use-cases.md index 5bb3a708c..b98dc1f13 100644 --- a/website/translated_docs/zh-Hant/use-cases.md +++ b/website/translated_docs/zh-Hant/use-cases.md @@ -1,6 +1,5 @@ --- id: use-cases -date: 2017-07-10T23:36:56.503Z title: Use Cases --- ## Using private packages diff --git a/website/translated_docs/zh-Hant/web.md b/website/translated_docs/zh-Hant/web.md index 1fceb6580..86b44d985 100644 --- a/website/translated_docs/zh-Hant/web.md +++ b/website/translated_docs/zh-Hant/web.md @@ -1,6 +1,5 @@ --- id: webui -date: 2017-07-10T23:36:56.503Z title: Web User Interface --- Verdaccio has a web user interface to display only the private packges and can be customisable. diff --git a/website/translated_docs/zh-Hant/windows.md b/website/translated_docs/zh-Hant/windows.md index a1c2c8506..d00273ba0 100644 --- a/website/translated_docs/zh-Hant/windows.md +++ b/website/translated_docs/zh-Hant/windows.md @@ -1,6 +1,5 @@ --- id: windows -date: 2017-07-10T23:36:56.503Z 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: