An open source social networking platform in Ruby on Rails
Ruby JavaScript Shell
Latest commit 9976cfe Feb 25, 2010 @mhartl mhartl More README edits
Permalink
Failed to load latest commit information.
app Can now change passwords in demo mode Feb 1, 2010
config Removed auto demo user login Feb 1, 2010
db/migrate Added explanatory note for model declaration Oct 16, 2008
doc
lib Removed auto demo user login Feb 1, 2010
log Added 1st cut of installation readme Mar 2, 2008
public
script Reboostrapped RSpec Apr 22, 2009
spec Removed unused message edit page Apr 22, 2009
stories Added authentication Feb 19, 2008
test fckeditor, has easy, jq_ui helper, revert photo changes, add new icons Jun 25, 2008
vendor Removed FCKEditor support files Apr 22, 2009
.gitignore Ignoring vim swap files Mar 19, 2009
.gitmodules added submodule open_id_authentication Sep 3, 2008
INSTALL Moved INSTALL to the README file for GitHub's pleasure Apr 7, 2008
LICENSE Switched to the MIT License Apr 9, 2009
README.markdown More README edits Feb 24, 2010
Rakefile init Feb 18, 2008
configure_insoshi_local.sh Updates for local repository configuration script Oct 23, 2008
init.rb Got new, index working for people Feb 21, 2008

README.markdown

Insoshi social software

Insoshi is a social networking platform in Ruby on Rails. You can use Insoshi to make custom social networks; see the Insoshi demo site for an example. For support, join the Insoshi Google group.

Insoshi was originally developed by Michael Hartl and Long Nguyen as part of the Y Combinator program, and is presently maintained by Evan Dorn and Logical Reality Design.

Installation prerequisites

The source code to Insoshi is managed via Git, a version control system developed by Linus Torvalds to host the Linux kernel.

Get Git

The first step is to install Git. Linux and Mac users should have no problems; Windows users might have to install Cygwin first.

For more detailed information, check out our guide for Installing Git under the Git Guides.

Set up your local Git repository

The Git Guides also detail our recommended setup for your local repository:

  • Clone of the official repository (git://github.com/insoshi/insoshi.git)
  • Your GitHub fork added as a remote repository
  • Local tracking branches for official 'master' and 'edge' branches
  • Local development branch based off 'edge' and pushed to your GitHub fork

A shell script is available to automate this repository configuration. It is run from the command-line as follows:

$ configure_insoshi_local.sh [GitHub Account Name]

Install libraries and gems

There are several library and gem dependencies needed to run Insoshi.

Libraries

You'll need to install FreeImage or some other image processor (such as ImageMagick/RMagick) and a database (MySQL or PostgreSQL). Install instructions for these are easy to find using Google. (If you're installing FreeImage on Windows, this blog post might be helpful.)

To use Insoshi's search capability, you also need Sphinx. Follow the instructions to install Sphinx for your platform. When running Insoshi in a production envinronment, you should also set up a cron job to rotate the search index as described here. This currently works only with MySQL due to a bug in Ultrasphinx.

Gems

You probably have Rails already, but might not have the others.

$ sudo gem install rails
$ sudo gem install mysql     # for mysql support
$ sudo gem install postgres  # for postgres support
$ sudo gem install chronic

If you're using FreeImage/ImageScience, you'll also need the image_science gem:

$ sudo gem install image_science

If you want Markdown formatting support you can install either RDiscount (fast but platform-dependent):

$ sudo gem install rdiscount

or BlueCloth (slower but pure Ruby)

$ sudo gem install BlueCloth

Installing the app

These are the steps to get up and running with the Insoshi Rails app.

Git steps

Our public Git repository is hosted on GitHub. You can clone the the repository with the command

$ git clone git://github.com/insoshi/insoshi.git

The clone make take a moment to complete (mainly due to the frozen Rails gems).

Then make a local Git branch for yourself:

$ git checkout -b <local_branch>

where you should replace with the name of your choice (without angle brackets!).

For more information on configuring your local clone of our repository, check out our Git Guides, which also includes a scripted Quick Local Repository Setup.

Install script

To run the install script, you first need to set up your database configuration. If you're using MySQL, you can just copy the example file as follows:

$ cp config/database.example config/database.yml

Then open up database.yml and set up the passwords to match your system.

Run the following custom install script

$ script/install

The install script runs the database migration and performs some additional setup tasks (generate an encryption keypair for password management, creating an admin account, etc.)

If the install step fails, you may not have properly set up your database configuration.

Then prepare the test database and run the tests (which are actually RSpec examples in the spec/ directory):

$ rake db:test:prepare
$ sudo gem install rspec-rails
$ spec spec/

If the tests fail in the Photos controller test, double-check that an image processor is properly installed.

At this point, configure and start the Ultrasphinx daemon for the test runtime

$ rake ultrasphinx:configure RAILS_ENV#test
$ rake ultrasphinx:index RAILS_ENV#test
$ rake ultrasphinx:daemon:start RAILS_ENV#test

and re-run the tests

$ rake spec

The search specs detect whether the search daemon is running and weren't performed during the first test run. An initial test run is needed in order to populate the test database for indexing (search specs would fail on an empty database).

To shut down the Ultrasphinx daemon for test

$ rake ultrasphinx:daemon:stop RAILS_ENV#test

Loading sample data

Now load the sample data

$ rake db:sample_data:reload

configure and start the Ultrasphinx daemon for the development runtime

$ rake ultrasphinx:configure
$ rake ultrasphinx:index
$ rake ultrasphinx:daemon:start

and start the server

$ script/server

The rake task loads sample data to make developing easier. All the sample users have email logins @example.com, with password foobar.

Go to http://localhost:3000 and log in as follows:

email: michael@example.com
password: foobar

Admin user

To sign in as the pre-configured admin user, use

email: admin@example.com
password: admin

You should update the email address and password. Insoshi will display warning messages to remind you to do that.

To see site preferences such as email settings, click on the "Admin view" and the click on "Prefs" in the menu. Click the "Edit" link to customize the preferences for your particular site.

License

Insoshi is released under the MIT License. See the LICENSE file for details.