Hướng dẫn build service tự quản lý node packages với Verdaccio + Docker

Hôm nay mình sẽ hướng dẫn các bạn xây dựng một server lưu trữ private các node package sử dụng Verdaccio

Ở các dự án thực tế, chúng ta hay gặp trường hợp phải tách code thành những module riêng để có thể tái sử dụng chúng ở nhiều nơi. Khi "micro hoá" sẽ xảy ra nhiều vấn đề phải quan tâm như versions của packages, phân quyền truy cập packages, hay vừa sử dụng chung được với các packages của npmjs...Với Verdaccio, lập trình viên sẽ tiết kiệm được nhiều thời gian để làm những công việc trên.

I. Verdaccio là gì?

• Hiểu đơn giản, như trang chủ Verdaccio có chú thích:

Verdaccio is a lightweight private npm proxy registry built in Node.js

• Được xây dựng trên NodeJs, Verdaccio là một open source có khả năng lưu trữ những packages + packages versions với database của riêng nó và cũng có thể đóng vai trò như một proxy tới những registry khác (như https://registry.npmjs.org/).

II. Prerequisites

• Node v12 hoặc cao hơn
• Node package manager của bạn: npm, pnpm hay yarn (lưu ý không support npm@5.x)
• Version hiện tại của Verdacccio: v5.8.0

III. Cài đặt Verdaccio

• Chạy câu lệnh sau để install (chạy 1 trong 3 tuỳ theo npm của bạn):
  • Với npm: npm install -g verdaccio
  • Với pnpm: pnpm install -g verdaccio
  • Với yarn: yarn global add verdaccio
• Mở terminal/cmd, kiểm tra cài đặt thành công bằng câu lệnh: verdaccio
  • Kết quả:
• Mặc định verdaccio sẽ chạy trên port: 4873, vào http://localhost:4873, giao diện của Verdaccio sẽ trông như thế này:

• Bây giờ chúng ta đã có thể push những package được rồi

IV. Tạo 1 package sample

• Tạo folder và đặt tên là tên package: package-sample
• Chạy câu lệnh npm init -y
• Sửa package.json như bên dưới:

• Tạo file index.js ở root folder
  

• Ở đây mình thêm 1 log ở index.js thôi nhé:

• Tiếp theo chúng ta sẽ publish lên Verdaccio, trước tiên cần config registry cho package, có những cách sau:

  • Set default registry bằng command:
    - Với npm: npm set registry http://localhost:4873/
    - Với yarn hay pnpm bạn search google cú pháp nhé

  • Thêm registry chỉ khi cần, npm install --registry http://localhost:4873

  • Define trong file .npmrc (mình dùng cách này trong bài):

  • Hoặc define ở field publishConfig trong package.json:

• Ở root sample-package project, chạy npm login, sau đó điền thông tin username, pass, email. Ở đây nếu chưa có username này thì Verdaccio sẽ tạo mới cho bạn:

• Chạy câu lệnh npm publish, khi deploy thành công terminal sẽ log ra cho bạn biết những thông tin về package như sau:

• Mở lại host UI của Verdaccio và kiểm tra, chúng ta thấy package đã được upload thành công:

V. Cài đặt package-sample từ một project khác

• Ở một project bất kì nào đó của bạn, chạy câu lệnh: npm install @your-company/package-sample --registry http://localhost:4873
• Package đã được cài đặt thành công:
• Import vào project hiện tại và kiểm tra log:

VI. Sử dụng Verdaccio với Docker

• Prerequisites: Đã cài đặt docker/docker-compose

• Tạo folder service và thêm file docker-compose.yml ở root:

• Ở root project, tạo folder conf và thêm file config.yaml và file htpasswd

  • Config sample: https://verdaccio.org/docs/configuration/#default-configuration
  • File htpasswd: để lưu thông tin user đã đăng kí khi login vào Verdaccio

• Run câu lệnh docker-compose up, docker sẽ run project trên port 4873 tạo ra folder storage ở root project. Chúng ta đã có thể publish các package lên registry. Các package được publish sẽ được lưu vào folder storage.

VII. Thêm nữa về Verdaccio

• Config.yaml
  • Verdaccio có thể là một proxy tới registry khác:
  • Authenticate và Authorization, chúng ta có thể config những user nào được access/publish package. Ví dụ bên dưới, những user login bằng teamA hoặc teamB mới có quyền publish package version mới lên Verdaccio. Access $all có nghĩa là tất cả đều có thể truy cập/download package. Lưu ý thứ tự của các packages trong config, vì các package sẽ được match từ top to bottom

• Nếu bạn install một package không có trong storage mà ở npmjs.org chẳng hạn, server sẽ cố gắng fetch package về từ registry khác bạn đã thêm trong config (e.g. npmjs.org). Nếu npmjs.org không hoạt động, server sẽ tìm kiếm chúng trong cache. Một khi một package được install thành công, chúng sẽ được cache lại ở server cho những lần tiếp theo mà không cần fetch từ npmjs.org nữa.

Trên đây mình đã hướng dẫn các bạn xây dựng một server lưu trữ package với Verdaccio + Docker. Sẽ có bài viết deploy Verdaccio bằng kubernetes, mình sẽ bổ sung sau nhé ^^

Cảm ơn các bạn đã đọc.