https://github.com/verdaccio/puppet-verdaccio
Puppet verdaccio support
https://github.com/verdaccio/puppet-verdaccio
puppet puppet-scripts puppet-verdaccio redhat
Last synced: 6 months ago
JSON representation
Puppet verdaccio support
- Host: GitHub
- URL: https://github.com/verdaccio/puppet-verdaccio
- Owner: verdaccio
- License: mit
- Created: 2017-03-01T12:40:09.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-11-29T18:35:41.000Z (over 5 years ago)
- Last Synced: 2024-10-30T00:54:48.889Z (6 months ago)
- Topics: puppet, puppet-scripts, puppet-verdaccio, redhat
- Language: Puppet
- Homepage: http://www.verdaccio.org/
- Size: 38.1 KB
- Stars: 3
- Watchers: 12
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# puppet-verdaccio module
## Overview
Install verdaccio npm-cache-server (https://github.com/verdaccio/verdaccio) for Debian, Ubuntu, Fedora, and RedHat.
## Usage
There are two variants to install verdaccio using this Puppet module: Apply-mode (with puppet-apply and no puppetmaster setup needed) or Master-Agent-mode (with puppet-agent accessing your configuration through the puppetmaster). In both variants you have to explicitely call "class nodejs {}" in your puppet script because the puppet-verdaccio module only defines this as a requirement, so you have all the flexibility you want when installing nodejs. Scroll down for details about Master-Agent-mode variant.
### General usage
#### class verdaccio
Installs verdaccio + required npms in one defined directory and integrates the verdaccio as a service (/etc/init.d/verdaccio). It also creates a user to run the verdaccio server (default: verdaccio). If you wish, you can change the username, see examples below.
Examples:
minimal:
```bash
class { '::verdaccio':
conf_admin_pw_hash => 'your-pw-hash',
}
```
You can generate the admin password hash according to https://github.com/verdaccio/verdaccio via command-line:
```bash
$ node
> crypto.createHash('sha1').update('your-admin-password').digest('hex')
```
If you want to manage user accounts with an `htpasswd` file instead of a list of users, omit `config_admin_pw_hash`, set `htpasswd_auth => true` and decide how to manage the `htpasswd` file, e.g.:
```
class { '::verdaccio':
htpasswd_auth => true,
}
file { '/opt/verdaccio/htpasswd':
ensure => present,
source => 'puppet:///modules/site/verdaccio/htpasswd',
owner => 'verdaccio',
group => 'verdaccio',
mode => '0600',
}
```
You can also override several configuration parameters.
```bash
class { '::verdaccio':
install_root => '/usr/local',
install_dir => 'verdaccioxy',
conf_admin_pw_hash => 'your-pw-hash',
conf_port => '8080',
daemon_user => 'verdaccioxy',
conf_listen_to_address => '127.0.0.1',
http_proxy => 'http://proxy.com:3128',
https_proxy => 'http://proxy.com:3128',
conf_template => 'mymodule/config.yaml.erb',
service_template => 'mymodule/service.erb',
service_ensure => 'stopped',
conf_max_body_size => '10mb',
conf_max_age_in_sec => '604800',
install_as_service => false,
public_npmjs_proxy => false,
url_prefix => 'https://dev.company.local/sinopia/',
time_out => '30000'
htpasswd_auth => true,
}
```
The default values for all so far configurable parameters are:
```bash
class { '::verdaccio':
install_root => '/opt',
install_dir => 'verdaccio',
daemon_user => 'verdaccio',
conf_listen_to_address => '0.0.0.0',
conf_port => '4873',
conf_admin_pw_hash => undef,
conf_user_pw_combinations => undef,
http_proxy => '',
https_proxy => '',
conf_template => 'verdaccio/config.yaml.erb',
service_template => 'verdaccio/service.erb',
service_ensure => 'running',
conf_max_body_size => '1mb',
conf_max_age_in_sec => '86400',
install_as_service => true,
public_npmjs_proxy => true,
url_prefix => undef,
time_out => undef
htpasswd_auth => false,
}
```
The `public_npmjs_proxy` parameter defaults to `true`, and will result in the following `packages` configuration block in your `config.yaml`:
```
packages:
'*':
allow_access: all
allow_publish: authenticated
proxy: npmjs
```
Set it to `false` to define your own package settings using `verdaccio::package` (see below):
```
class { '::verdaccio':
conf_admin_pw_hash => 'your-pw-hash',
public_npmjs_proxy => false,
}
```
#### define verdaccio::package
You can customise the `packages` configuration using defined type `verdaccio::package`:
```
verdaccio::package {
'@public-*/*':
allow_access => 'all',
allow_publish => 'authenticated';
'@private-*/*':
allow_access => 'authenticated',
allow_publish => 'admin',
'*':
allow_access => 'all',
allow_publish => 'admin',
proxy => 'npmjs',
order => '999';
}
```
The `order` parameter is used by [`puppetlabs-concat`](https://github.com/puppetlabs/puppetlabs-concat) to determine the order in which each package section appears in `config.yaml`.
### Master-Agent-mode installation
In your puppet script for your agent add:
```bash
class { 'nodejs':
# this automatically installs nodejs and npm
make_default => true,
}
class { '::verdaccio':
conf_admin_pw_hash => 'your-pw-hash',
}
```
## Supported Platforms
The module has been tested on the following operating systems. Testing and patches for other platforms are welcome.
* RedHat EL7.