Forge Home


Puppet module to manage the Go Git Service (Gogs).


6,946 latest version

3.1 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.8 (latest)
  • 0.0.7
  • 0.0.6
  • 0.0.5
  • 0.0.4
  • 0.0.3
  • 0.0.2
  • 0.0.1
released Jan 29th 2016
This version is compatible with:
  • Puppet Enterprise 3.x
  • Puppet 3.x
  • , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'Siteminds-gogs', '0.0.8'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add Siteminds-gogs
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install Siteminds-gogs --version 0.0.8

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.

Tags: vcs, git, go, gogs


Siteminds/gogs — version 0.0.8 Jan 29th 2016


Travis build status Quantified Code Analysis


This is a Puppet module to install Gogs (Go Git Service, see:

Module Description

Gogs(Go Git Service) is a painless self-hosted Git Service written in Go. The goal of the Gogs project is to make the easiest, fastest and most painless way to set up a self-hosted Git service. With Go, this can be done in independent binary distribution across ALL platforms that Go supports, including Linux, Mac OS X, and Windows.

This Puppet module allows you to manage the Gogs service on linux operating systems. Currently only Debian and RedHat family linux is tested/supported.


In order to use this Gogs module you should be able to simply include it:

include ::gogs


class { '::gogs':
    ensure => present,

Configure it to your needs using the parameters below.



Boolean indicating wheter or not the gogs package repository should be added to the hosts package manager configuration. Default: false.


Value to pass through to the package resource when installing Gogs. Defaults to present.


The environment this Gogs instance is running for. Allowed values are: 'dev', 'test' or 'prod'. Default: 'prod'


Root directory that will contain all Git repositories. If this directory does not exist, it will be created. Please note that the parent directory for the repository root must already exist! Default: '/home/gogs/gogs-repositories'


The domain name the Gogs service should serve/listen to. Default: 'localhost'.


The port the Gogs service should listen on. Default: 6000.


Boolean indicating wheter or not (http) gzip compression should be used. Default: false.


The type of database back-end to be used by Gogs. Allowed values are: 'postgres', 'mysql' or 'sqlite3'. Please note that the packages from, used by this module when you select install_repo = true don't support sqlite3. Also note that this module does not install a database for Gogs. Please use another module e.g. the Puppetlabs/Postgresql module from the forge to install one. Default: 'postgres'.


The hostname of the machine where the Gogs database is running. Default: 'localhost'.


The port of the Gogs database. Default: 5432.


Name of the Gogs database. Default: 'gogs'.


The username credential used for connecting to the Gogs database. Default: 'gogs'.


The password credential used for connecting to the Gogs database. DefaulT: 'gogs'.


For postgres only. Valid values are: 'disable', 'require' or 'verify-full'. Default: 'disable'


Path where sqlite3 should store its data. Only used when db_type = 'sqlite3'.


The secret key. You should provide one for each Gogs instance. When not passed a default secret key will be used.

Features to be added

This module is far from done. I will add more parameters/customization options. This version will just get you up and running with the bare essentials.

Special Notes

This module does not install a database required by Gogs. Please provide your own wrapper or server role module to install either a Postgresql or MySql database. Sqlite3 is not supported by the packages provided on If you provide your own package (install_repo = false), you can ofcourse set the db_type to sqlite3.

Another Gogs quirk is that it does not install an admin user by default. Normally this is done by the first time installer, which configures an admin user in the database. Since this module deliberately does not install a database, you should either add a Gogs admin user to the database with another module or manually. An example SQL insert for this is:

INSERT INTO "user" VALUES (1, 'admin', 'admin', '', '', 'someverylongPDKDF2passwordhash', 0, 0, '', 0, '', '', 'randomsecret', 'randomsaltstring', '2015-01-07 13:58:37', '2015-01-07 13:58:37', true, true, false, '9075fd3adc2d47bc1ae87100e0686399', '', false, 0, 0, 0, 0, '', 0, 0);

The password must be a PDKDF2 encrypted string, using 10000 iterations, keylength 50, the salt value (in this case 'randomsaltstring') and SHA-256 HMAC. You could use the following Go program to generate a password hash:

package main

import (

func main() {
   newPasswd := base.PBKDF2([]byte(os.Args[1]), []byte(os.Args[2]), 10000, 50, sha256.New)
   fmt.Printf("%x\n", newPasswd)

This simple program takes the password as the first argument and the salt value as the second argument. This code is an actual copy of the Gogs code responsible for inserting/updating passwords in the database.