My favorites | Sign in
Project Home Downloads Wiki Issues Source
How to install Substruct
Featured, Phase-Deploy
Updated Aug 26, 2010 by

Installing Substruct


Substruct is not meant for end users or novices to install.

This is a software program made for professional web developers. If you don't have experience developing software you could be extremely frustrated by this process.

These directions assume you already have a working Rails hosting environment. This means...

  • A way to run Rails
    • Webrick (included with Rails)
    • Apache / Mod_rails
  • MySQL
  • Ruby
  • Rails
  • Rubygems

These directions also assume you have some familiarity with developing Rails applications in general and a working knowledge of your file system.


1. Install Imagemagick

Imagemagick is required to resize image files that are uploaded for your products and content.

There are various ways to install it, depending on the operating system you're running.

Here's a link on how to compile ImageMagick from source

This example probably doesn't cover every scenario. If you're confused, please google "how to install imagemagick (your operating system here)"

2. Download & extract the latest release

All releases are stored as tar / gzipped files here:

They are marked with version numbers. Grab the latest one and extract it using TAR or a similar utility.

If you don't know how to extract tarred/gzipped files please go google that.

If you'd rather use SVN to download the latest code click here.

3. Edit your database.yml file

You'll need to have a running database to use Substruct.

  • We develop against MySQL v5.x
    • MySQL v6 is not tested or supported at the current time
  • PostgreSQL has been rumored to work, but nobody on the core team tests against it.

We recommend the following database setup:

  • substruct_development
  • substruct_test
  • substruct_production

Edit your database.yml file to make sure that Rails can access your database properly. For more information on the database.yml file, visit this url:

4. Compile vendored gems

Substruct stores required gem files in the vendor/gems folder for ease of installation. This means you don't have to require the gems, but you still have to build them for your native platform.

Run the following command.

rake gems:build

4. Initialize your database

Run this command from inside the substruct directory you extracted previously

rake db:create
rake substruct:db:bootstrap


Fire up your environment!

ruby script/server

Try to login to http://localhost:3000/admin as ''admin'' / ''admin''


If you're going to be doing credit card transactions you need a processor account. Check out how to get one.

Make sure you check out how to maintain Substruct via cron as well.

Powered by Google Project Hosting