Cloud Zone is brought to you in partnership with:

I am a passionate programmer and cloud enthusiast, currently working for Qburst Technologies(http://www.qburst.com/) at Kerala, India. While not in work, I spends his time coding personal projects, experimenting, learning, and blogging. Other areas of interest include system and database administration, reading etc. You can find my personal blog at http://shameerc.com and on twitter @shameerc. Shameer has posted 8 posts at DZone. You can read more from them at their website. View Full User Profile

Toto on Heroku Allows for Ninja-Style Blogging

03.13.2012
| 3287 views |
  • submit to reddit

Toto is a very simple blog publishing engine written in Ruby and created by Alexis Sellier, popularly known as @cloudhead (creator of LESS). Toto’s a flat-file blogging engine which means it doesn’t need a database and, unlike many other blogging engines, doesn’t have an admin panel either.

Articles are written in text files and you can use markdown or html inside the file. Toto itself is a Ruby gem designed to run on Heroku. We’ll be using Git, the most popular distributed version control system, to deploy the application and publish articles. That means publishing a new article is as simple as a Git push command.

Prerequisites

You must have Ruby, Git, and RubyGems installed in your system. As we are deploying the application in Heroku, you need to have a Heroku account and install the Heroku gem. This article describes how to install Ruby, RubyGems, Git, and Heroku in Ubuntu. If you’re using Windows, you may need to check Heroku documentation. To run and test our application locally, we’re using a light-weight server named thin.

We use Ubuntu OS, so this article is from a Linux perspective. To install toto in Ubuntu, run the following from the command line:

shameer@ubuntu:~/dev$sudo gem install toto

If you have Ruby and RubyGems installed already, it will complete the installation without any problems. Before continuing you need to install thin server to run the blog locally. Thin is also a Ruby gem.

shameer@ubuntu:~/dev$sudo gem install thin

I assume that you have already installed Git. Now clone the Dorothy template from GitHub. Dorothy is the default template for toto.

shameer@ubuntu:~/dev$git clone https://github.com/cloudhead/dorothy.git myblog

Navigate to myblog directory and run

shameer@ubuntu:~/dev/myblog$thin start

 

from the command line. That’s all! Now you have a sample toto blog running. You can access the blog via your browser using

http://0.0.0.0:3000/.

Okay, it’s time to deploy our application. Create a Heroku application from the command line:

shameer@ubuntu:~/dev/myblog$heroku  create

You can check the web dashboard of Heroku to see the created application. If you check the config file of Git repo, you can see a new remote added with name ‘heroku’.

shameer@ubuntu:~/dev/myblog$cat .git/config

[core]
repositoryformatversion = 0
filemode = true
bare = false
logallrefupdates = true
[remote "origin"]
fetch = +refs/heads/*:refs/remotes/origin/*
url = https://github.com/cloudhead/dorothy.git
[branch "master"]
remote = origin
merge = refs/heads/master
[remote "heroku"]
url = git@heroku.com:freezing-meadow-8547.git
fetch = +refs/heads/*:refs/remotes/heroku/*

Now let’s push the initial application to Heroku:

shameer@ubuntu:~/dev/myblog$git push heroku master

This will deploy the application to Heroku and our application will start automatically. If you check it in your browser, you will see toto running.

Toto filesystem

articles
public
  css
  images
  js
templates
  pages
    about.rhtml
    archives.rhtml
    article.rhtml
    index.rhtml
    index.builder
  layout.rhtml

 

The articles directory holds all our articles. The name of each article should be in the format yyyy-mm-dd-your-long-article-title.txt. It’s important that you should keep the title and filenames the same. The Public folder will have css, js, and image files for template, and the Template folder will contain the page layout (layout.rhtml) and the templates of inner pages, such as about, archives, etc.

Writing a new article

To publish a new article you can open up your favorite text editor and start writing. You can use markdown or html in the article. Every article will have two sections, meta and content. The meta part is simply YAML formatted key: value pairs to specify the metadata of the article. If you take a look into the default article in article folder, you will see the following meta information.

title: The Wonderful Wizard of Oz
author: Lyman Frank Baum
date: 1900/05/17

Here the title and date are the only mandatory bits of information. In addition to those, we can also have tags or categories in this section, which can be displayed in the article page. Begin the content section leaving one line after the meta section. Once you finish the article, go to the toto blog root and from the command line and run git status:

shameer@ubuntu:~/dev/myblog$ git status

It will show we have a new file which has not been added to the repository. Next we can add the file to the repository and commit it.

shameer@ubuntu:~/dev/myblog$ git add .
shameer@ubuntu:~/dev/myblog$ git commit -m “Added second article”

Now you have the second article published in local dev server. If you like, you can run thin server to see the changes locally. Now, publish the article to Heroku using Git:

shameer@ubuntu:~/dev/myblog$ git push heroku master

Our second article is now published in Heroku.

Summary

In this article I have described how to start a simple, blazingly fast blog using toto and Heroku. I have explained only the basic features of toto. In fact, it can do much more than we discussed here, such as have more sophisticated templates, custom pages, etc. Since it doesn’t have an admin panel to hack, it’s a highly secure platform to use.

There are some limitations in the current toto gem. We can’t use all the HTML5 features inside articles since our current markup parser doesn’t support them. Also we don’t have a choice about URL structure. Another big drawback is, you can’t have much dynamic content like comments, search, etc. in the site. Though we can show tags and categories, we can’t have the list of articles under a certain category or tag. I am sure true ninjas won’t be happy with these limitations. To overcome these drawbacks we will need to customize our templates and toto engine to add more functionality. I will describe how to do this in my next article.

Published at DZone with permission of its author, Shameer Cee. (source)

(Note: Opinions expressed in this article and its replies are the opinions of their respective authors and not those of DZone, Inc.)