Future ideas about the "npm site" command.

1 files changed, 73 insertions, 0 deletions

diff --git a/man/future-ideas/site.1 b/man/future-ideas/site.1
new file mode 100644
index 000000000..62217a5d4
--- /dev/null
+++ b/man/future-ideas/site.1
@@ -0,0 +1,73 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "NPM\-SITE" "1" "July 2010" "" ""
+.
+.SH "NAME"
+\fBnpm\-site\fR \- Run the npm web site
+.
+.SH "FUTURE"
+This functionality does not yet exist\.
+.
+.SH "SYNOPSIS"
+.
+.nf
+
+npm site start
+.
+.fi
+.
+.SH "DESCRIPTION"
+This starts up npm in "site" mode\. The following configs are relevant, and can either be specified in the \fB\.npmrc\fR file, or as command line options\.
+.
+.TP
+userfile
+A file containing the encrypted authorization info for all users\. If specified, then this is used for \fBnpm adduser\fR requests to this registry\.
+.
+.br
+
+.
+.TP
+admin
+A comma\-delimited list of admin users\. All of these must already be in the local adduser config\. If there is no admin, then the site will not allow remote management\. All admin usernames must already be in the userfile, and a userfile must be specified\.
+.
+.TP
+port
+Ports to listen on for WS requests, in the form "http\-port,https\-port"\. Defaults to "15080,15443"\.
+.
+.TP
+registry
+If a package is not found, then its contents will be fetched from the upstream registry, and cached for future retrieval\.
+.
+.IP
+isaacs: Make sure that this does loop\-detection, so that a "ring" of registries can work as a distributed network\. Also, once we have support for checking multiple registries, you could have a distribution ring that secondarily depends on some other upstream resource\.
+.
+.P
+The content for the site is stored in the npm cache directory, which is inside the folder used for the \fBroot\fR setting, at \fB{root}/\.npm/\.cache\fR\. It is organized in a simple hierarchical folder structure corresponding to the web service URLs that npm uses\.
+.
+.SH "POST /\-/action"
+When an admin is specified, starting the npm site also enables the special \fBPOST /\-/action\fR command for doing remote management\. The body of the POST request is an object with the following members:
+.
+.TP
+argv
+Array of positional command\-line arguments\.
+.
+.TP
+config
+Hash of name\-value pairs to override the default configuration\.
+.
+.P
+The npm site starts up with the default configuration set to the resolved configuration at the time of startup\. For instance, if you do:
+.
+.IP "" 4
+.
+.nf
+
+npm site \-\-foo bar
+.
+.fi
+.
+.IP "" 0
+.
+.P
+then the "foo" config will be set to "bar" for the purposes of commands specified via \fBPOST /\-/action\fR\.