Document how to install plugins

Is your feature request related to a problem?

I just started using Verdaccio on an AWS Amazon Linux 2 EC2 instance and I have no idea on how to install plugins.

I installed Verdaccio using npm install -g verdaccio and it runs fine, I can access the web interface.

Now I want to add the github oauth plugin but I have no idea on how to get this working. I tried

npm install -g verdaccio-github-oauth-ui

and modifying the config file for this plugin, but restarting Verdaccio only gives me:

Error: verdaccio-github-oauth-ui plugin not found. try "npm install verdaccio-github-oauth-ui"

I saw there is a plugins directory in the config file, but I have no idea how to install a plugin there, as running an npm install in that directory will just create a node_modules subdirectory containing the plugin and all its dependencies. (I tried this too btw and it also didn’t work)

Describe the solution you’d like I would like to see a few lines of documentation on how to install plugins, the same way the installation of Verdaccio itself is clearly explained. The only ones I find are about using Docker and extending the image to add plugins.

Thanks a lot!

[johanhelsing-attensi]

Thanks @tommcc !

I managed to adapt your solution so I could use it in a Dockerfile instead

This is what I currently do

FROM verdaccio/verdaccio
USER root
ENV NODE_ENV=production
RUN npm install -g --no-bin-links --prefix /tmp/verdaccio-auth-memory-install verdaccio-auth-memory \
    && mv /tmp/verdaccio-auth-memory-install/lib/node_modules/verdaccio-auth-memory /verdaccio/plugins \
    && chown -R $VERDACCIO_USER_UID:root /verdaccio/plugins \
    && rm -rf /tmp/verdaccio-auth-memory-install
USER verdaccio

It’s pretty ugly, but I think I prefer it over having to deal with setting up a plugin volume

[stephen-dahl]

adapting your adaption into a multistage build 😉

FROM verdaccio/verdaccio:5 as builder
USER root
ENV NODE_ENV=production

RUN apk add alpine-sdk python
RUN npm i --global-style verdaccio-bitbucket

FROM verdaccio/verdaccio:5
COPY config.yaml /verdaccio/conf/config.yaml
COPY --from=builder --chown=$VERDACCIO_USER_UID:root /opt/verdaccio/node_modules/verdaccio-bitbucket /verdaccio/plugins/verdaccio-bitbucket