Permalink
Browse files

[docs] Add hosted npm documentation

  • Loading branch information...
1 parent f4fd68b commit 2547c2fff07eda7ba5c34aca5ef6dd614182a6a4 @julianduque julianduque committed Jan 21, 2014
View
18 content/npm/faq.md
@@ -1,14 +1,24 @@
# Private npm FAQ
### Will my private registry stay up If the public registry goes down?
+Yes, it will remain online and you will be able to use `npm` without problems.
### Can anyone else access my registry?
+Only the team members defined in the Web Interface can access your registry.
-### How can I make sure I don't accidentally publish to the public registry?
+### How can I make sure I don't accidentally publih to the public registry?
+You can use the `publishConfig` property in your `package.json`:
-### What happens if I need to change my password on the public npm registry?
+For example:
-### Why do you have two different TLDs (npmjitsu.co and npmjitsu.com)
+``` json
+{
+ "publishConfig": { "registry": "https://your-subdomain.registry.nodejitsu.com" }
+}
+```
+### What happens if I need to change my password on the public npm registry?
+Nothing! As long as your `.npmrc` is kept up to date the use of your private npm
+will be as seamless as the public registry!
-[meta:title]: <> (FAQ)
+[meta:title]: <> (FAQ)
View
12 content/npm/index.md
@@ -19,7 +19,7 @@ Why do you need to do these things?
```
npm config set always-auth true
```
-* _Don't be strict about SSL:_ Isaac Schlueter runs his own CA for `registry.npmjs.org` which we are in the process of getting setup for `npmjitsu.co`. In the meantime however, we are using a wildcard certificate (e.g. `*.npmjitsu.co`) which causes spurriour SSL warnings unless you set:
+* _Don't be strict about SSL:_ Isaac Schlueter runs his own CA for `registry.npmjs.org` which we are in the process of getting setup for `nodejitsu.com`. In the meantime however, we are using a wildcard certificate (e.g. `*.registry.nodejitsu.com`) which causes spurriour SSL warnings unless you set:
```
npm config set strict-ssl false
```
@@ -30,21 +30,23 @@ Requests can be made against your private npm in two ways:
* _Set the registry for all requests:_ This means that every request will hit your private registry
```
- npm config set registry https://your-subdomain.npmjitsu.co
+ npm config set registry https://your-subdomain.registry.nodejitsu.com
```
* _Use the `--reg` flag when necessary:_ The `--reg` flag (short for `--registry`) will allow you to make any request against your private registry:
```
- npm info your-private-module --reg http://your-subdomain.npmjitsu.co
+ npm info your-private-module --reg http://your-subdomain.registry.nodejitsu.com
```
**We recommend that you use the `--reg` flag when necessary combined with the `publishConfig` in your package.json.**
### 3. Login to the web interface
```
-http://your-subdomain.npmjitsu.com
+http://your-subdomain.npm.nodejitsu.com
```
+More information available at the [Web Interface Documentation](web)
+
### PROTIP: Publish modules using `publishConfig`
The `publishConfig` in your package.json does the following (from the [npm documentation](https://github.com/isaacs/npm/blob/master/doc/files/package.json.md#publishconfig)):
@@ -60,7 +62,7 @@ For example:
``` js
{
- "publishConfig": { "registry": "https://your-subdomain.npmjitsu.co" }
+ "publishConfig": { "registry": "https://your-subdomain.registry.nodejitsu.com" }
}
```
View
BIN content/npm/screenshots/add_member.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN content/npm/screenshots/dashboard.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN content/npm/screenshots/login.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN content/npm/screenshots/members.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
40 content/npm/web.md
@@ -0,0 +1,40 @@
+# Web Interface
+
+You can login to your Web Interface in `http://your-subdomain.npm.nodejitsu.com` with your `npm` credentials.
+
+![Login](screenshots/login.png)
+
+## Dashboard
+
+![Dashboard](screenshots/dashboard.png)
+
+## Packages Policy
+
+### Private
+Lists the private packages published to your npm, these are only visible by your team members and are always proxied to your private CouchDB server.
+
+### Whitelist
+Only these packages (and all private npm packages) will be permitted from the public npm registry. *It is possible for a package to be both private and blacklisted. This is how you can take ownership over a given module.*
+
+### Blacklist
+These packages are explicitly forbidden to be retrieved from the public npm registry.
+
+### Maintained
+All the packages maintained by your team members.
+
+## Team Members
+
+
+### Add member
+
+Just write down the public npm username and click on `Add member`.
+
+![Add member](screenshots/add_member.png)
+
+### Remove member
+To remove a user from your team, click on the `(x)` button right their username.
+
+![List members](screenshots/members.png)
+
+
+[meta:title]: <> (Web Interface)

0 comments on commit 2547c2f

Please sign in to comment.