verdaccio/website

📺Verdaccio documentation website

Verdaccio website

⚠️ Project moved

https://github.com/verdaccio/verdaccio/tree/master/website

This repository has been archived

website's Issues

Docker compose from documenation gives error

Describe the bug

verdaccio | fatal--- cannot open config file /verdaccio/conf/config.yaml: Error: CONFIG: it does not look like a valid config file

To Reproduce

Steps to reproduce the behavior:
https://verdaccio.org/docs/en/docker#using-docker-compose
Use the docker compose section

docker-compose.yaml

version: '3.1'

services:
  verdaccio:
    image: verdaccio/verdaccio
    container_name: "verdaccio"
    networks:
      - node-network
    environment:
      - VERDACCIO_PORT=4873
    ports:
      - "4873:4873"
    volumes:
      - "./storage:/verdaccio/storage"
      - "./config:/verdaccio/conf"
      - "./plugins:/verdaccio/plugins"  
networks:
  node-network:
    driver: bridge

Uplinks docs should explain per-uplink proxy support.

Thank you for this great project!

Is your feature request related to a problem?
I'm uncertain whether I can configure my VPN proxy in verdaccio's config or whether I'll need to plug another proxy in between.

Describe the solution you'd like
https://verdaccio.org/docs/en/uplinks should

• explain whether and how it is possible to set a parent HTTP proxy specifically for one uplink. (My current guess: Not possible yet.)
• explain whether and how I can enforce using the HTTP CONNECT method even if the registry URL uses plain HTTP. (To circumvent a bug in the parent proxy)
• explain whether and how I can limit how many connections to that proxy verdaccio will try to open at the same time. (Concerned because npm v6 set a very bad example at that, and would abort the entire install attempt when its parent HTTP proxy refuses additional connections.)
• remind readers that https://verdaccio.org/docs/en/configuration has options for a default proxy.

Describe alternatives you've considered

Additional context
If I'm correct in assuming that the lack of documentation means lack of feature, prepare for the related feature requests.

[Question] There there any way to get the number of times a package was downloaded?

I'd like to know the download stats of my packages and was wondering if this was built in, or if I needed to do this myself somehow.

Add server conf section

More info
verdaccio/verdaccio#1207

Migrate to GatsbyJS

We have been using https://github.com/facebook/docusaurus for a very long time, I'm really proud of how they have managed to push this project in a key area, documentation.

Docusaurus v2 still does not support translations and is hard to customize. I've been working in parallel to create a dummy migration to GatsbyJS (I'll move the repo to this organization soon), if you are willing to contribute, the stack is the following.

• Typescript
• Gatsby.js
• Material-UI

Just ping me, I'll be working on this the next months.

Small fault on installation page

$> verdaccio
warn --- config file  - /home/.config/verdaccio/config.yaml
warn --- http address - http://localhost:4873/ - verdaccio/3.0.0

Should be /home/verdaccio/.config/config.yaml.

Add apiJWTmiddleware new method for auth plugins to override JWT middleware

Add doc for apiJWTmiddleware in Auth plugins.

apiJWTmiddleware(helpers: any){
    this.createAnonymousRemoteUser = helpers.createAnonymousRemoteUser;
    this.createRemoteUser = helpers.createRemoteUser;
    return this.doExternalAuth.bind(this);
  }

Example here.
verdaccio/verdaccio#1227 (review)

Put registry config on website

I recommend you put this command on your website:

npm set registry http://localhost:4873/

It's only in the git repo and not on the website as well

Typos found on documentation best-practices.md

During my labor translating documentation I found some untranslatable words, so decided to come to the source and fix'em all.

Kubernetes guide has dead links + steps for custom config doesn't seem to work

I get a 404 for the linked config file

the link https://raw.githubusercontent.com/verdaccio/verdaccio/master/conf/docker.yaml is dead,

I suppose it should probably be this one instead: https://raw.githubusercontent.com/verdaccio/verdaccio/master/packages/config/src/conf/docker.yaml

I tried completing the guide with that config instead, but and changed the title of the web ui and some other things, but it's not picked up by the container, and everything still just uses the defaults... Maybe there's something else that changed since that guide was written?

Unclear Docker instructions

