Faça deploy de Verdaccio em um clique

O que é Verdaccio?

O Verdaccio é um registry npm privado e leve, que equipes e desenvolvedores solo rodam no lugar dos pacotes privados pagos do npm, do GitHub Packages ou do JFrog Artifactory. Você publica pacotes nele com npm publish e instala com npm, yarn ou pnpm como se fosse do npmjs. Ele não precisa de banco de dados: os pacotes e seus metadados são arquivos no disco dele.

Ele também é um proxy do registry público: um pacote que ele não tem vem do npmjs pelo uplink e fica guardado, então as próximas instalações saem do Verdaccio, não do npmjs, e um escopo como @seunome pode continuar privado enquanto todo o resto vem do npm. A página web dele mostra o readme, as versões e as dependências de cada pacote.

Este template roda o Verdaccio com o armazenamento num volume e uma única conta, com o usuário e a senha que você informa, gravados no arquivo htpasswd dele a cada inicialização. O cadastro está desativado, e os pacotes, os seus e os do npm, só podem ser lidos e instalados por um usuário que entrou, então o registry não é um espelho aberto para estranhos.

Hospedagem de Verdaccio no Pethost

1. Você entra no Pethost com uma passkey, GitHub ou Google. Ainda não tem máquina? Você escolhe um plano, e o link espera até ela ficar pronta.
2. Novo projeto abre em Verdaccio. Você preenche o que ele pede e clica em Criar projeto: Usuário, Senha do administrador.
3. Em um ou dois minutos Verdaccio está no ar no próprio endereço com HTTPS. Os segredos são gerados ao acaso, e os dados vão para o backup noturno.
4. É um projeto como qualquer outro: você ou seu agente podem alterá-lo, fazer rollback ou restaurá-lo.

Perguntas sobre Verdaccio

Arquivo Docker Compose de Verdaccio

O template é este compose.yaml e as variáveis gravadas no .env do projeto quando ele é criado. O Pethost roda o arquivo exatamente como está escrito.

Containers: verdaccio (verdaccio/verdaccio:6).

Volumes, no backup noturno: storage.

services:
  verdaccio:
    image: verdaccio/verdaccio:6
    restart: unless-stopped
    environment:
      VERDACCIO_PUBLIC_URL: ${URL}
      ADMIN_USERNAME: ${ADMIN_USERNAME}
      ADMIN_PASSWORD: ${ADMIN_PASSWORD}
    # The administrator's line of the htpasswd file is written from the username and password
    # given at every start, so its password is the one in the project's .env; the other lines,
    # users the administrator added, stay as they are.
    command:
      - /bin/sh
      - -c
      - |
        node -e '
          const fs = require("node:fs");
          const bcrypt = require("/usr/local/lib/node_modules/verdaccio/node_modules/bcryptjs");
          const file = "/verdaccio/storage/htpasswd";
          const { ADMIN_USERNAME: name, ADMIN_PASSWORD: password } = process.env;
          const lines = fs.existsSync(file) ? fs.readFileSync(file, "utf8").split("\n") : [];
          const others = lines.filter((line) => line && !line.startsWith(name + ":"));
          fs.writeFileSync(file, [...others, name + ":" + bcrypt.hashSync(password, 10)].join("\n") + "\n", { mode: 0o600 });
        ' || exit 1
        unset ADMIN_PASSWORD
        exec verdaccio --config /verdaccio/conf/config.yaml --listen http://0.0.0.0:4873
    configs:
      - source: config
        target: /verdaccio/conf/config.yaml
    volumes:
      - storage:/verdaccio/storage

configs:
  config:
    content: |
      storage: /verdaccio/storage/data
      plugins: /verdaccio/plugins
      web:
        title: Verdaccio
      auth:
        htpasswd:
          file: /verdaccio/storage/htpasswd
          # Nobody signs up with npm adduser: users are lines of the file, which the administrator adds.
          max_users: -1
      uplinks:
        npmjs:
          url: https://registry.npmjs.org/
      # Only users who signed in install or publish, so the registry is no open mirror of npm.
      packages:
        '@*/*':
          access: $$authenticated
          publish: $$authenticated
          unpublish: $$authenticated
          proxy: npmjs
        '**':
          access: $$authenticated
          publish: $$authenticated
          unpublish: $$authenticated
          proxy: npmjs
      server:
        keepAliveTimeout: 60
      middlewares:
        audit:
          enabled: true
      log:
        type: stdout
        format: pretty
        level: http

volumes:
  storage:

compose.yamlVer no GitHub