https://github.com/chocolatey-community/puppet-chocolatey_server
Chocolatey Simple Server Puppet Module
https://github.com/chocolatey-community/puppet-chocolatey_server
Last synced: about 2 months ago
JSON representation
Chocolatey Simple Server Puppet Module
- Host: GitHub
- URL: https://github.com/chocolatey-community/puppet-chocolatey_server
- Owner: chocolatey-community
- License: apache-2.0
- Created: 2015-03-10T01:05:21.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-04-23T04:24:46.000Z (about 7 years ago)
- Last Synced: 2024-03-26T19:13:17.427Z (about 1 year ago)
- Language: Ruby
- Size: 30.3 KB
- Stars: 17
- Watchers: 6
- Forks: 19
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - chocolatey-community/puppet-chocolatey_server - Chocolatey Simple Server Puppet Module (Ruby)
README
# Chocolatey Simple Server
#### Table of Contents
1. [Overview](#overview)
2. [Module Description - What the module does and why it is useful](#module-description)
3. [Setup - The basics of getting started with chocolatey](#setup)
* [What chocolatey server affects](#what-chocolatey-server-affects)
* [Setup requirements](#setup-requirements)
* [Beginning with chocolatey server](#beginning-with-chocolatey-server)
4. [Usage - Configuration options and additional functionality](#usage)
5. [Reference](#reference)
* [Classes](#classes)
* [Class: chocolatey_server](#class-chocolatey_server)
6. [Limitations - OS compatibility, etc.](#limitations)
7. [Development - Guide for contributing to the module](#development)
## Overview
Sets up a Simple Server for Chocolatey packages. Allows you to [host your own packages](https://github.com/chocolatey/choco/wiki/How-To-Host-Feed), 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](https://github.com/chocolatey/choco/wiki/How-To-Host-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
* Chocolatey installed
* [`chocolatey/chocolatey`](https://forge.puppet.com/chocolatey/chocolatey) OR [`puppetlabs/chocolatey`](https://forge.puppet.com/puppetlabs/chocolatey)
* **Note:** either or both of these modules can handle ensuring the install of Chocolatey.
### Beginning with Chocolatey Server
Install this module via any of these approaches:
* [puppet forge](http://forge.puppetlabs.com/chocolatey/chocolatey_server)
* git-submodule ([tutorial](http://goo.gl/e9aXh))
* [librarian-puppet](https://github.com/rodjek/librarian-puppet)
* [r10k](https://github.com/puppetlabs/r10k)
## Usage
Ensure the server is installed and configured:
~~~puppet
include chocolatey_server
~~~
### Use a different port
~~~puppet
class {'chocolatey_server':
port => '8080',
}
~~~
### Use an internal source for installing the `chocolatey.server` package
~~~puppet
class {'chocolatey_server':
server_package_source => 'http://someinternal/nuget/odatafeed',
}
~~~
### Use a local file location for the `chocolatey.server` package
~~~puppet
class {'chocolatey_server':
server_package_source => 'c:/folder/containing/packages',
}
~~~
## Reference
### Classes
#### Public classes
* [`chocolatey_server`](#class-chocolatey_server)
### 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!