codimd

Table of Contents

1. Description
2. Setup - The basics of getting started with codimd
   • What codimd affects
   • Setup requirements
   • Beginning 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.

Reference

Table of Contents

Classes

Public Classes

• codimd: Puppet Module to install and configure codiMD

Private Classes

• codimd::config: Configure CodiMD
• codimd::install: Install CodiMD
• codimd::service: Startup CodiMD
• codimd::user: Configure the CodiMD application user

Data types

• Codimd::Db:
• Codimd::Dialect:

Classes

codimd

Puppet Module to install and configure codiMD

Parameters

The following parameters are available in the codimd class.

version

Data type: String

Which version of CodiMD should be installed. Gets passed though to the vcsrepo resource.

Default value: 'master'

config

Data type: Hash[String,Data]

Configuration of CodiMD. Gets place in the "production" hash of the config.json.

Data types

Codimd::Db

The Codimd::Db data type.

Alias of Struct[{ username => String[1], password => String[1], database => String[1], host => String[1], port => Stdlib::Port, dialect => Codimd::Dialect, }]

Codimd::Dialect

The Codimd::Dialect data type.

Alias of Enum['mysql', 'mariadb', 'sqlite', 'postgres', 'mssql']

Change log

All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v0.2.0 (2020-07-06)

Full Changelog

Added

• Make source url configurable #1 (gsterling)

* This Changelog was automatically generated by github_changelog_generator