https://github.com/npm/npme-installer
npm Enterprise installer
https://github.com/npm/npme-installer
Last synced: 10 months ago
JSON representation
npm Enterprise installer
- Host: GitHub
- URL: https://github.com/npm/npme-installer
- Owner: npm
- License: other
- Archived: true
- Created: 2014-08-26T00:02:23.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2017-09-25T17:32:33.000Z (almost 9 years ago)
- Last Synced: 2025-01-21T03:06:24.947Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/enterprise
- Size: 133 KB
- Stars: 35
- Watchers: 26
- Forks: 21
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# npm Enterprise Installer
[](https://travis-ci.org/npm/npme-installer)
One-step-installer for npm Enterprise.
## Quickstart
To get up and running as quickly as possible, [see the quickstart guide on the docs site](https://docs.npmjs.com/enterprise/intro).
## Supported Platforms
Modern versions of Ubuntu (12.04+), CentOS/RHEL (7+), Debian (7.7+)
## Prerequisites
You can find [detailed prerequisites](https://docs.npmjs.com/enterprise/requirements) on the docs site.
## Installing
* [Install Node.js via package manager](https://nodejs.org/en/download/package-manager/)
* Update npm via `sudo npm i -g npm@latest`
* Then install `npme`:
```shell
sudo npm install npme -g --unsafe
```
Once installation is complete visit __https://your-server-address:8800__ and bypass the security warning (you can provide your own certificate later to prevent this warning). You will be presented with a management UI which allows you to configure your npm Enterprise appliance.
You can find [installation details](https://docs.npmjs.com/enterprise/installation) on the docs site.
### Unattended / Automated Installations
```shell
sudo npm install npme -g --ignore-scripts
```
To perform an installation with this tool using automation tooling, you will need to specify additional arguments to the command line. Most commonly, you will need to supply:
* `-u` - the unattended install flag itself
* `-i` - the IP address of the server's eth0 interface
* `-e` - the public facing IP
The full list of command line arguments for the install command is here:
```shell
-s, --sudo should shell commands be run as sudo user
[boolean] [default: true]
-r, --release what release of replicated should be used (defaults to
stable) [string] [default: "docker"]
-d, --docker-version the specific Docker version to use [string]
-i, --internal-address the private ip address of the eth0 adapter [string]
-e, --external-address the public facing ip address for the server [string]
-p, --http-proxy sets the HTTP proxy for Docker and Replicated [string]
-u, --unattended-install allows for unattended install to succeed
```
```shell
npme install -s -u -i 172.10.1.1 -e 52.10.0.0
```
## Connecting to the Registry
By default the npm Enterprise registry will be available on __http://your-server-address:8080__.
Simply run:
```shell
npm login --scope=@my-company-name --registry=http://your-server-address:8080
```
And publish modules using the corresponding scope name:
```json
{
"name": "@my-company-name/my-module",
"repository": {
"url": "git://github.mycompany.com/myco/mypackage.git"
}
}
```
Details on [client configuration](https://docs.npmjs.com/enterprise/client-configuration) and [using npm Enterprise](https://docs.npmjs.com/enterprise/using-it) can be found on the docs site.
## Updating
Access your server via HTTPS on port 8800 and check for updates via
the management console.