Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 2.93 KB

README.md

File metadata and controls

67 lines (46 loc) · 2.93 KB
Raw

UNPKG-SERVER

Travis Build Badge

UNPKG is a fast, global content delivery network for everything on npm.

unpkg-server

unpkg-server is a distribution of UNPKG you can run on your own network with your own private npm registry

Private Hosting

Install unpkg-server locally. (Global install is not yet supported)

npm i unpkg-server

Start the server:

node node_modules/unpkg-server/server.js \
  --NPM_REGISTRY_URL=https://private-npm-registry.example.org \
  --PORT=8081

Caution: if your registry is using self-signed certificates, you can accept the cert by setting the following flag. Use at your own risk

--NODE_TLS_REJECT_UNAUTHORIZED=0

CLI Options

These values can be set on the system environment when starting the unpkg server.js.

Flag Options / Description Default value
NPM_REGISTRY_URL optional - private registry url https://registry.npmjs.org
PORT optional - port to listen on 8080
GOOGLE_CLOUD_PROJECT The GCP project ID. null
GAE_ENV standard to enable @google-cloud/trace-agent null
DEBUG enableDebugging false
ENABLE_CLOUDFLARE optional true or false false
ORIGIN optional https://unpkg.com
CLOUDFLARE_EMAIL optional null
CLOUDFLARE_KEY optional null

Build Options

Use a .env file to set the following options when building the app with npm run build. These values will be bundled into the built server.js file.

Flag Options / Description Default value
BUILD_ENV production or development development
NODE_ENV production, staging or development development

Documentation

Please visit the UNPKG website to learn more about how to use it.

Sponsors

Our sponsors and backers are listed in SPONSORS.md.