Currently the Docker instructions mention sudo chown -R 10001:65533 /opt/verdaccio but this would have to be done in the container while it is running.

It should be sudo chown -R 10001:65533 /path/for/verdaccio in this case.

https://verdaccio.org/docs/en/docker.html

Docusaurus with versions does not work

https://docusaurus.io/docs/en/versioning#docsNav

Duplicate references to projects which use Verdaccio

https://verdaccio.org/docs/en/who-is-using

create-react-app and storybook are duplicated there.

translated docs img parse failed

Hi there, thanks for your tool :)
Recently, I tend to improve the translation of the Chinese version,
and saw some problem.

---

https://verdaccio.org/docs/en/docker
https://verdaccio.org/docs/zh-CN/docker

Notice that the very first image of the origin EN post is well parsed, but other translations are not.
I dived into it and thought it might be a code error.

(I will also try to debug it myself later

Migrate Docusaurus to V2

https://v2.docusaurus.io/docs/migrating-from-v1-to-v2

Webui wrong scope example in Configuration table

The webui scope example = \@myscope used to work pre v4.0. Specify it this way in >= v4.0 config.yaml will fail the JSON.parse on the client in index.html as illegal escape character.

Sample should read: "@myscope"

Note: the sample in the black-box (full web: example) is correct but not in the Configuration table.

Issue discover when migrating from v3 to v4 as behaviour changed.

Documentation for AWS installation

Is there any documentation on how to install and run Verdaccio on AWS? (EC2, ECS, Elastic Beanstalk or whatever?)

I would love to introduce Verdaccio in my company, and a cloud installation would be perfect.

New Website Design

➡️ Do you have Design skills?
➡️ Wanna re-do our website?
➡️ Wanna be part of a growing project?

We are looking for ideas and help in this area.

Installing on IIS server needs to be updated to work with v3.x

The Installing on IIS server instructions haven't been updated for Verdaccio v3.x.

I'm not sure if this is the official way to do it, but when upgrading from 2.x to 3.x, I needed to change start.js from:

process.argv.push('-l', 'unix:' + process.env.PORT);
require('./node_modules/verdaccio/src/lib/cli.js');

To:

process.argv.push('-l', 'unix:' + process.env.PORT);
require('./node_modules/verdaccio/build/lib/cli.js');

systemd service

Don't know if this is covered but the old docs don't talk about launching verdaccio as a systemd service. Yet there is a systemd directory in the repo and a unit file therein.

[Unit]
Description=verdaccio Service

[Service]
Type=simple
User=verdaccio
WorkingDirectory=/home/verdaccio
ExecStart=/usr/bin/env verdaccio
ExecStop=/usr/bin/bash -c "kill $(ps -ef | grep ^verdacc+ | awk {'print $2'})"

[Install]
WantedBy=multi-user.target

verdaccio on amazon fargate volume persistence

https://verdaccio.org/docs/en/amazon

Fargate now supports EFS as a storage backend. It would be great if you updated the docs. Thanks!

Proposal: preview builds (Netlify or Zeit)

As a contributor I want to see a preview of the changes in my PRs and branches using Netlify or Zeit.

Reference: https://github.com/DanielRuf/website/pull/1

Authentification vs authentication

Why is it called "authentification" instead of the most common form of "authentication" used in the industry?
https://verdaccio.org/docs/en/authentification

Contributing page contains a broken image

The "I can do translations" section contains an image which is not displayed.
Instead 403 - Forbidden is returned for the URL: https://d3n8a8pro7vhmx.cloudfront.net/uridu/pages/144/attachments/original/1485948891/Crowdin.png

Docker bind mount wrong chown instructions provided when verdaccio >= v4.0

Following note in the Docker-doc specifies the wrong chown user:group:

Note: Verdaccio runs as a non-root user (uid=10001) inside the container, if you use bind mount to override default, you need to make sure the mount directory is assigned to the right user. In above example, you need to run sudo chown -R 100:101 /opt/verdaccio otherwise you will get permission errors at runtime. Use docker volume is recommended over using bind mount.

This used to work pre v4.0 but, inspecting the Dockerfile for v4.0 and looking in the container shows:

• user 'verdaccio' id: 10001
• belonging to group 'nogroup' with id: 65533

So, chown instructions in the note should read: sudo chown -R 10001:65533 /opt/verdaccio

There is also an indication of this in the original note itself as it mentions uid=10001

Documentation miss-alignment on verdaccio as a service

Problem

The tips provided at the page: https://verdaccio.org/docs/en/server-configuration suggests to create an user with home directory at /var/lib/verdaccio.

However the service file present with the project verdaccio.service expectes as home directory (working directory) /home/verdaccio

Note

1. I'm assuming that is a good practice to have as working directory the same home directory
2. Also the last phrase of the page "This unit assumes you have configuration in /etc/verdaccio/config.yaml and store data in /var/lib/verdaccio, so either move your files to those locations or edit the unit." I think it's out of context

Resolution
Align the tip with the content of the service file

Add gravatar prop for web

Ref verdaccio/verdaccio#1177

Website on mobile looks broken

Remove <div id="codefund">''</div>

Within docs/ many Mardown files still have <div id="codefund">''</div> .

The reason of this was to display ads, but we don't have them anymore.

Currently there is 32 matches within /docs/*.

Broken link on the Developing Plugins page

This link is broken:

Currently it's pointing here: https://github.com/verdaccio/monorepo/tree/master/core/types

Version list, wrong links

There are wrong links on the page https://verdaccio.org/en/versions.
They are going to https://github.com/verdaccio/website, instead of https://github.com/verdaccio/verdaccio.

The reason is this commit: 864e7be which changed the projectName (used by https://github.com/verdaccio/website/blob/master/website/pages/en/versions.js#L21)

PS: Might create PR for this

feat: create a web to display security vulnerabilities

We are using GitHub new feature for this and display the new Security Policy. Somehow, we want more awareness about future patches or previous reported. This page should be in sync with GitHub Security section.

bad/missing doc for "Understanding Scopes". https://verdaccio.org/docs/en/scope

"Understanding Scopes" documentation is empty.

Improve documentation for url_prefix

url_prefix is not sufficiently described in the docs and why it is needed and in which cases.

See also verdaccio/verdaccio#698

Understanding Groups

Refers to verdaccio/verdaccio#1120

Add windows azure example info to the docs

https://medium.com/@sibeeshvenu/having-a-docker-container-as-your-private-npm-registry-the-easy-way-68159fa94cc4

Refactor User Page

I'd like to distribute our known users specially those are Open Source and separate them from companies. Something like this.

https://docusaurus.io/en/users

Currently we display some of them, but not well organised.

https://verdaccio.org/en/users.html
https://verdaccio.org/docs/en/who-is-using

A PR will include logos of all those OSS projects, links to their pages.

I want to display on front-end all OSS in first place, and second place only current official sponsors. Only one, SheetJS at this point.

Improve description about $anonymous

verdaccio/verdaccio#997

Document "TODO" for storage configuration parameter in the packages section

In https://github.com/verdaccio/website/blob/master/docs/packages.md there is still a TODO in the bottom table for parameters.

I set up a Verdaccio registry recently and thought I had to switch this to true because I wanted some scoped packages to be stored. But setting this to true caused npm publish to fail (404 error).

So it would be nice to add documentation for this parameter (or remove it as long as it's not described what it does).

Some translations are not displayed, menu is too small (russian translation)

Look at numbers at pictures:

1. Menu is too small - logo and text overlap each other.
2. Article title displayed on english (while it has translation actually)
3. Left sub-menus displayed on english
4. Footer displayed on english

Migrate website form verdaccio repo to website repo

Context

The website has been published since the begining whitin the verdaccio project (verdaccio/verdaccio#1132) and due issues on publishing typos or minor stuff we decided to move it to his own repo for easy deployment.

The new website is being published on: https://hidden.verdaccio.org/

while we do the following:

• https://crowdin.com/project/verdaccio/settings#integration
• Solve issues with versions and translations #1
• Patch is published facebook/docusaurus#1112
• Fix image issues

Dead link and outdated kubernetes documentation

On the Kubernetes page there's a link to: existing configuration which is deprecated. It also recommends to wget that file, which just has comments to visit https://verdaccio.org/docs/en/configuration