https://github.com/flavienbwk/npm-offline-registry-docker

Dockerized NPM / Yarn / PNPM offline registry and tools to host your dependencies.
https://github.com/flavienbwk/npm-offline-registry-docker

dependencies docker docker-compose mirror npm offline packages registry yarn

Last synced: 8 days ago
JSON representation

Dockerized NPM / Yarn / PNPM offline registry and tools to host your dependencies.

• Host: GitHub
• URL: https://github.com/flavienbwk/npm-offline-registry-docker
• Owner: flavienbwk
• Created: 2019-10-23T16:30:46.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-06-17T18:37:18.000Z (over 3 years ago)
• Last Synced: 2024-11-30T05:12:11.855Z (2 months ago)
• Topics: dependencies, docker, docker-compose, mirror, npm, offline, packages, registry, yarn
• Language: Python
• Homepage:
• Size: 20.7 MB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# NPM Offline Registry







Dockerized Yarn / NPM / PNPM offline registry to host your own dependencies online or offline.

This repository contains tools that will allow you to download dependencies you need **online** and push them **offline**.

## Getting started

### Setting up credentials for registry (offline :electric_plug:)

In order for you to be able to **push** packages to the registry, you need to create a user account.  

The default credentials are :

- Username `default`

- Password `default`

Credentials are stored in `registry/conf/htpasswd`

Optionally, you may want to add a user :

```console

apt install apache2-utils -y

htpasswd ./registry/conf/htpasswd myuser

docker-compose restart registry

```

To remove a user, just remove its line in `registry/conf/htpasswd` and restart the `registry` container

If you want to use a _bind mount_ for storing registry data, please do the following (useful if you want to backup your registry data) :

1. Edit the `docker-compose.yml` file and replace `"registry_storage:/verdaccio/storage"` by `"./registry/storage:/verdaccio/storage"`

2. Run `mkdir ./registry/storage`

3. Run `sudo chown 101:101 ./registry/storage` (see [verdaccio/verdaccio#336](https://github.com/verdaccio/verdaccio/issues/336))

### Starting the registry

Just execute :

```console

docker-compose up -d registry

```

### Downloading your dependencies (online :zap:)

You just have to **place the `/package.json` of the project** you want to get the packages from, **at the root of the directory**.

The script that downloads the packages also downloads the dependencies of each package (and their dependencies... and so on).

Then, just run :

```console

docker-compose up --build download

```

### Pushing your dependencies to your local registry (offline :electric_plug:)

This script will look into the `/packages` directory for `.tar` package files downloaded from the _downloader_ script or from the archives you've added.

Just run :

```console

docker-compose up --build push

```

### Testing if everything works (offline :electric_plug:)

You can check your registry installation with the _test_ script that will `yarn add` a package from the registry.

You can choose which package(s) to `yarn add` inside `/tester/entrypoint.sh`.

Then, just run :

```console

docker-compose up --build test

```

### Installing your offline client (offline :electric_plug:)

This one is not about Docker. Here is the command to configure any NPM/Yarn client on your network to download packages from your local registry only :

- `yarn config set registry http://localhost:4873`

OR

- `npm config set registry http://localhost:4873`