enterprise: remove npm Enterprise documentation
The npm Enterprise product is no more; remove its documentation.
Edward Thomson committed
Sep 27, 2021 at 15:28 UTC
2af1b6440c9179fd6a49d3640625dad5e972935f
35 files changed
+34
-687
content/about-npm/index.mdx
+3
-1
@@ -40,7 +40,9 @@ After you set up an npm account, the next step is to use the command line interf
40
41
## Sharing packages and collaborating with others
42
43
-If you choose to share your packages publicly, there is no cost. To use and share private packages, you need to upgrade your account. To share with others, create organizations, called **[npm organizations][orgs-docs]**, and invite others to work with you, privately (for a fee) or publicly (for free). Or you can sign up for a private instance of npm for your company, called **[npm Enterprise](https://npmjs.com/enterprise)**, so you can develop packages internally that are not shared publicly.
43
+If you choose to share your packages publicly, there is no cost. To use and share private packages, you need to upgrade your account. To share with others, create organizations, called **[npm organizations][orgs-docs]**, and invite others to work with you, privately (for a fee) or publicly (for free).
44
+
45
+You can also use a private npm package registry like [GitHub Packages](https://github.com/features/packages) or the open source [Verdaccio](https://verdaccio.org) project. This lets you develop packages internally that are not shared publicly.
46
47
## Learn more
48
content/enterprise/billing-and-seat-management/index.mdx
deleted
-5
@@ -1,5 +0,0 @@
1
----
2
-title: Billing and seat management
3
----
4
-
5
-<Index />
content/enterprise/billing-and-seat-management/purchasing-or-removing-seats.mdx
deleted
-10
@@ -1,10 +0,0 @@
1
----
2
-title: Purchasing or removing seats
3
----
4
-
5
-As an npm Enterprise billing manager, you can purchase additional seats for your instance, or remove seats you no longer need. If you remove seats, the credit card on file will not be charged for them starting with the next billing cycle.
6
-
7
-To purchase or remove seats for your instance, contact your npm account manager or our [Sales team][sales-contact-form].
8
-
9
-
10
-[sales-contact-form]: https://www.npmjs.com/npm/contact-sales
content/enterprise/billing-and-seat-management/updating-billing-information.mdx
deleted
-8
@@ -1,8 +0,0 @@
1
----
2
-title: Updating billing information
3
----
4
-
5
-As an npm Enterprise billing manager, you can update the payment method for your Enterprise instance by contacting your npm account manager or our [Sales team][sales-contact-form].
6
-
7
-
8
-[sales-contact-form]: https://www.npmjs.com/npm/contact-sales
content/enterprise/index.mdx
+28
-6
@@ -1,11 +1,33 @@
1
---
2
-title: npm Enterprise
2
+title: Sunsetting npm Enterprise
3
+redirect_from:
4
+ - /configuring-your-registry-settings-as-an-npm-enterprise-user
5
+ - /logging-in-to-an-npm-enterprise-registry-from-the-command-line
6
+ - /enterprise/setup-and-configuration
7
+ - /getting-started-with-npm-enterprise
8
+ - /configuring-an-authentication-provider
9
+ - /defining-security-policy
10
+ - /enterprise/billing-and-seat-management
11
+ - /purchasing-or-removing-seats
12
+ - /updating-billing-information
13
+ - /enterprise/user-management
14
+ - /about-the-enterprise-admin-user
15
+ - /promoting-a-non-admin-user-to-admin
16
+ - /demoting-an-admin-to-a-non-admin-user
17
+ - /management/managing-user-security
18
+ - /viewing-deactivating-and-reactivating-users
19
+ - /creating-and-managing-organizations-and-teams
20
+ - /permanently-deleting-a-user
21
+ - /npm-enterprise-roles-and-permissions
22
+ - /enterprise/migration
23
+ - /migrating-from-an-existing-enterprise-instance
24
+ - /migrating-from-an-organization-on-the-public-registry
25
+ - /enterprise/end-of-life
26
+ - /enterprise/sunset
27
+ - /sunsetting-npm-enterprise
28
---
29
5
-<Note>
30
+In March 2020, npm was acquired by GitHub. On June 30, 2020, we notified npm Enterprise (npmE) customers of our intent to sunset npm Enterprise. **npm Enterprise will be supported until June 30, 2021**, and we will renew contracts for npmE until that date. We encourage all npmE customers to evaluate and migrate to GitHub Packages.
31
7
-**Note:** npm Enterprise will be retired on June 30, 2021. For more information, please visit our [FAQ about npm Enterprise plans](/sunsetting-npm-enterprise).
32
+Customers who already have one of GitHub’s Free, Teams, or Enterprise Cloud plans already receive monthly storage and bandwidth resources for GitHub Packages as part of their plan. To begin evaluating GitHub Packages, visit our documentation on [publishing with GitHub Packages](https://help.github.com/en/packages/publishing-and-managing-packages/publishing-a-package) directly from your repository.
33
9
-</Note>
10
-
11
-<Index />
content/enterprise/migration/index.mdx
deleted
-5
@@ -1,5 +0,0 @@
1
----
2
-title: Migration
3
----
4
-
5
-<Index />
content/enterprise/migration/migrating-from-an-existing-enterprise-instance.mdx
deleted
-11
@@ -1,11 +0,0 @@
1
----
2
-title: Migrating from an existing npm Enterprise instance
3
----
4
-import shared from '../../../src/shared.js'
5
-
6
-<>{shared['enterprise-migration-requirements'].text}</>
7
-
8
-To migrate from a legacy npm Enterprise installation, use npm's [pneumatic-tubes][pneumatic-tubes] and follow the steps under "[Importing from Legacy npm Enterprise][pneumatic-tubes-legacy]".
9
-
10
-[pneumatic-tubes]: https://www.npmjs.com/package/pneumatic-tubes
11
-[pneumatic-tubes-legacy]: https://www.npmjs.com/package/pneumatic-tubes#importing-from-legacy-npm-enterprise
content/enterprise/migration/migrating-from-an-organization-on-the-public-registry.mdx
deleted
-15
@@ -1,15 +0,0 @@
1
----
2
-title: Migrating from an organization on the public registry
3
-redirect_from:
4
- - /migrating-from-an-org-on-the-public-registry
5
----
6
-import shared from '../../../src/shared.js'
7
-
8
-<>{shared['enterprise-migration-requirements'].text}</>
9
-
10
-To migrate from an organization on the [public registry][pub-reg], use npm's [pneumatic-tubes][pneumatic-tubes] and follow the steps under "[Importing from npm orgs][pneumatic-tubes-orgs]".
11
-
12
-
13
-[pneumatic-tubes]: https://www.npmjs.com/package/pneumatic-tubes
14
-[pneumatic-tubes-orgs]: https://www.npmjs.com/package/pneumatic-tubes#importing-from-npm-orgs
15
-[pub-reg]: https://docs.npmjs.com/misc/registry.html
content/enterprise/setup-and-configuration/configuring-an-authentication-provider.mdx
deleted
-52
@@ -1,52 +0,0 @@
1
----
2
-title: Configuring an authentication provider
3
----
4
-import shared from '../../../src/shared.js'
5
-
6
-<Note>
7
-<><strong>Note:</strong> To avoid being locked out of your instance, you must connect your npm Enterprise admin account to your SSO account immediately after configuring an authentication provider. If you are locked out of your instance, {shared['contact-enterprise-support'].text}.</>
8
-</Note>
9
-
10
-As an Enterprise admin, you can configure your instance to use single sign-on (SSO) authentication through any external authentication provider that implements [OpenID Connect Core][oid-connect-core] and [OpenID Connect Discovery][oid-connect-discovery], such as [Auth0][auth0], [Azure Active Directory][azure], [Okta][okta], and [Google][google].
11
-
12
-1. Log in to your Enterprise instance using your temporary username and password.
13
-
14
-2. <>{shared['enterprise-admin-panel'].text}</>
15
-
16
- <>{shared['enterprise-admin-panel'].image}</>
17
-
18
-3. Click "settings".
19
-
20
- <>{shared['enterprise-admin-panel-settings'].image}</>
21
-
22
-4. On the Settings page, click "Configure Single Sign-On".
23
-
24
- <Screenshot src="/enterprise/setup-and-configuration/sso-configure.png" alt="Screenshot of the single sign-on configuration form" />
25
-
26
-5. On the Single Sign-On configuration page, enter your SSO application settings:
27
-
28
- * Domain: enter the base domain, without the `https://` prefix
29
- * Client ID
30
- * Client Secret
31
-
32
- <Screenshot src="/enterprise/setup-and-configuration/sso-settings-form.png" alt="Screenshot of the single sign-on settings form" />
33
-
34
-6. Click **Save**.
35
-
36
- <Screenshot src="/enterprise/setup-and-configuration/sso-save.png" alt="Screenshot of the single sign-on settings save button" />
37
-
38
-7. On your SSO provider application website, enter your npm Enterprise instance callback URL: `www.<company-name>.npme.io/sso/callback`.
39
-
40
-8. To connect your npm Enterprise admin account to your SSO account, visit `https://<company-name>.npme.io/login/via/1`.
41
-
42
-## Removing users from your authentication provider
43
-
44
-When you remove a user from your authentication provider, we also recommend [deactivating][deactivate-users] them in your instance.
45
-
46
-[OID-connect-core]: http://openid.net/specs/openid-connect-core-1_0.html
47
-[OID-connect-discovery]: http://openid.net/specs/openid-connect-discovery-1_0.html
48
-[auth0]: https://auth0.com/docs
49
-[azure]: https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/configure-single-sign-on-portal
50
-[okta]: https://developer.okta.com/documentation/
51
-[google]: https://developers.google.com/identity/protocols/OpenIDConnect
52
-[deactivate-users]: viewing-deactivating-and-reactivating-users#deactivating-users
content/enterprise/setup-and-configuration/defining-security-policy.mdx
deleted
-53
@@ -1,53 +0,0 @@
1
----
2
-title: Defining a security policy
3
----
4
-import shared from '../../../src/shared.js'
5
-
6
-As an Enterprise admin, you can prevent the download of insecure packages. For example, this is useful for keeping vulnerable dependencies out of your applications. At the moment, you can choose from three different security policies:
7
-
8
-* Allow all packages.
9
-* Block packages with critical vulnerabilities.
10
-* Block all vulnerable packages.
11
-
12
-<Note>
13
-
14
-**Note:** Packages are only blocked if they are not locally cached. Whenever you change policy, we recommend clearing your global cache (`npm cache clear --force`) and doing a clean install of your project (`npm clean-install`).
15
-
16
-</Note>
17
-
18
-All packages are allowed by default. To change your security policy:
19
-
20
-1. Log in to your Enterprise instance using your temporary username and password.
21
-
22
-2. <>{shared['enterprise-admin-panel'].text}</>
23
-
24
- <>{shared['enterprise-admin-panel'].image}</>
25
-
26
-3. Click "settings".
27
-
28
- <>{shared['enterprise-admin-panel-settings'].image}</>
29
-
30
-4. On the Settings page, under Security Policy, choose a policy.
31
-
32
- <>{shared['enterprise-choose-security-policy'].image}</>
33
-
34
-5. Optionally provide a custom message for the install logs whenever a package is blocked.
35
-
36
- <>{shared['enterprise-custom-blocking-message'].image}</>
37
-
38
-6. If present, check the "I acknowledge that this policy may cause my builds to break" box.
39
-
40
- <Screenshot src="/enterprise/setup-and-configuration/acknowledge-blocking.png" alt="Screenshot showing an acknowledgement of broken builds" />
41
-
42
-7. Click "Apply Policy".
43
-
44
-If `npm install` attempts to download a package that violates the policy, developers will see an error similar to the following.
45
-
46
-```
47
-$ npm i lodash@1.0.0
48
-npm notice Could not download lodash 1.0.0 due to policy violations. Use `npm audit fix` to upgrade this dependency.
49
-npm ERR! code E403
50
-npm ERR! 403 Forbidden - GET https://registry.npmjs.com/lodash/-/lodash-1.0.0.tgz
51
-```
52
-
53
-To fix this error, use `npm audit fix` to upgrade dependencies to versions that don't violate policy.
content/enterprise/setup-and-configuration/getting-started-with-npm-enterprise.mdx
deleted
-25
@@ -1,25 +0,0 @@
1
----
2
-title: Getting started with npm Enterprise
3
----
4
-
5
-As an npm Enterprise admin, once you have created a temporary username and password from the signup link for your new instance, you should:
6
-
7
-1. Log in to your npm Enterprise instance.
8
-2. [Configure SSO authentication][auth-config]
9
-3. Link your account to your SSO provider.
10
-4. [Create one or more organizations][create-orgs].
11
-5. Tell users to log in to the instance with their SSO credentials.
12
-6. [Add users to organizations and teams][add-org-users].
13
-7. Have users follow the steps in the "[Getting started][getting-started]" and "[Packages and modules][pkg-module]" documentation to [download Node.js and npm][download-npm], [configure their npm client][config-client], and [publish][publish-pkg] and [install][install-pkg] packages.
14
-
15
-
16
-[getting-started]: /getting-started
17
-[pkg-module]: /packages-and-modules
18
-[download-npm]: /downloading-and-installing-node-js-and-npm
19
-[config-client]: /configuring-your-registry-settings-as-an-npm-enterprise-user
20
-[publish-pkg]: /packages-and-modules/contributing-packages-to-the-registry
21
-[install-pkg]: /packages-and-modules/getting-packages-from-the-registry
22
-[admin-user]: /about-the-enterprise-admin-user
23
-[auth-config]: /configuring-an-authentication-provider
24
-[create-orgs]: /creating-an-org
25
-[add-org-users]: /adding-members-to-your-org
content/enterprise/setup-and-configuration/index.mdx
deleted
-5
@@ -1,5 +0,0 @@
1
----
2
-title: Setup and configuration
3
----
4
-
5
-<Index />
content/enterprise/sunset/index.mdx
deleted
-6
@@ -1,6 +0,0 @@
1
----
2
-title: Sunset
3
-redirect_from: [ /enterprise/end-of-life ]
4
----
5
-
6
-<Index />
content/enterprise/sunset/sunsetting-npm-enterprise.mdx
deleted
-18
@@ -1,18 +0,0 @@
1
----
2
-title: Sunsetting npm Enterprise
3
----
4
-
5
-In March 2020, npm was acquired by GitHub. On June 30, 2020, we notified npm Enterprise (npmE) customers of our intent to sunset npm Enterprise. **npm Enterprise will be supported until June 30, 2021**, and we will renew contracts for npmE until that date. We encourage all npmE customers to evaluate and migrate to GitHub Packages.
6
-
7
-## Evaluating and migrating to GitHub Packages
8
-
9
-* **How do I trial or migrate to GitHub Packages?**
10
- Customers who already have one of GitHub’s Free, Teams, or Enterprise Cloud plans already receive monthly storage and bandwidth resources for GitHub Packages as part of their plan. To begin evaluating GitHub Packages, visit our documentation on [publishing with GitHub Packages](https://help.github.com/en/packages/publishing-and-managing-packages/publishing-a-package) directly from your repository.
11
-
12
-* **My source code is not on GitHub. How can I trial GitHub Packages?**
13
- The combined npm and GitHub team has reached out to customers to work on detailed transition plans, including free trials for GitHub Enterprise Cloud. However, if you still need assistance, please [contact the GitHub team](https://enterprise.github.com/contact).
14
-
15
-* **Where do I turn for customer support during this time?**
16
- Please visit [npm support](https://www.npmjs.com/support) for assistance with your npm Enterprise plan.
17
-
18
-For further assistance or to answer any questions not covered here (including those regarding billing and payments specific to your account), please reach out your GitHub and npm contacts, or contact [the GitHub sales team](https://enterprise.github.com/contact).
content/enterprise/user-management/about-the-enterprise-admin-user.mdx
deleted
-7
@@ -1,7 +0,0 @@
1
----
2
-title: About the Enterprise admin user
3
----
4
-
5
-The Enterprise admin user has the most far-reaching permissions on the Enterprise instance and can manage instance settings, organizations, users, and packages. For a full list of Enterprise admin permissions, see "[npm Enterprise roles and permissions][ent-roles]".
6
-
7
-[ent-roles]: npm-enterprise-roles-and-permissions
content/enterprise/user-management/creating-and-managing-organizations-and-teams.mdx
deleted
-19
@@ -1,19 +0,0 @@
1
----
2
-title: Creating and managing organizations and teams
3
-redirect_from:
4
- - /creating-and-managing-orgs-and-teams
5
----
6
-
7
-To create and manage organizations and teams, see our [organizations documentation][orgs]:
8
-
9
-* [Creating and managing organizations][create-org]
10
-* [Managing organization members][members]
11
-* [Managing teams][teams]
12
-* [Managing organization packages][pkgs]
13
-
14
-
15
-[orgs]: organizations
16
-[create-org]: organizations/creating-and-managing-organizations
17
-[members]: organizations/managing-organization-members
18
-[teams]: organizations/managing-teams
19
-[pkgs]: organizations/managing-organization-packages
content/enterprise/user-management/demoting-an-admin-to-a-non-admin-user.mdx
deleted
-15
@@ -1,15 +0,0 @@
1
----
2
-title: Demoting an admin to a non-admin user
3
----
4
-import shared from '../../../src/shared.js'
5
-
6
-<Note>
7
-
8
-**Note:** Demoting an admin does not deactivate them. To deactivate a user, follow the steps in "[Viewing, deactivating, and reactivating users](viewing-deactivating-and-reactivating-users#deactivating-users)
9
-
10
-</Note>
11
-
12
-If an admin on your npm Enterprise instance no longer needs to take admin actions on the instance (e.g. configuring SSO, activating and deactivating users, or inviting users to the instance), as an Enterprise instance admin, you can demote the admin to a non-admin user.
13
-
14
-1. If you haven't already, add the user to your instance, either by having them sign in with your SSO provider, or by inviting them to create a username and password on the instance.
15
-2. <>Have an Enterprise admin {shared['contact-enterprise-support'].text} with the name of the admin to be demoted to a non-admin user.</>
content/enterprise/user-management/index.mdx
deleted
-7
@@ -1,7 +0,0 @@
1
----
2
-title: User management
3
----
4
-
5
-How to manage users on your npm Enterprise instance.
6
-
7
-<Index />
content/enterprise/user-management/managing-user-security.mdx
deleted
-18
@@ -1,18 +0,0 @@
1
----
2
-title: Managing user security
3
----
4
-
5
-To keep your npm Enterprise instance secure, as an Enterprise instance admin, you should:
6
-
7
-* Limit the number of additional Enterprise admins on your instance.
8
-* [Deactivate users][deactivate-users] who no longer need access to your npm Enterprise instance (such as users who have left the company) as quickly as possible.
9
-
10
-Users of your npm Enterprise instance should:
11
-
12
-* [Enable 2FA][2FA] on their Enterprise instance accounts.
13
-* Use [read-only tokens][read-only-tokens] to delegate access to private packages to other tools in their workflow.
14
-
15
-
16
-[deactivate-users]: viewing-deactivating-and-reactivating-users
17
-[2FA]: configuring-two-factor-authentication
18
-[read-only-tokens]: about-authentication-tokens
content/enterprise/user-management/npm-enterprise-roles-and-permissions.mdx
deleted
-22
@@ -1,22 +0,0 @@
1
----
2
-title: npm Enterprise roles and permissions
3
----
4
-
5
-| Action | Billing manager | Admin user | End user |
6
-|:-------|:---------------:|:----------:|:--------:|
7
-| Update payment method and billing info (via npm account manager) | X | | |
8
-| Purchase additional seats (via npm account manager) | X | | |
9
-| View all users of the instance | | X | |
10
-| Activate users on the instance | | X | |
11
-| Deactivate users on the instance | | X | |
12
-| Configure an authentication provider | | X | |
13
-| View, publish, and install packages from the instance registry | | X | X |
14
-| Create organizations | | X | X |
15
-| Add/remove users to/from organizations and instance | | X<sup>1</sup> | |
16
-| Add/remove users to/from organizations who are already initialized on the instance | | X<sup>1</sup> | X<sup>1</sup> |
17
-| Create, delete, and manage teams | | X<sup>2</sup> | X<sup>2</sup> |
18
-| Add/remove packages to/from organization teams | | X<sup>2</sup> | X<sup>2</sup> |
19
-| Create and publish packages in the organization scope | | X | X |
20
-
21
-<sup>1</sup> User must be an organization owner.<br/>
22
-<sup>2</sup> User must be an organization owner or team admin.<br/>
content/enterprise/user-management/permanently-deleting-a-user.mdx
deleted
-12
@@ -1,12 +0,0 @@
1
----
2
-title: Permanently deleting a user
3
----
4
-import shared from '../../../src/shared.js'
5
-
6
-<>As an npm Enterprise admin, you can {shared['contact-enterprise-support'].text} to completely remove a user from your Enterprise instance if they will never need to access the instance again.</>
7
-
8
-<Note>
9
-
10
-**Note:** When permanently deleting a user, you will work with npm support to make sure any organizations and packages they own are transferred to other users on your Enterprise instance.
11
-
12
-</Note>
content/enterprise/user-management/promoting-a-non-admin-user-to-admin.mdx
deleted
-15
@@ -1,15 +0,0 @@
1
----
2
-title: Promoting a non-admin user to admin
3
----
4
-import shared from '../../../src/shared.js'
5
-
6
-<Note>
7
-
8
-**Note:** To keep your Enterprise instance secure, we recommend limiting the number of Enterprise admins on your instance.
9
-
10
-</Note>
11
-
12
-If you need multiple users in your Enterprise instance to be able to take admin actions (e.g. configure SSO, activate and deactivate users, or invite users to the instance), you can promote a non-admin user to admin.
13
-
14
-1. If you haven't already, add the user to your instance, either by having them sign in with your SSO provider, or by inviting them to create a username and password on the instance.
15
-2. <>Have an Enterprise admin {shared['contact-enterprise-support'].text} with the name of the user to be promoted to admin.</>
content/enterprise/user-management/viewing-deactivating-and-reactivating-users.mdx
deleted
-56
@@ -1,56 +0,0 @@
1
----
2
-title: Viewing, deactivating, and reactivating users
3
----
4
-import shared from '../../../src/shared.js'
5
-
6
-As an Enterprise admin, you can view active and inactive users, deactivate users who no longer need access to your npm Enterprise instance (such as users who have left your company), and reactivate inactive users.
7
-
8
-## Viewing users
9
-
10
-As an npm Enterprise admin, you can see a list of all the current users of your instance, including non-admin end users and other instance admins.
11
-
12
-1. <>{shared['enterprise-instance-login'].text}</>
13
-
14
-2. <>{shared['enterprise-admin-panel'].text}</>
15
-
16
- <>{shared['enterprise-admin-panel'].image}</>
17
-
18
-3. To view a complete list of users, click the "Manage users" tab.
19
-
20
- <Screenshot src="/enterprise/user-management/manage-users.png" alt="Screenshot of the manage users button" />
21
-
22
-## Deactivating users
23
-
24
-As an npm Enterprise admin, you can deactivate users who no longer need access to your npm Enterprise instance -- for example, users who have left the company or whose responsibilities have changed.
25
-
26
-Deactivating a user will invalidate their login tokens, but will not delete organizations or packages they owned. A deactivated user will remain visible in the "Manage users" panel and can be reactivated by an admin user.
27
-
28
-1. <>{shared['enterprise-instance-login'].text}</>
29
-
30
-2. <>{shared['enterprise-admin-panel'].text}</>
31
-
32
- <>{shared['enterprise-admin-panel'].image}</>
33
-
34
-3. Locate the user name of the user you want to deactivate, then next to their name, click "deactivate".
35
-
36
- <Screenshot src="/enterprise/user-management/deactivate-user.png" alt="Screenshot of the deactivate user button" />
37
-
38
-## Reactivating inactive users
39
-
40
-<Note>
41
-
42
-**Note:** When you reactivate a user, they will need to re-enable [two-factor authentication](https://docs.npmjs.com/configuring-two-factor-authentication) on their npm Enterprise instance account.
43
-
44
-</Note>
45
-
46
-As an npm Enterprise admin, you can reactivate an inactive user of your instance to allow them to log in again.
47
-
48
-1. <>{shared['enterprise-instance-login'].text}</>
49
-
50
-2. <>{shared['enterprise-admin-panel'].text}</>
51
-
52
- <>{shared['enterprise-admin-panel'].image}</>
53
-
54
-3. Locate the user name of the user you want to reactivate, then next to their name, click "activate".
55
-
56
- <Screenshot src="/enterprise/user-management/activate-user.png" alt="Screenshot of the activate user button" />
content/getting-started/configuring-your-local-environment/configuring-your-registry-settings-as-an-npm-enterprise-user.mdx
deleted
-88
@@ -1,88 +0,0 @@
1
----
2
-title: Configuring your registry settings as an npm Enterprise user
3
----
4
-
5
-<div class="note">
6
-
7
-<span class="bold">Note:</span> npm Enterprise requires npm 4.4.x or greater. To download the latest version of npm, on the command line, run <code class="highlighter-rouge">
8
-[sudo] npm install npm -g</code>
9
-
10
-</div>
11
-
12
-You can configure your npm client to publish to and install from your private npm Enterprise registry by:
13
-
14
-* Setting your company's npm Enterprise registry as your default registry (recommended)
15
-* Using npmrc to managing multiple profiles for different registries
16
-* Configuring scopes to point to different registries
17
-
18
-## Setting your company's npm Enterprise registry as your default registry
19
-
20
-The easiest way to publish to and install from your company's npm Enterprise registry is to set it as your default registry.
21
-
22
-On the command line, run the following command, replacing "your-registry" with the name of your company's npm Enterprise registry:
23
-
24
-```
25
-npm config set registry https://registry.your-registry.npme.io/
26
-```
27
-
28
-## Using npmrc to managing multiple profiles for different registries
29
-
30
-If you need to publish and install packages to and from different registries -- for example, an npm Enterprise registry for work-related code, and the npmjs.com public registry for open source projects -- you can create and manage a separate npm user profile for each registry using the [npmrc](https://www.npmjs.com/package/npmrc) tool.
31
-
32
-### Overview
33
-
34
-- [Install npmrc](#install-npmrc)
35
-- [Create an npm Enterprise profile](#create-an-npm-enterprise-profile)
36
-- [Create a profile for the public npm registry](#create-a-profile-for-the-public-npm-registry)
37
-- [Switch profiles with npmrc](#switch-profiles-with-npmrc)
38
-
39
-### Install npmrc
40
-
41
-To install npmrc, on the command line, run
42
-
43
-```
44
-npm i npmrc -g
45
-```
46
-
47
-### Create an npm Enterprise profile
48
-
49
-After installing npmrc, you can create a profile to access your company's Enterprise registry.
50
-
51
-1. To create an npm Enterprise profile, on the command line, run `npmrc -c name-of-profile`. For example, to create a profile called "work", run the following command:
52
- ```
53
- npmrc -c work
54
- ```
55
-2. To set an npm Enterprise registry for the profile, run the following command, replacing your-company-registry with the name of your company's npm Enterprise registry:
56
- ```
57
- npm config set registry https://registry.your-company-registry.npme.io/
58
- ```
59
-
60
-### Create a profile for the public npm registry
61
-
62
-After you have created your npm Enterprise profile, you can create a second profile for a different registry, such as the [public npm registry](https://registry.npmjs.com).
63
-
64
-1. To create a profile for the public registry, on the command line, run `npmrc -c name-of-profile`. For example, to create a profile called "open-source", run `npmrc -c open-source`.
65
-2. To set the public registry for your open source profile, run the following command:
66
- ```
67
- npm config set registry https://registry.npmjs.org/
68
- ```
69
-
70
-### Switch profiles with npmrc
71
-
72
-To switch profiles, on the command line, run the following command,
73
-replacing `profile-name` with the name of your profile:
74
-
75
-```
76
- npmrc profile-name
77
-```
78
-
79
-## Configuring scopes to point to different registries
80
-
81
-You can also map different scopes to different npm registries. For example, to use the scope `@company-scope` from your npm Enterprise registry, while continuing to install public packages from the public npm registry, run the following command, replacing `@company-scope` with the scope, and `company-registry` with the name of your company's npm Enterprise registry:
82
-
83
-```
84
- npm login --scope=@company-scope --registry=https://registry.company-registry.npme.io/
85
-```
86
-
87
-
88
-[download-install]: downloading-and-installing-node-js-and-npm
content/getting-started/configuring-your-local-environment/downloading-and-installing-node-js-and-npm.mdx
+2
-2
@@ -3,11 +3,11 @@ title: Downloading and installing Node.js and npm
3
redirect_from: [ /getting-started/installing-node ]
4
---
5
6
-To publish and install packages to and from the public npm registry or your company's npm Enterprise registry, you must install Node.js and the npm command line interface using either a Node version manager or a Node installer. **We strongly recommend using a Node version manager like [nvm](https://github.com/nvm-sh/nvm) to install Node.js and npm.** We do not recommend using a Node installer, since the Node installation process installs npm in a directory with local permissions and can cause permissions errors when you run npm packages globally.
6
+To publish and install packages to and from the public npm registry or a private npm registry, you must install Node.js and the npm command line interface using either a Node version manager or a Node installer. **We strongly recommend using a Node version manager like [nvm](https://github.com/nvm-sh/nvm) to install Node.js and npm.** We do not recommend using a Node installer, since the Node installation process installs npm in a directory with local permissions and can cause permissions errors when you run npm packages globally.
7
8
<Note>
9
10
-**Note:** npm Enterprise requires npm 4.4.x or greater. To download the latest version of npm, on the command line, run the following command:
10
+**Note:** to download the latest version of npm, on the command line, run the following command:
11
12
```
13
npm install -g npm
content/getting-started/configuring-your-local-environment/logging-in-to-an-npm-enterprise-registry-from-the-command-line.mdx
deleted
-41
@@ -1,41 +0,0 @@
1
----
2
-title: Logging in to an npm Enterprise registry from the command line
3
----
4
-
5
-The steps for logging in to your company's npm Enterprise registry will depend how you [configured your npm registry settings][ent-reg-config].
6
-
7
-- [Logging in with your default registry set to your company's npm Enterprise registry](#logging-in-with-your-default-registry-set-to-your-company-s-npm-enterprise-registry)
8
-- [Logging in with npmrc](#logging-in-with-npmrc)
9
-- [Logging in with a scope configured to point to an npm Enterprise registry](#logging-in-with-a-scope-configured-to-point-to-an-npm-enterprise-registry)
10
-
11
-## Logging in with your default registry set to your company's npm Enterprise registry
12
-
13
-1. On the command line, type the following command:
14
- ```
15
- npm login
16
- ```
17
-2. When prompted, provide your SSO credentials.
18
-
19
-## Logging in with npmrc
20
-
21
-1. On the command line, switch to your npm Enterprise profile:
22
- ```
23
- npmrc work
24
- ```
25
-2. Run the following command:
26
- ```
27
- npm login
28
- ```
29
-3. When prompted, provide your SSO credentials.
30
-
31
-## Logging in with a scope configured to point to an npm Enterprise registry
32
-
33
-1. On the command line, type the following command:
34
- ```
35
- npm login --registry=https://registry.company-name.npme.io
36
- ```
37
-2. When prompted, provide your SSO credentials.
38
-
39
-
40
-[ent-reg-config]: configuring-your-registry-settings-as-an-npm-enterprise-user
41
-[2fa]: about-two-factor-authentication
content/getting-started/setting-up-your-npm-user-account/creating-a-new-npm-user-account.mdx
-6
@@ -4,12 +4,6 @@ title: Creating a new user account on the public registry
4
5
If you do not already have an npm user account, you can create an account in order to share and download Javascript packages on the public registry.
6
7
-<Note>
8
-
9
-**Note:** If you are using an npm Enterprise registry, you must log in with your SSO credentials instead of creating an account. For more information, contact your company's Enterprise admin.
10
-
11
-</Note>
12
-
7
## Creating an account on the website
8
9
1. Go to the [npm signup page](https://www.npmjs.com/signup)
content/getting-started/troubleshooting/generating-and-locating-npm-debug.log-files.mdx
+1
-7
@@ -5,7 +5,7 @@ redirect_from:
5
---
6
import shared from '../../../src/shared.js'
7
8
-When a package fails to install or publish, the npm CLI will generate an `npm-debug.log` file. This log file can help you (and [npm Support][support]) figure out what went wrong.
8
+When a package fails to install or publish, the npm CLI will generate an `npm-debug.log` file. This log file can help you figure out what went wrong.
9
10
If you need to generate a `npm-debug.log` file, you can run one of these commands.
11
@@ -24,9 +24,3 @@ npm publish --timing
24
You can find the `npm-debug.log` file in your `.npm` directory. To find your `.npm` directory, use `npm config get cache`.
25
26
If you use a CI environment, your logs are likely located elsewhere. For example, in Travis CI, you can find them in the `/home/travis/build` directory.
27
-
28
-<Note>
29
-<><strong>npm Enterprise users:</strong> If you need to {shared['contact-enterprise-support'].text}, we recommend attaching the entire contents of the `npm-debug.log` file or copying the contents into the body of the message, so that we can more easily diagnose the problem.</>
30
-</Note>
31
-
32
-[support]: https://www.npmjs.com/support
content/organizations/creating-and-managing-organizations/deleting-an-organization.mdx
-3
@@ -36,6 +36,3 @@ instead.
36
37
<Screenshot src="/organizations/creating-and-managing-organizations/org-delete-plan.png" alt="Screenshot of org delete plan" />
38
39
-## Deleting an organization in npm Enterprise
40
-
41
-<>To delete an organization in npm Enterprise, the npm Enterprise admin should {shared['contact-enterprise-support'].text}.</>
content/organizations/managing-organization-members/adding-members-to-your-organization.mdx
-6
@@ -7,12 +7,6 @@ import shared from '../../../src/shared.js'
7
8
As an organization owner, you can add other npm users to your organization to give them read or read and write access to public and private packages within your organization's scope, as well as public unscoped packages governed by your organization.
9
10
-<Note>
11
-
12
-**npm Enterprise users:** Make sure new users have been added to your enterprise instance before inviting them to an organization within the instance.
13
-
14
-</Note>
15
-
10
When you add a member to your organization, they are sent an email inviting them to the organization.
11
12
Once the new member [accepts the invitation][accept-invitation], they are:
content/organizations/managing-organization-members/organization-roles-and-permissions.mdx
-4
@@ -13,10 +13,6 @@ There are three roles in an organization:
13
14
<><strong>On the public registry, you cannot remove the last owner from an organization.</strong> To delete an organization, {shared['contact-support'].text}.</>
15
16
-<Note>
17
-<><strong>npm Enterprise users:</strong> If you are using npm Enterprise, deactivating the only owner of an organization will cause that organization to be ownerless. If you have deactivated the last owner of an organization on an npm Enterprise instance, {shared['contact-enterprise-support'].text}.</>
18
-</Note>
19
-
16
| Action | **Owner** | **Admin** | **Member** |
17
|:------------------------------------------------------|:---------:|:---------:|:----------:|
18
| Manage organization billing | X | | |
content/packages-and-modules/contributing-packages-to-the-registry/creating-and-publishing-unscoped-public-packages.mdx
-6
@@ -2,12 +2,6 @@
2
title: Creating and publishing unscoped public packages
3
---
4
5
-<Note>
6
-
7
-**Note:** You can only publish unscoped packages to the npm public registry. You cannot publish unscoped packages to an npm Enterprise registry.
8
-
9
-</Note>
10
-
5
As an npm user, you can create unscoped packages to use in your own projects and publish them to the npm public registry for others to use in theirs. Unscoped packages are always public and are referred to by the package name only:
6
7
```
content/packages-and-modules/introduction-to-packages-and-modules/package-scope-access-level-and-visibility.mdx
-22
@@ -25,25 +25,3 @@ Visibility of npm packages depends on the scope (namespace) in which the package
25
<span class="bold">Note:</span> Only user accounts can create and manage unscoped packages. Organizations can only manage scoped packages.
26
27
</div>
28
-
29
-## npm Enterprise
30
-
31
-<div class="note">
32
-
33
-The following table applies to customers who purchased <a href="https://docs.npmjs.com/enterprise">npm Enterprise</a> after July 26, 2018.
34
-
35
-</div>
36
-
37
-| Scope | Access level | Can view and download | Can write (publish) |
38
-|--------------|--------------|-----------------------------------------------------------------------------|---|
39
-| Org | Private | Logged-in members of the Enterprise registry who belong to a team in the Org with read access to the package | Logged-in members of the Enterprise registry who belong to a team in the Org with read and write access to the package |
40
-| Org | Public | All logged-in members of the Enterprise registry | Logged-in members of the Enterprise registry who belong to a team in the Org with read and write access to the package |
41
-| User | Private | The package owner and logged-in members of the Enterprise registry who have been granted read access to the package | The package owner and logged-in members of the Enterprise registry who have been granted read and write access to the package |
42
-| User | Public | All logged-in members of the Enterprise registry | The package owner and logged-in members of the Enterprise registry who have been granted read and write access to the package |
43
-| Unscoped | Public | All users of the Enterprise registry | None (see note below) |
44
-
45
-<div class="note">
46
-
47
-<span class="bold">Note:</span> The unscoped namespace on npm Enterprise is reserved for unscoped packages in the public npm registry. To prevent npm Enterprise users from accidentally publishing proprietary code to the public npm registry, where it would be visible to anyone on the internet, we do not allow publishing unscoped packages to npm Enterprise.
48
-
49
-</div>
src/gatsby-theme-doctornpm/nav.yml
-55
@@ -51,10 +51,6 @@
51
url: /about-npm-versions
52
- title: Downloading and installing Node.js and npm
53
url: /downloading-and-installing-node-js-and-npm
54
- - title: Configuring your registry settings as an npm Enterprise user
55
- url: /configuring-your-registry-settings-as-an-npm-enterprise-user
56
- - title: Logging in to an npm Enterprise registry from the command line
57
- url: /logging-in-to-an-npm-enterprise-registry-from-the-command-line
54
- title: Troubleshooting
55
url: /getting-started/troubleshooting
56
children:
@@ -243,57 +239,6 @@
239
url: /configuring-your-npm-client-with-your-organization-settings
240
- title: Creating and publishing an organization scoped package
241
url: /creating-and-publishing-an-organization-scoped-package
246
-- title: npm Enterprise
247
- url: /enterprise
248
- children:
249
- - title: Setup and configuration
250
- url: /enterprise/setup-and-configuration
251
- children:
252
- - title: Getting started with npm Enterprise
253
- url: /getting-started-with-npm-enterprise
254
- - title: Configuring an authentication provider
255
- url: /configuring-an-authentication-provider
256
- - title: Defining a security policy
257
- url: /defining-security-policy
258
- - title: Billing and seat management
259
- shortName: Billing
260
- url: /enterprise/billing-and-seat-management
261
- children:
262
- - title: Purchasing or removing seats
263
- url: /purchasing-or-removing-seats
264
- - title: Updating billing information
265
- url: /updating-billing-information
266
- - title: User management
267
- url: /enterprise/user-management
268
- children:
269
- - title: About the Enterprise admin user
270
- url: /about-the-enterprise-admin-user
271
- - title: Promoting a non-admin user to admin
272
- url: /promoting-a-non-admin-user-to-admin
273
- - title: Demoting an admin to a non-admin user
274
- url: /demoting-an-admin-to-a-non-admin-user
275
- - title: Managing user security
276
- url: /managing-user-security
277
- - title: Viewing, deactivating, and reactivating users
278
- url: /viewing-deactivating-and-reactivating-users
279
- - title: Creating and managing organization and teams
280
- url: /creating-and-managing-organizations-and-teams
281
- - title: Permanently deleting a user
282
- url: /permanently-deleting-a-user
283
- - title: npm Enterprise roles and permissions
284
- url: /npm-enterprise-roles-and-permissions
285
- - title: Migration
286
- url: /enterprise/migration
287
- children:
288
- - title: Migrating from an existing npm Enterprise instance
289
- url: /migrating-from-an-existing-enterprise-instance
290
- - title: Migrating from an organization on the public registry
291
- url: /migrating-from-an-organization-on-the-public-registry
292
- - title: Sunset
293
- url: /enterprise/sunset
294
- children:
295
- - title: Sunsetting npm Enterprise
296
- url: /sunsetting-npm-enterprise
242
- title: Policies
243
url: /policies
244
children:
src/nav-base.yml
-56
@@ -48,10 +48,6 @@
48
url: /about-npm-versions
49
- title: Downloading and installing Node.js and npm
50
url: /downloading-and-installing-node-js-and-npm
51
- - title: Configuring your registry settings as an npm Enterprise user
52
- url: /configuring-your-registry-settings-as-an-npm-enterprise-user
53
- - title: Logging in to an npm Enterprise registry from the command line
54
- url: /logging-in-to-an-npm-enterprise-registry-from-the-command-line
51
- title: Troubleshooting
52
url: /getting-started/troubleshooting
53
children:
@@ -244,58 +240,6 @@
240
- title: Creating and publishing an organization scoped package
241
url: /creating-and-publishing-an-organization-scoped-package
242
247
-- title: npm Enterprise
248
- url: /enterprise
249
- children:
250
- - title: Setup and configuration
251
- url: /enterprise/setup-and-configuration
252
- children:
253
- - title: Getting started with npm Enterprise
254
- url: /getting-started-with-npm-enterprise
255
- - title: Configuring an authentication provider
256
- url: /configuring-an-authentication-provider
257
- - title: Defining a security policy
258
- url: /defining-security-policy
259
- - title: Billing and seat management
260
- shortName: Billing
261
- url: /enterprise/billing-and-seat-management
262
- children:
263
- - title: Purchasing or removing seats
264
- url: /purchasing-or-removing-seats
265
- - title: Updating billing information
266
- url: /updating-billing-information
267
- - title: User management
268
- url: /enterprise/user-management
269
- children:
270
- - title: About the Enterprise admin user
271
- url: /about-the-enterprise-admin-user
272
- - title: Promoting a non-admin user to admin
273
- url: /promoting-a-non-admin-user-to-admin
274
- - title: Demoting an admin to a non-admin user
275
- url: /demoting-an-admin-to-a-non-admin-user
276
- - title: Managing user security
277
- url: /managing-user-security
278
- - title: Viewing, deactivating, and reactivating users
279
- url: /viewing-deactivating-and-reactivating-users
280
- - title: Creating and managing organization and teams
281
- url: /creating-and-managing-organizations-and-teams
282
- - title: Permanently deleting a user
283
- url: /permanently-deleting-a-user
284
- - title: npm Enterprise roles and permissions
285
- url: /npm-enterprise-roles-and-permissions
286
- - title: Migration
287
- url: /enterprise/migration
288
- children:
289
- - title: Migrating from an existing npm Enterprise instance
290
- url: /migrating-from-an-existing-enterprise-instance
291
- - title: Migrating from an organization on the public registry
292
- url: /migrating-from-an-organization-on-the-public-registry
293
- - title: Sunset
294
- url: /enterprise/sunset
295
- children:
296
- - title: Sunsetting npm Enterprise
297
- url: /sunsetting-npm-enterprise
298
-
243
- title: Policies
244
url: /policies
245
children: