Skip to content

Commit 4a8c658

Browse files
committed
Added installation instructions
1 parent 61ee61c commit 4a8c658

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

+32-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,37 @@
11
# verdaccio-windows
22

3-
Install and run Verdaccio on windows as a service
3+
[Verdaccio](https://verdaccio.org/) is very useful server that provides "A lightweight private npm proxy registry".
4+
5+
This package allows the installation and running of Verdaccio as a Windows Service.
6+
7+
## Installation
8+
9+
1. Install nodejs for windows.
10+
2. Download the release zip file and uzip to an install location.
11+
3. Change to the install location and run `npm install --production`.
12+
4. Create a [verdaccio configuration file](https://verdaccio.org/docs/en/configuration) to configure your verdaccio installation.
13+
5. Use the service [install](#install) command with the -c flag to point to your config file.
14+
`node service.js install -c path\to\verdaccio-config.yaml`
15+
6. Use the service [start](#start) command to start your service.
16+
17+
### Installation Notes
18+
19+
Windows firewall may need to be configured to allow the node process act as a server.
20+
21+
#### Customizing the service name
22+
23+
Use can the --name -n option to customize the windows service name. See the [install](#install) command for more service configuration options.
24+
25+
#### Running verdaccio from the command line
26+
27+
Use the runner script with the `-c` option:
28+
`node runner.js -c path\to\verdaccio-config.yaml`
29+
This is useful to see the verdaccio's output for any errors.
30+
31+
#### Default Logs
32+
33+
When the service is created the install location will have a `daemon` sub directory. By default the service logs verdaccio standard output and error to this folder. This location can be changed using the service.js [install](#install)'s `--logs` option.
34+
**NOTE** By default verdaccio logs all http requests, so the log files can get very large. To address this use the [verdaccio configuration file](https://verdaccio.org/docs/en/configuration) to setup [logging](https://verdaccio.org/docs/en/logger).
435

536
## Usage
637

0 commit comments

Comments
 (0)