Skip to content

Commit

Permalink
feat: rebrand npm On-Site to npm Enterprise (#655)
Browse files Browse the repository at this point in the history
  • Loading branch information
bcoe authored and nexdrew committed Apr 25, 2016
1 parent 77ddf4f commit 4385e18
Show file tree
Hide file tree
Showing 22 changed files with 112 additions and 112 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ All the markdown files can be found in the [content](content) directory. Some of
- [How npm Works](content/how-npm-works)
- [Private Modules](content/private-modules)
- [Organizations](content/orgs)
- [npm On-site](content/enterprise)
- [npm Enterprise](content/enterprise)

### Copied from npm/npm
- [CLI commands](https://github.com/npm/npm/tree/master/doc/cli)
Expand Down Expand Up @@ -49,7 +49,7 @@ things from breaking.

## Sections

If you rename a directory inside the `content` directory, you'll need to change it in [sections.json](/sections.json) to allow the [content.json](/content.json) to pick up the changes.
If you rename a directory inside the `content` directory, you'll need to change it in [sections.json](/sections.json) to allow the [content.json](/content.json) to pick up the changes.

## Development

Expand Down
2 changes: 1 addition & 1 deletion content/company/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ For more information about how we handle your personal data, you may wish to rev

## Higher Levels of security

For firms interested in greater levels of physical and operational security, [npm On-Site](/enterprise) is a self-hosted version of the npm Registry that allows total control of the operation and policies of the registry.
For firms interested in greater levels of physical and operational security, [npm Enterprise](/enterprise/index) is a self-hosted version of the npm Registry that allows total control of the operation and policies of the registry.

## Contact Us

Expand Down
24 changes: 12 additions & 12 deletions content/enterprise/client-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,39 +6,39 @@ featured: true

# Configuring the CLI client

The client you use to interact with your npm On-Site server is the same client
The client you use to interact with your npm Enterprise server is the same client
that you use with the public npm registry.

## Install the latest npm client

npm On-Site requires a 2.x or newer version of the npm client. You can get this
npm Enterprise requires a 2.x or newer version of the npm client. You can get this
by running:

```
[sudo] npm install npm -g
```

<a name="pointing-your-client-to-the-registry"></a>
## Pointing your client to the On-Site registry
## Pointing your client to the Enterprise registry

Once you have an up-to-date client, you can configure it to install from and
publish to your private npm On-Site registry.
publish to your private npm Enterprise registry.

You can do this in one of two ways:

1. [Using On-Site for private _and public_ packages](#using-your-private-registry-for-all-packages)
2. [Using On-Site for private packages only](#using-your-private-registry-for-your-scoped-packages)
1. [Using Enterprise for private _and public_ packages](#using-your-private-registry-for-all-packages)
2. [Using Enterprise for private packages only](#using-your-private-registry-for-your-scoped-packages)

Read about each option below.

<a name="using-your-private-registry-for-all-packages"></a>
### Option 1: Using On-Site for private and public packages
### Option 1: Using Enterprise for private and public packages

If you want all packages, whether they are under a scope or not, to be stored in
your private registry, then you should configure the npm client to use your
private npm On-Site appliance as the top level registry.
private npm Enterprise appliance as the top level registry.

To do this, first set your On-Site registry as the CLI's default registry:
To do this, first set your Enterprise registry as the CLI's default registry:

```
npm config set registry http://myreg.mycompany.com:8080
Expand All @@ -51,17 +51,17 @@ npm login --registry=http://myreg.mycompany.com:8080
```

When clients are configured this way, they will always use your private npm
On-Site registry as their main registry. When using `npm install`, it will only
Enterprise registry as their main registry. When using `npm install`, it will only
look in the private registry to find the package.

To make sure your On-Site instance supports this functionality, you should
To make sure your Enterprise instance supports this functionality, you should
enable the "Read Through Cache" setting (enabled by default) in the server's
admin console (`https://myreg.mycompany.com:8800/settings`) so that public
packages are automatically mirrored from the public registry and automatically
added to your registry's whitelist.

<a name="using-your-private-registry-for-your-scoped-packages"></a>
### Option 2: Using On-Site for private packages only
### Option 2: Using Enterprise for private packages only

If you want to default to using the public npm registry for most packages and
only use your private registry for packages under a particular scope, then you
Expand Down
4 changes: 2 additions & 2 deletions content/enterprise/custom-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In addition to that, our GitHub integration is open source and available on

To enable a custom authentication strategy:

1. on your npm On-Site server, install the plugin in `/usr/local/lib/npme/data`
2. visit your npm On-Site server's admin console (_http://myreg.mycompany.com:8800_).
1. on your npm Enterprise server, install the plugin in `/usr/local/lib/npme/data`
2. visit your npm Enterprise server's admin console (_http://myreg.mycompany.com:8800_).
3. choose `Custom` authentication.
4. for `authentication`, `authorization`, and `session` provide the path to the plugin you've installed, e.g, `/etc/npme/data/node_modules/my-custom-plugin`
6 changes: 3 additions & 3 deletions content/enterprise/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ featured: true

## Integrates with GitHub and GitHub Enterprise

If your organization uses GitHub or GitHub Enterprise, npm On-Site can be configured
If your organization uses GitHub or GitHub Enterprise, npm Enterprise can be configured
to automatically use them for login and access control. Simply add a
repository field to your package.json that points to your repo:

Expand All @@ -20,13 +20,13 @@ repository field to your package.json that points to your repo:
}
```

npm On-Site restricts installation of your
npm Enterprise restricts installation of your
package to users who have access to the repo for that package, and restricts
publishing of that package to users who have commit access to the repo.

## Pointing at your GitHub Enterprise appliance

To point npm On-Site at your GitHub Enterprise appliance:
To point npm Enterprise at your GitHub Enterprise appliance:

1. visit the admin console at _http://myreg.mycompany.com:8800_
2. choose `GitHub` as the authentication strategy.
Expand Down
8 changes: 4 additions & 4 deletions content/enterprise/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: Introduction
featured: true
-->

# npm On-Site
# npm Enterprise

npm On-Site allows you to run npm's infrastructure behind your
npm Enterprise allows you to run npm's infrastructure behind your
company's firewall. It's designed for teams that need:

- easy internal sharing of private modules
Expand All @@ -15,9 +15,9 @@ company's firewall. It's designed for teams that need:
- compliance with legal requirements to host code on-premises
- better code discovery and sharing within their organization.

## npm On-Site is npm
## npm Enterprise is npm

npm On-Site is the same codebase that powers the public registry, it works with the same standard npm client you
npm Enterprise is the same codebase that powers the public registry, it works with the same standard npm client you
already use, but provides the features needed by larger organizations who are
now enthusiastically adopting node. It's built by npm, Inc., the sponsor of
the npm open source project and the host of the public npm registry.
34 changes: 17 additions & 17 deletions content/enterprise/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: Installing the server
featured: true
-->

# npm On-Site Installation Guide
# npm Enterprise Installation Guide

This document is meant to be a comprehensive guide to installing npm On-Site
This document is meant to be a comprehensive guide to installing npm Enterprise
onto your server. When you are done going through the steps, you should have a
usable private registry and website.

Expand All @@ -26,7 +26,7 @@ Before you get started, please make sure you have the following ready to go:
- Your license key and billing email

If you do not have a license key, please
<a href="https://www.npmjs.com/onsite#free-trial" target="_blank">register
<a href="https://www.npmjs.com/enterprise" target="_blank">register
for one here</a>.

## Summary
Expand All @@ -36,19 +36,19 @@ The installation consists of these 4 main steps.
1. Install Node.js and npm via
<a href="https://nodejs.org/en/download/package-manager/" target="_blank">
instructions here</a>
2. Install npmo: `sudo npm install npmo -g --unsafe`
3. Configure your instance via admin web console at: <br>`https:<your-server>:8800`
2. Install npme: `sudo npm install npme -g --unsafe`
3. Configure your instance via admin web console at: <br>`https://<your-server>:8800`
4. Start the services from the Dashboard there

Your npm On-Site instance will then be fully operational!
Your npm Enterprise instance will then be fully operational!

## Details

Follow along for details of each of the 4 main steps.

### 1. Install Node.js and npm on your server

Node.js and npm are required to run the `npmo` installer in the next main step.
Node.js and npm are required to run the `npme` installer in the next main step.

- SSH into your server

Expand Down Expand Up @@ -98,18 +98,18 @@ Node.js and npm are required to run the `npmo` installer in the next main step.
$ sudo npm install npm@latest -g
```
### 2. Install npmo on your server
### 2. Install npme on your server
npm On-Site is distributed via the `npmo` package, which acts as an installer
npm Enterprise is distributed via the `npme` package, which acts as an installer
and CLI tool. It will automatically install Docker and an orchestration layer
that comes with its own CLI (`replicated`) and runs an admin web console on
port `8800` of your server. Once `npmo` is installed, you will need to complete
port `8800` of your server. Once `npme` is installed, you will need to complete
the installation by configuring your instance using the admin web console.
- Use npm to install `npmo`:
- Use npm to install `npme`:
```
$ sudo npm install npmo -g --unsafe
$ sudo npm install npme -g --unsafe
```
Note that the installer may prompt you on whether or not a proxy should be
Expand Down Expand Up @@ -158,7 +158,7 @@ If any are not up, try running the installer again. On some systems, it's
possible that dependencies may not be loaded in the correct order the first time.
Once you have confirmed the daemons are running, there will be an admin web
console listening on port `8800`. You can now use it to configure your On-Site
console listening on port `8800`. You can now use it to configure your Enterprise
instance and complete the installation.
### 3. Configure your installation via the admin web console
Expand Down Expand Up @@ -188,7 +188,7 @@ console and activate your instance with your license key.
When you signed up for a license, the key was displayed on the npm website
and sent to the billing email address you provided. This information is
needed to validate your license and activate your server instance. Note that
a single license will allow you to run multiple instances of npm On-Site.
a single license will allow you to run multiple instances of npm Enterprise.
![Validate License](/images/npmo-install2.png)
Expand All @@ -213,7 +213,7 @@ console and activate your instance with your license key.
The registry will bind to port `8080` and the website will bind to port
`8081` on your server. However, it is typical to put a routing layer or
load balancer in front of your On-Site instance that will use a DNS name
load balancer in front of your Enterprise instance that will use a DNS name
and port of your choosing, possibly terminating SSL/TLS there. The
front-facing URLs you choose for your network topology should be entered
here. **Note** that these values will be stored with package metadata
Expand All @@ -234,7 +234,7 @@ console and activate your instance with your license key.
- **Authentication**
npm On-Site supports several strategies for authentication and
npm Enterprise supports several strategies for authentication and
authorization, leveraging the credentials and permissions you have
already defined in another backing system.
Expand Down Expand Up @@ -272,7 +272,7 @@ top-left panel does not say "Starting", then hit the "Start Now" button.
![Dashboard Metrics](/images/npmo-install7.png)
Your npm On-Site registry is ready to use!
Your npm Enterprise registry is ready to use!
- Verify registry and website
Expand Down
40 changes: 20 additions & 20 deletions content/enterprise/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ title: Quickstart
featured: true
-->

# npm On-Site Quickstart
# npm Enterprise Quickstart

This is the fastest way to get started with npm On-Site - your own private npm registry and website!
This is the fastest way to get started with npm Enterprise - your own private npm registry and website!

## tl;dr

Here's what we're going to cover in this guide:

1. [Install npm On-Site on your server](#1-install)
2. [Configure and start your On-Site instance](#2-configure-server)
1. [Install npm Enterprise on your server](#1-install)
2. [Configure and start your Enterprise instance](#2-configure-server)
3. [Configure the npm CLI to talk to your registry](#3-configure-client)
4. [Publish, install, and search for packages](#4-use)

Expand All @@ -24,7 +24,7 @@ Here's a quick video to help walk you through this process:
<iframe width="640" height="480" src="https://www.youtube.com/embed/mKMaG0cixXw" frameborder="0" allowfullscreen></iframe>

<a name="1-install"></a>
## 1. Install npm On-Site on your server
## 1. Install npm Enterprise on your server

- Provision a modern Linux server fulfilling the [prereqs](/enterprise/requirements)

Expand Down Expand Up @@ -58,20 +58,20 @@ Here's a quick video to help walk you through this process:
$ node -v && npm -v
```
- Use npm to install `npmo`
- Use npm to install `npme`
```
$ sudo npm install npmo -g --unsafe
$ sudo npm install npme -g --unsafe
```
Watch for and answer any prompts.
This will install Docker and run an admin web console on port 8800, which you will use to configure your On-Site instance and complete the installation below.
This will install Docker and run an admin web console on port 8800, which you will use to configure your Enterprise instance and complete the installation below.
<a name="2-configure-server"></a>
## 2. Configure and start your On-Site instance
## 2. Configure and start your Enterprise instance
- Get a license key by <a href="https://www.npmjs.com/onsite#free-trial" target="_blank">signing up</a> for a free trial license
- Get a license key by <a href="https://www.npmjs.com/enterprise" target="_blank">signing up</a> for a free trial license
You will need a license key to continue.
Expand Down Expand Up @@ -101,7 +101,7 @@ Here's a quick video to help walk you through this process:
- Quickly verify that your registry is running and accessible
Either run `curl http://<your-server>:8080` or visit that url in your browser. If you get a JSON response, your On-Site registry is good to go!
Either run `curl http://<your-server>:8080` or visit that url in your browser. If you get a JSON response, your Enterprise registry is good to go!
<a name="3-configure-client"></a>
## 3. Configure the npm CLI to talk to your registry
Expand All @@ -121,7 +121,7 @@ Here's a quick video to help walk you through this process:
Email: (this IS public) [email protected]
```
The username, password, and email you use should respect the configured authentication strategy in your On-Site admin web console. If using the "Open" authentication strategy, any values will work.
The username, password, and email you use should respect the configured authentication strategy in your Enterprise admin web console. If using the "Open" authentication strategy, any values will work.
Note that this will add content to your [`.npmrc`](/files/npmrc) file, similar to the following:
Expand All @@ -130,11 +130,11 @@ Here's a quick video to help walk you through this process:
//<your-server>:8080/:_authToken=abc123
```
With this in place, any publishes or installs of packages with the `@myco` scope will automatically go to or come from your private On-Site registry.
With this in place, any publishes or installs of packages with the `@myco` scope will automatically go to or come from your private Enterprise registry.
For more details on configuring the npm client for your On-Site registry, see [this page](/enterprise/client-configuration).
For more details on configuring the npm client for your Enterprise registry, see [this page](/enterprise/client-configuration).
- Optionally set your On-Site registry as your primary registry
- Optionally set your Enterprise registry as your primary registry
```
$ npm config set registry http://<your-server>:8080
Expand All @@ -146,14 +146,14 @@ Here's a quick video to help walk you through this process:
registry=http://<your-server>:8080/
```
With this in place, all installs will go through your On-Site registry.
With this in place, all installs will go through your Enterprise registry.
If using this option, you should make sure the "Read Through Cache" setting is enabled (default) in the admin console of your server.
<a name="4-use"></a>
## 4. Publish, install, and search for packages
- Publish a scoped package to your On-Site registry
- Publish a scoped package to your Enterprise registry
Create a test package named after your scope and `npm publish` it. Here's an example:
Expand All @@ -167,9 +167,9 @@ Here's a quick video to help walk you through this process:
Visit your registry's website at `http://<your-server>:8081/` and find the `@myco/test-pkg` package under "recently updated packages".
For more details on publishing packages to your On-Site registry, see [this page](/enterprise/using-it).
For more details on publishing packages to your Enterprise registry, see [this page](/enterprise/using-it).
- Install a scoped package from your On-Site registry
- Install a scoped package from your Enterprise registry
Verify you can install the test package created above. Go to another directory and `npm install` it.
Expand All @@ -191,4 +191,4 @@ Here's a quick video to help walk you through this process:
- Search for package using the website
Visit your registry's website at `http://<your-server>:8081/` and use the "find on-site packages" search bar at the top.
Visit your registry's website at `http://<your-server>:8081/` and use the search bar at the top.
Loading

0 comments on commit 4385e18

Please sign in to comment.