Infrastructure/verdaccio
0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2025-01-13 22:48:31 -05:00
Code Issues Activity

(wiki): Relocated server advanced configuration to wiki

Browse source
This commit is contained in:
Juan Picado @jotadeveloper 2017-06-24 10:11:08 +02:00
parent 73cc898f6b
commit 9036126359
No known key found for this signature in database
GPG key ID: 18AC54485952D158
4 changed files with 74 additions and 53 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -55,7 +55,7 @@ Now you can navigate to [http://localhost:4873/](http://localhost:4873/) where y
When you start a server, it auto-creates a config file. When you start a server, it auto-creates a config file.
**For instructions on how to run Verdaccio as a service, with a nice URL or behind a proxy have a look at the [server-side configure document](SERVER.md).** **For instructions on how to run Verdaccio as a service, with a nice URL or behind a proxy have a look at the [server-side configure document](wiki/server.md).**
### Docker ### Docker

2
wiki/README.md
View file

@ -8,10 +8,12 @@ from a fresh look at the code and the outstanding issues. So here we are 🎉
## Advanced Configurations ## Advanced Configurations
* [SSL Certificates](ssl.md) * [SSL Certificates](ssl.md)
## Servers ## Servers
* [Advanced Server Configuration](server.md)
* [Reverse Proxy](reverse-proxy.md) * [Reverse Proxy](reverse-proxy.md)
### Windows Configurations ### Windows Configurations

60
wiki/reverse-proxy.md
View file

@ -12,8 +12,37 @@ Apache and mod_proxy should not decode/encode slashes and leave them as they are
</VirtualHost> </VirtualHost>
```` ````
### Configuration with SSL
config.yaml
```yaml
url_prefix: https://npm.your.domain.com
```
Apache virtual server configuration
````
apacheconfig
<IfModule mod_ssl.c>
<VirtualHost *:443>
ServerName npm.your.domain.com
SSLEngine on
SSLCertificateFile /etc/letsencrypt/live/npm.your.domain.com/fullchain.pem
SSLCertificateKeyFile /etc/letsencrypt/live/npm.your.domain.com/privkey.pem
SSLProxyEngine On
ProxyRequests Off
ProxyPreserveHost On
AllowEncodedSlashes NoDecode
ProxyPass / http://127.0.0.1:4873/ nocanon
ProxyPassReverse / http://127.0.0.1:4873/
</VirtualHost>
</IfModule>
````
## Nginx ## Nginx
```` ````
server { server {
listen 80 default_server; listen 80 default_server;
@ -22,4 +51,35 @@ server {
proxy_set_header Host $host; proxy_set_header Host $host;
} }
} }
````
## Run behind reverse proxy with different domain and port
If you run verdaccio behind reverse proxy, you may noticed all resource file served as relaticve path, like `http://127.0.0.1:4873/-/static`
To resolve this issue, you should send real domain and port to verdaccio with `Host` heade
Nginx configure should look like this:
```nginx
location / {
proxy_pass http://127.0.0.1:4873/;
proxy_set_header Host $host:$server_port;
proxy_set_header X-Forwarded-For $remote_addr;
}
``` ```
For this case, `url_prefix` should NOT set in verdaccio config
---
or a sub-directory installation:
```nginx
location ~ ^/verdaccio/(.*)$ {
proxy_pass http://127.0.0.1:4873/$1;
proxy_set_header Host $host:$server_port;
proxy_set_header X-Forwarded-For $remote_addr;
}
```
For this case, `url_prefix` should set to `/verdaccio/`
> Note: There is a Slash after install path (`https://your-domain:port/vardaccio/`)!

61
SERVER.md → wiki/server.md
View file

