How to build

Get the source

> git clone
> cd

Set up the build environment — the easy way

The easiest way to set up a build environment is to use docker.

Set up the build environment — the hard way


Ensure Rake is installed

Make sure Rake is available. It is often installed per default.

> rake --version

If you get "command not found":

> gem install rake

Ensure Bundler is installed

Make sure Bundler (version >= 1.10) is available. It manages your Ruby gems locally to the project and prevents version conflicts between different Ruby projects. Quoting from the website:

Bundler provides a consistent environment for Ruby projects by tracking and installing the exact gems and versions that are needed.

> bundle -v

If you get "command not found" or a version < 1.10:

> gem install bundler

Setup awestruct

> rake setup

Serve the site locally

rake preview

Point your browser to http://localhost:4242

Tips & Tricks

How to edit/publish content

Refer to this guide

Which other tasks exist in the Rake build file?

> rake --tasks

This will list the available tasks with a short description

I am getting errors when trying to execute awestruct directly

You need to use bundle exec <command> to make sure you get all required Gems. Check the Rakefile to see how the different awestruct calls are wrapped.

If you are getting error after an update

> rake clean[all]
> rake setup
> rake preview

If your changes are not visible…​

Panic! Then completely regenerate the site via:

> rake clean preview

Fedora 23 setup

Make sure the user is in the sudo group and install required dependencies for compilation of native extensions:

> sudo dnf -y install gcc-c++ make ruby-devel libxml2-devel libxslt-devel redhat-rpm-config

This is required regardless how you proceed from here (provided Ruby version vs RVM)

Using Ruby version provided by the Fedora packages

> sudo dnf -y install ruby
> gem install rake bundler

Continue here

Using RVM

How to Integrating RVM with gnome-terminal:

How to install RVM (

Install the GPG key:

gpg2 --keyserver hkp:// --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3

Install a stable Ruby version:

curl -sSL | bash -s stable --ruby
git clone
echo "rvm ruby-2.2@global" > .rvmrc

Load the .rvmrc file:

cd ../

Say yes to .rvmrc execution.

Continue here


The content of this repository is released under the ASL 2.0.

By submitting a "pull request" or otherwise contributing to this repository, you agree to license your contribution under the respective licenses mentioned above.


This website uses JBoss Community Bootstrap.

Back to top