codimd

contributions requested
pdk
Puppet Module to install and configure codiMD

2,923 downloads

1,444 latest version

5.0 quality score

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.2.0 (latest)
  • 0.1.0
released Jul 6th 2020
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x
  • Puppet >= 5.5.8 < 7.0.0
  • Ubuntu

Start using this module

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

Add this module to your Puppetfile:

mod 'baurmatt-codimd', '0.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add baurmatt-codimd
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install baurmatt-codimd --version 0.2.0

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

baurmatt/codimd — version 0.2.0 Jul 6th 2020

codimd

Build Status Puppet Forge Puppet Forge - downloads Puppet Forge - endorsement Puppet Forge - scores

Table of Contents

  1. Description
  2. Setup - The basics of getting started with codimd
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module

Description

This module installs and configure CodiMD. It's inspired by the puppet-etherpad module.

Setup

What codimd affects

  • This module depends on puppet-nodejs
  • It also depends on puppetlabs-vcsrepo and hence git
  • It will setup a service using systemd
  • It will install all npm dependencies and keep them in sync on updates
  • It will also run db migration automatically on updates

Setup Requirements

This module requires a database. Though it can use sqlite, it's recommend to use PostgreSQL or MySQL. See CodiMD offical documentation for further advice.

Beginning with codimd

Before to installation, a target database should exist. Please consult the documentation of puppetlabs-postgresql, or puppetlabs-mysql for how to create those.

Usage

The basic usage is:

class { 'codimd':
  config => {
    host   => 'localhost',
    domain => 'codimd.example.org',
    db     => {
      username => 'codimd',
      password => 'mySuperSecurePassword',
      database => 'codimd',
      host     => '127.0.0.1',
      port     => 3306,
      dialect  => 'mysql',
    },
  },
}

Pin the version if you don't like automatic updates

class { 'codimd':
  config  => {
  ...
  },
  version => '1.5.0',
}

Reference

For information on the classes and types, see the REFERENCE.md.

Limitations

  • Only systemd is supported as Service provider.
  • Most things are currently hardcoded.
  • Module is only tested on Ubuntu 18.04

PRs are very welcome! :)

Development

This module is development with the help of pdk.

Please follow the standard Puppet development processes as lived by Puppetlabs/Vox Pupuli.