@ -1,12 +1,16 @@
# Server configuration
This is mostly basic linux server configuration stuff but I felt it important to document and share the steps I took to get verdaccio running permanently on my server. You will need root (or sudo) permissions for the following. This is mostly basic linux server configuration stuff but I felt it important to document and share the steps I took to get verdaccio running permanently on my server. You will need root (or sudo) permissions for the following.
## Running as a separate user ## Running as a separate user
First create the verdaccio user: First create the verdaccio user:
```bash ```bash
$ sudo adduser --disabled-login --gecos 'Verdaccio NPM mirror' verdaccio $ sudo adduser --disabled-login --gecos 'Verdaccio NPM mirror' verdaccio
``` ```
You create a shell as the verdaccio user using the following command: You create a shell as the verdaccio user using the following command:
```bash ```bash
$ sudo su verdaccio $ sudo su verdaccio
$ cd ~ $ cd ~
@ -16,40 +20,12 @@ The 'cd ~' command send you to the home directory of the verdaccio user. Make su
## Listening on all addresses ## Listening on all addresses
If you want to listen to every external address set the listen directive in the config to: If you want to listen to every external address set the listen directive in the config to:
```yaml ```yaml
# you can specify listen address (or simply a port) # you can specify listen address (or simply a port)
listen: 0.0.0.0:4873 listen: 0.0.0.0:4873
``` ```
## Run behind reverse proxy with different domain and port
If you run verdaccio behind reverse proxy, you may noticed all resource file served as relaticve path, like `http://127.0.0.1:4873/-/static`
To resolve this issue, you should send real domain and port to verdaccio with `Host` heade
Nginx configure should look like this:
```nginx
location / {
proxy_pass http://127.0.0.1:4873/;
proxy_set_header Host $host:$server_port;
proxy_set_header X-Forwarded-For $remote_addr;
}
```
For this case, `url_prefix` should NOT set in verdaccio config
---
or a sub-directory installation:
```nginx
location ~ ^/verdaccio/(.*)$ {
proxy_pass http://127.0.0.1:4873/$1;
proxy_set_header Host $host:$server_port;
proxy_set_header X-Forwarded-For $remote_addr;
}
```
For this case, `url_prefix` should set to `/verdaccio/`
> Note: There is a Slash after install path (`https://your-domain:port/vardaccio/`)!
> Apache configure? Please check out Wiki ;-) > Apache configure? Please check out Wiki ;-)
## Keeping verdaccio running forever ## Keeping verdaccio running forever
@ -57,11 +33,13 @@ We can use the node package called 'forever' to keep verdaccio running all the t
https://github.com/nodejitsu/forever https://github.com/nodejitsu/forever
First install forever globally: First install forever globally:
```bash ```bash
$ sudo npm install -g forever $ sudo npm install -g forever
``` ```
Make sure you've started verdaccio at least once to generate the config file and write down the created admin user. You can then use the following command to start verdaccio: Make sure you've started verdaccio at least once to generate the config file and write down the created admin user. You can then use the following command to start verdaccio:
```bash ```bash
$ forever start `which verdaccio` $ forever start `which verdaccio`
``` ```
@ -78,35 +56,16 @@ $ crontab -e
This might ask you to choose an editor. Pick your favorite and proceed. This might ask you to choose an editor. Pick your favorite and proceed.
Add the following entry to the file: Add the following entry to the file:
``` ```
@reboot /usr/bin/forever start /usr/lib/node_modules/verdaccio/bin/verdaccio @reboot /usr/bin/forever start /usr/lib/node_modules/verdaccio/bin/verdaccio
``` ```
The locations may vary depending on your server setup. If you want to know where your files are you can use the 'which' command: The locations may vary depending on your server setup. If you want to know where your files are you can use the 'which' command:
```bash ```bash
$ which forever $ which forever
$ which verdaccio $ which verdaccio
``` ```
## Apache reverse proxy configuration
config.yaml
```yaml
url_prefix: https://npm.your.domain.com
```
Apache virtual server configuration
```apacheconfig
<IfModule mod_ssl.c>
<VirtualHost *:443>
ServerName npm.your.domain.com
SSLEngine on
SSLCertificateFile /etc/letsencrypt/live/npm.your.domain.com/fullchain.pem
SSLCertificateKeyFile /etc/letsencrypt/live/npm.your.domain.com/privkey.pem
SSLProxyEngine On
ProxyRequests Off
ProxyPreserveHost On
AllowEncodedSlashes NoDecode
ProxyPass / http://127.0.0.1:4873/ nocanon
ProxyPassReverse / http://127.0.0.1:4873/
</VirtualHost>
</IfModule>
```