puppet-ttrss

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 ttrss
   • What ttrss affects
   • Beginning with ttrss
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.

Overview

A module for configuring ttrss https://tt-rss.org/gitlab/fox/tt-rss/wikis/home

Module Description

This module ONLY deals with the install and setup of ttrss, it will not setup your webserver or database. See the example folder for usage in a profile.

Setup

This module requires:

• puppet 4.x
• puppetlabs-vcsrepo
• puppetlabs-git

The module has only been tested on Fedora Core 23 and uses puppet 4.x language features

What ttrss affects

Mostly what this module does is check ttrss out into the document root of your desired webserver. It can be used to setup the config.php file for ttrss but this is optional.

By default it will attempt to setup the systemd update_dameon2.php program to keep your feeds up to date.

Usage

The module is intented to be used along side modules such as puppetlabs-apache and puppetlabs-postgresql to setup those resources.

The module has some code for setting up a config.php file. Its not very complete and not well tested. It is intended for use if you're going to import/export your own database rather then browse to the sites install folder to initialize a fresh database.

You can see an example "profile" you might use with this module example folder.

cd example
gem install librarian-puppet 
librarian-puppet install --path /etc/puppet/modules
puppet apply -t ttrss.pp

Limitations

Only supported on Fedora, the mysql codepath should work but hasn't been tested.

Development

Use the github pull request workflow, all development is done master branch