ローカルにnpm registryを構築する方法はいくつかありますが、結構有名らしいVerdaccioを使って構築するための備忘録
ブログとかQiitaにも記事はあるんだけど肝心な設定が抜けていたりしていたのでその辺も載せておきます
目次
- configファイルを修正する
- [local registryのproxyを追加](#local registry のproxyを追加)
- [npm package問い合わせをlocal優先にする](#npm package問い合わせをlocal優先にする)
- 外部アクセスを受け付けるにはこれが必須
- [npm userを作成する](#npm userを作成する)
- [local registryに公開・削除する](#local registryに公開・削除する)
構築環境
- Linux mint 19.1
- node.js 8.10.0
- npm 3.5.2
必要なパッケージのインストール
npmのインストール
Verdaccioはnpm packageの一つなので大前提としてnpmをインストールしておく必要があります
(インストール済みであればスキップ)
sudo apt update && sudo apt install -y npm
verdaccioのインストール
npmをインストールし終わったらverdaccioをグローバルインストールします
sudo npm i -g verdaccio
verdaccioの設定
標準のサービスファイルをsystemdにコピーする
sudo cp /usr/local/lib/node_modules/verdaccio/systemd/verdaccio.service /etc/systemd/system/
Server Configuration・Verdaccioを参考にしていたのですが、どうやらLinux mintではサービスファイルの格納ディレクトリやsystemdディレクトリが違っていたので上記の様になりました
ディストロによって公式と同じディレクトリにあり、変更する必要がないかもしれないので適宜読み替えてください
公式のコマンドはこちら
sudo cp /usr/lib/node_modules/verdaccio/systemd/verdaccio.service /lib/systemd/system/
コピーしたサービスファイルを修正する
このままだとサービスを実行してもエラーを吐かれてしまうので下記画像の様に書き換えます
ExecStartに指定している実行ファイルの場所やconfigファイルの場所を変更しています
(verdaccioの実体がディストロによって変わるのか分かりませんが、Linux mintでは上記ディレクトリに配置されています)
configについては後程verdaccioを実行すると、ホーム直下の**.config/**以下に自動生成されるのでそれを割り当てています
一旦verdaccioを起動させる
verdaccioと打ち込んで起動させます
すると先ほども書いたように**$HOME/.config/verdaccio/config.yaml**が生成されているかと思います
configファイルを修正する
configファイルの生成を確認したら停止させるか別のターミナルを開き、以下の様に修正します
(ユーザー名がgn5rなので適宜読み替えてください)
storage: /home/gn5r/.local/share/verdaccio/storage
plugins: ./plugins
web:
title: Verdaccio
storage: /home/gn5r/.local/share/verdaccio/storage
plugins: ./plugins
web:
title: Verdaccio
auth:
htpasswd:
file: ./htpasswd
uplinks:
npmjs:
url: https://registry.npmjs.org/
local:
url: http://localhost:4783/
packages:
'@*/*':
# scoped packages
access: $all
publish: $authenticated
unpublish: $authenticated
proxy: local
'**':
access: $all
publish: $authenticated
unpublish: $authenticated
proxy: local
server:
keepAliveTimeout: 60
middlewares:
audit:
enabled: true
listen: 0.0.0.0:4783
local registry のproxyを追加
これがキモでlocal registryと公式registryを両立させるためにproxyを追加
uplinks:
local:
url: http://localhost:4783/
npm package問い合わせ先をlocal優先にする
この部分でパッケージ問い合わせをlocal registry優先にしています。見つからなかったら公式registryに問い合わせる感じ
packages:
'@*/*':
# scoped packages
access: $all
publish: $authenticated
unpublish: $authenticated
proxy: local
'**':
access: $all
publish: $authenticated
unpublish: $authenticated
proxy: local
外部アクセスを受け付けるにはこれが必須
この設定をしないと開発マシンからverdaccioサーバーのwebページにアクセスできなかったり不便なのでほぼ必須です
(最初ちゃんと調べずにやっていたらエラーが出て、それをTwitterでボヤいたら公式が教えてくれました)
また、ポートを変えたい場合もここで設定できます(デフォルトは4873)
listen: 0.0.0.0:4783
verdaccioをサービスに登録する
起動と自動起動の設定
以下3つを実行しverdaccioを起動&自動起動を有効にする
sudo systemctl daemon-reload
sudo systemctl start verdaccio
sudo systemctl enable verdaccio
動作確認
ポートを変えていなければブラウザを開いてIPアドレス:4873にアクセスするとverdaccioのwebページが表示されればOK
(画像ではポートを変えてあるので4783にアクセスしています)
registryを追加する
ここにも書いてありますが、構築したregistryを追加する方法はいくつかあるようです
パッケージ毎に分けたい場合
パッケージ(プログラム)以下のpackage.jsonがあるディレクトリの.npmrcにregistry=http://IPアドレス:4783を追記(無ければ作成)
グローバルに設定する場合
npm set registry http://IPアドレス:4783を実行
npmコマンド実行時に毎回registryの引数を渡す場合
各npmコマンド実行時に--registry http://IPアドレス:4783を付与
npm userを作成する
新規作成の場合
npm adduser --registry http://IPアドレス:4783
ユーザー名とパスワード、Emailを入力すれば完了(パスワードは1回入力)
ログインする場合
別マシンで作成したユーザーを使いたい場合は
npm login --registry http://IPアドレス:4783
local registryに公開・削除する
設定でlocalを優先にしているので、試しに--registryを付けずにpublish、unpublishしてみたけど途中で止まってしまったので、--registryは必須かと思います
(多分公式のregistryにも投げているのかもしれない。公式のaccessTokenは無いので認証部分で止まっているのかと推測しています)
公開
package.jsonがあるディレクトリで
npm publish --registry http://IPアドレス:4783
公開されているパッケージを削除する
npm unpublish --force パッケージ名 --registry http://IPアドレス:4783