Try an npm install

Run Écluse on your machine and install a package through it. You need Docker and an npm client.

Guide2 min read
On this page

npm | Switch to Python

1. Start the proxy#

Terminal 1

docker run --rm --name ecluse-trial \
  -p 127.0.0.1:8080:8080 \
  -e ECLUSE_MOUNTS__NPM__ENABLED=true \
  -e ECLUSE_SERVER__PUBLIC_URL=http://127.0.0.1:8080 \
  ghcr.io/alexadewit/ecluse:0.3.0 proxy

Leave this terminal open. The proxy listens only on your machine. It does not write to a package registry.

2. Install a package#

In a second terminal, create an empty directory for the trial. Then run:

Terminal 2

npm install is-number@7.0.0 --registry=http://127.0.0.1:8080/npm/

The client should install is-number@7.0.0. In the first terminal, confirm that Écluse received the request.

If the client reports no matching version or a refusal, use Investigate a failed install.

3. Check what is enabled#

This setup uses a seven-day minimum age. It has no advisory source, so known-malicious advisory checks and early security-fix admission are inactive.

The npm default also denies public versions that run install scripts. An older release can still be denied for this reason.

For a repeatable policy check, add an exact package deny to the config, restart, and repeat the request with fresh client state. The verification guide shows that check.

4. Finish the trial#

Press Ctrl + C in the first terminal to stop and remove the container. The installed files remain in your trial directory.

This trial changes no global client setting. A team deployment also needs restricted network access, a stable HTTPS address, and operational checks.

NextChoose your deployment

Search documentation