Welcome to mirror list, hosted at ThFree Co, Russian Federation.

site.md « future-ideas « doc - github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 7936e71f7b1e74a95e8cfc1d49f13ac539145e5a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
npm-site(1) -- Run the npm web site
===================================

## FUTURE

This functionality does not yet exist.

## SYNOPSIS

    npm site [ start | stop ]

## DESCRIPTION

This starts up npm in "site" mode.  The following configs are relevant,
and can either be specified in the `.npmrc` file, or as command line
options.

* userfile:
  A file containing the encrypted authorization info for all users.  If
  specified, then this is used for `npm adduser` requests
  to this registry.  
* 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.
* listen:
  Ports to listen on for WS requests.  The first number is for http,
  the second for https, and the third for secure TCP.  Set any to "-",
  or omit, to use the default.
  Defaults to "80,443,15443"
* registry:
  If a package is not found, then its contents will be fetched from the
  upstream registry, and cached for future retrieval.

  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.

The content for the site is stored in the npm cache directory, which is
inside the folder used for the `root` setting, at `{root}/.npm/.cache`.
It is organized in a simple hierarchical folder structure corresponding
to the web service URLs that npm uses.

## TCP Server

The TCP server starts up to support the `npm remote` command, if there is
a valid admin userlist.

## NOTE

This also is what happens when you do `npm start npm`.

## SEE ALSO

* npm-remote(1)
* npm-config(1)