Tumult

Tumult is a content aggregator used to publish data from several locations onto one single page for easy viewing. It's written in PHP and utilizes Markdown to serve up static content such as blog posts and "About Me" blurbs.

Statics (Blog Posts, Static Blocks)

Statics are used to describe content that is handled entirely by Tumult. Static blocks are markdown files that get parsed. Blog posts are things that you handle, they can be created and stored just like static blocks or they can be stored in a GitHub repo for easier editing.

Services

Think of these as the bulk of your content. Yeah, you can have static content, but that gets old for frequent site vistors. Services are things like your Tweets from Twitter and your latest listened to tracks on Last.fm. Services will be expanding and could include any number of things that you can provide for your visitors.

Services are written to be as easy to add as possible. Unless there's an authentication requirement, you can simply drop a service into the services folder, and update the TUMULT_SERVICES array in config/master.php with the service's folder name. If authentication is required you only need to modify the config/keys.php file and include the required defines. Additional configuration, for all services, can be achieved by creating a file and throwing it in your config directory. More information on this can be found on each individual services wiki article.

Themes

Almost every HTML template can become a Tumult theme. Themes require 3 files to function:

template.html -> This is where everything between the <body> tags goes.
styles.php -> This is where your block styles go.
settings.php -> You define your theme's name and this is where you define your stylesheets and where you can add custom code to the header or footer of the page.

The rest of the content inside your theme's folder is totally up to you. You can read more on the wiki.

Requirements

Current lowest requirements:

PHP 5.6+

Optional Requirements

Here are some things that are supported, but not required:

A GitHub repo to store blog posts. This will allow you to add, edit, and remove blog posts without needing access to an FTP client.

Installation

Download the files in the releases tab, or get the repo files for more fixes.
Unzip the contents somewhere on your computer.
Modify config/master.example.php and save it as config/master.php
If you are using services, rename config/keys.example.php to config/keys.php and populate the required data.
Upload everything to your desired location.
Make sure the cache/ directory is readable and can be written to (mostly 777, or 0777, however you pronounce it).

That's it! Congratulations!

If you want to utilize GitHub to store your blog posts read up on it in the wiki!

septor / tumult