Quick Start

Installation

  1. Install and run Requirements
  2. Configure the Database
  3. Download and install Kereru for your system
  4. Generate Twitter API Keys

Configuration

From a root shell, run the Kereru first time setup tool

# kereru_setup

Answer the questions, defaults for most settings should get you a working system.

Launch Kereru web application

The Config File must exist before running the Kereru web application

Packaged versions create a kereru user and group.

To run the Kereru web application using systemd:

# systemctl enable --now kereru_app.service

To run the Kereru web application manually, launch as the kereru user:

$ kereru_app

Launch Kereru bot

The Config File must exist before running the Kereru bot

The Kereru bot is a seperate service that sends tweets. The Kereru bot must be running for tweets to send.

To run the Kereru bot using systemd:

# systemctl enable --now kereru_bot.service

To run the Kereru bot manually, launch as the kereru user:

$ kereru_bot

First Run

Connect to the Kereru web application, by default http://localhost:8080/.

The Kereru web application will prompt to create the first account. This account will be the Kereru adminstrator.

Your First Tweet

In the Kereru web application, create a new tweet from the “New Tweet” page from the navigation menu.

A tweet requires a date and time in Coordinated Universal Time (UTC) and a message. Saving a new tweet will create a Draft status tweet.

To change a tweet’s status, click the status from the Status column on the “List Tweets” page. A Draft status tweet is first moved to Reviewed status, then to Ready status.

Tweets that are Ready status will be sent after the tweet’s date and time has been reached.