Forge Home

chocolatey_server

The Chocolatey Simple Server Package Feed Host

23,816 downloads

13,667 latest version

2.8 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.0.5 (latest)
  • 0.0.4
  • 0.0.3
  • 0.0.2
  • 0.0.1
released Oct 11th 2016
This version is compatible with:

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'chocolatey-chocolatey_server', '0.0.5'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add chocolatey-chocolatey_server
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install chocolatey-chocolatey_server --version 0.0.5

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

chocolatey/chocolatey_server — version 0.0.5 Oct 11th 2016

Chocolatey Simple Server

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with chocolatey
  4. Usage - Configuration options and additional functionality
  5. Reference
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Overview

Sets up a Simple Server for Chocolatey packages. Allows you to host your own packages, many times as a private package repository (feed).

Module Description

There are three types of package feeds for Chocolatey - local folder/CIFS (UNC) share, simple server, and the sophisticated package gallery. Simple server is in the middle and most widely used Chocolatey/NuGet Package Server format.

Advantages:

  • Push over HTTP/HTTPS.
  • API key for pushing packages.
  • No direct access to packages - acls are locked down to just admins and push through api key.
  • Package store is file system.

Disadvantages:

  • Only one API key, so no multi user scenarios.
  • Starts to affect choco performance once the source has over 500 packages (maybe?).
  • No moderation.
  • No website to view packages.
  • No package statistics.

For more details about the other types of package feeds, see host your own feed.

Setup

What Chocolatey Server affects

  • Will create files at c:\tools\chocolatey.server.
  • Will install IIS and ASP.NET if not already installed.
  • Will remove the default website.
  • Sets up a website on port 80 (configurable) pointing to chocolatey.server

Setup Requirements

Beginning with Chocolatey Server

Install this module via any of these approaches:

Usage

Ensure the server is installed and configured:

include chocolatey_server

Use a different port

class {'chocolatey_server':
  port => '8080',
}

Use an internal source for installing the chocolatey.server package

class {'chocolatey_server':
  server_package_source => 'http://someinternal/nuget/odatafeed',
}

Use a local file location for the chocolatey.server package

class {'chocolatey_server':
  server_package_source => 'c:/folder/containing/packages',
}

Reference

Classes

Public classes

Class: chocolatey_server

Host your own Chocolatey package repository

Parameters

port

The port for the server website. Defaults to '80'.

server_package_source

The Chocolatey source that contains the chocolatey.server package. Defaults to 'https://chocolatey.org/api/v2/'.

Limitations

Works with Windows only.

Development

We like Pull Requests!