1
0
mirror of https://github.com/verdaccio/verdaccio.git synced 2025-02-17 03:19:36 +01:00

docs: update and fix several pages

This commit is contained in:
Juan Picado @jotadeveloper 2018-01-09 18:00:47 +01:00
parent b37f05f11d
commit c9d1892d66
No known key found for this signature in database
GPG Key ID: 18AC54485952D158
25 changed files with 28 additions and 39 deletions

@ -1,6 +1,5 @@
---
id: ansible
date: '2017-07-10T23:36:56.503Z'
title: "Installing with Ansible"
---

@ -1,6 +1,5 @@
---
id: authentification
date: '2017-07-10T23:36:56.503Z'
title: "Authentification"
---

@ -1,6 +1,5 @@
---
id: cli
date: '2017-07-10T23:36:56.503Z'
title: "Command Line Tool"
---
@ -15,4 +14,4 @@ $ 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
--config \ **-c** | ~/.local/verdaccio/config.yaml | ~/config.yaml | the configuration file

@ -1,6 +1,5 @@
---
id: configuration
date: '2017-07-10T23:36:56.503Z'
title: "Configuration File"
---

@ -1,6 +1,5 @@
---
id: contributing
date: '2017-07-10T23:36:56.503Z'
title: "Contributing Verdaccio"
---
@ -11,7 +10,7 @@ First of all 👏👏 thanks for visiting this page, for us means you are willin
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
@ -29,7 +28,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
@ -40,9 +39,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
@ -52,12 +51,26 @@ Many contributors find typos and grammar issues, that also helps to improve the
We have a frontend website [http://www.verdaccio.org/](http://www.verdaccio.org/) that will be happy to see your ideas.
Our website is based on [Docusaurus](https://docusaurus.io/).
### I am a DevOps
We have a widely popular Docker image [https://hub.docker.com/r/verdaccio/verdaccio/](https://hub.docker.com/r/verdaccio/verdaccio/) that need maintenance and pretty likely huge improvements, we need your knowledge for the benefits of all users.
We have support for **Kubernetes**, **Puppet**, **Ansible** and **Cheff** and we need help in those fields, feel free to see all repositories.
### 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.

@ -1,6 +1,5 @@
---
id: dev-plugins
date: '2017-07-10T23:36:56.503Z'
title: "Developing Plugins"
---
@ -68,4 +67,4 @@ module.exports = Auth;
## Middleware Integration
// in progress
// in progress

@ -1,6 +1,5 @@
---
id: docker
date: '2017-07-10T23:36:56.503Z'
title: Docker
---
@ -40,7 +39,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:
```bash
@ -60,7 +59,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.
If you want to reach verdaccio docker instance under different port, lets say `5000`
@ -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:
@ -115,7 +114,7 @@ $ docker volume inspect verdaccio_verdaccio
```
# Build your own Docker image
## Build your own Docker image
```bash
docker build -t verdaccio .
@ -139,7 +138,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:

@ -1,6 +1,5 @@
---
id: home
date: '2017-07-10T23:36:56.503Z'
title: "Verdaccio npm proxy private registry"
---

@ -1,6 +1,5 @@
---
id: iss-server
date: '2017-07-10T23:36:56.503Z'
title: "Installing on IIS server"
---

@ -1,6 +1,5 @@
---
id: installation
date: '2017-07-10T23:36:56.503Z'
title: "Installation"
---

@ -1,6 +1,5 @@
---
id: kubernetes
date: '2017-07-10T23:36:56.503Z'
title: "Kubernetes"
---

@ -1,6 +1,5 @@
---
id: logger
date: '2017-07-10T23:36:56.503Z'
title: "Logger"
---

@ -1,6 +1,5 @@
---
id: notifications
date: '2017-07-10T23:36:56.503Z'
title: "Notifications"
---

@ -1,6 +1,5 @@
---
id: packages
date: '2017-07-10T23:36:56.503Z'
title: "Package Access"
---

@ -1,6 +1,5 @@
---
id: plugins
date: '2017-07-10T23:36:56.503Z'
title: "Plugins"
---

@ -1,6 +1,5 @@
---
id: protect-your-dependencies
date: '2017-07-10T23:36:56.503Z'
title: "Protecting packages"
---

@ -1,6 +1,5 @@
---
id: source-code
date: '2017-07-10T23:36:56.503Z'
title: "Source Code"
---

@ -1,6 +1,5 @@
---
id: reverse-proxy
date: '2017-07-10T23:36:56.503Z'
title: "Reverse Proxy Setup"
---

@ -1,6 +1,5 @@
---
id: server-configuration
date: '2017-07-10T23:36:56.503Z'
title: "Server Configuration"
---

@ -1,6 +1,5 @@
---
id: ssl
date: '2017-07-10T23:36:56.503Z'
title: "Set up the SSL Certificates"
---

@ -1,6 +1,5 @@
---
id: unit-testing
date: '2017-07-10T23:36:56.503Z'
title: "Unit Testing"
---

@ -1,6 +1,5 @@
---
id: uplinks
date: '2017-07-10T23:36:56.503Z'
title: "Uplinks"
---
@ -26,14 +25,14 @@ You can define mutiple uplinks and each of them must have an unique name (key).
Property | Type | Required | Example | Support | Description | Default
--- | --- | --- | --- | --- | --- | ---
url | string | Yes | https://registry.npmjs.org/ | all | The registry url |
url | string | Yes | https://registry.npmjs.org/ | all | The registry url | npmjs
timeout | string | No | 100ms | all | set new timeout for the request | 30s
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,\<get name process.env\>]] | >= 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 |
auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\<get name process.env\>]] | >= 2.5 | assigns the header 'Authorization' see: http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules | disabled
headers | list | No | authorization: "Basic YourBase64EncodedCredentials==" | all | list of custom headers for the uplink | disabled
### You Must know

@ -1,6 +1,5 @@
---
id: use-cases
date: '2017-07-10T23:36:56.503Z'
title: "Use Cases"
---

@ -1,6 +1,5 @@
---
id: webui
date: '2017-07-10T23:36:56.503Z'
title: "Web User Interface"
---

@ -1,6 +1,5 @@
---
id: windows
date: '2017-07-10T23:36:56.503Z'
title: "Installing As a Windows Service"
---