iwfwebsolutions/verdaccio repository overview

⁠Docker Verdaccio (with Plugins required for IWF)

This is a Docker image for Verdaccio⁠ (a lightweight private npm proxy registry) with some plugins required for IWF⁠.

⁠Getting Started

These instructions will help you install this library in your project and tell you how to use it.

⁠Prerequisites

Before using this Docker Verdaccio setup, ensure you have the following installed:

• Docker (version 20.10 or later) - Install Docker⁠
• Docker Compose (version 2.0 or later) - Install Docker Compose⁠
• Git - For cloning the repository
• SSH Keys (optional) - Configured for GitLab authentication if you plan to use GitLab auth

For production builds, you'll also need:

• Docker Buildx - For multi-platform builds (usually included with Docker Desktop)

⁠Installing

⁠Option 1: Clone and Build Locally

1. Clone the repository:

   git clone https://github.com/iwf-web/docker-verdaccio.git
   cd docker-verdaccio
   

   Copy

2. Build and run with Docker Compose (recommended for development):

   docker compose up --build
   

   Copy

   This will:

   • Build the Verdaccio image with plugins
   • Start MinIO (S3-compatible storage) for local development
   • Create necessary S3 buckets automatically
   • Start Verdaccio on port 4873

3. Build for production:

   ./bin/build-ci.sh --version 6.1.0
   

   Copy

⁠Option 2: Use Pre-built Image

If available from the registry:

docker pull iwfwebsolutions/verdaccio:latest

⁠Usage

⁠Starting the Service

1. Development Mode (with local MinIO S3 storage):

   docker compose up
   

   Copy

   Access points:

   • Verdaccio Web UI: http://localhost:4873⁠
   • MinIO Console: http://localhost:9001⁠ (admin/admin123 or minio/minio123)

2. Production Mode:

   Configure your environment variables and run:

   docker run -p 4873:4873 \
     -e AWS_S3_BUCKET=your-bucket \
     -e AWS_ACCESS_KEY_ID=your-key \
     -e AWS_SECRET_ACCESS_KEY=your-secret \
     iwfwebsolutions/verdaccio:latest
   

   Copy

⁠Configuring NPM/Yarn Clients

1. Set the registry URL:

   npm config set registry http://localhost:4873
   # or for yarn
   yarn config set registry http://localhost:4873
   

   Copy

2. Login with GitLab credentials:

   npm login --registry http://localhost:4873
   

   Copy

   Use your GitLab username and personal access token.

⁠Publishing Packages

npm publish --registry http://localhost:4873

⁠Authentication

This setup uses GitLab authentication against https://git.iwf.io. Users can authenticate using their GitLab credentials:

• Username: Your GitLab username
• Password: GitLab personal access token with read_api scope

⁠Storage

• Development: Uses MinIO (S3-compatible) running locally
• Production: Configured for AWS S3 storage with environment variables

⁠Running the tests

⁠Code style

brew install hadolint
hadolint src/Dockerfile

⁠Built With

• Verdaccio⁠ - Private npm proxy registry

⁠Contributing

Please read CONTRIBUTING.md⁠ for details on our code of conduct and the process for submitting pull requests.

This project uses Conventional Commits⁠.

⁠Versioning

We use SemVer⁠ for versioning. For available versions, see the tags on this repository⁠.

⁠Authors

⁠Special thanks for all the people who had helped this project so far

• Manuele - D3strukt0r⁠

See also the full list of contributors⁠ who participated in this project.

⁠I would like to join this list. How can I help the project?

We're currently looking for contributions for the following:

• Bug fixes
• Translations
• etc...

For more information, please refer to our CONTRIBUTING.md⁠ guide.

⁠License

This project is licensed under the MIT License - see the LICENSE.txt⁠ file for details.

⁠Acknowledgments

This project currently uses no third-party libraries or copied code.