Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
app
 
 
bin
 
 
 
 
db
 
 
 
 
lib
 
 
log
 
 
 
 
 
 
 
 
 
 
tmp
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Build Code Climate Test Coverage

Sugar

Sugar is a modern open-source forum optimized for performance and usability, written in Ruby on Rails.

Dependencies

Both PostgreSQL and MySQL are supported.

Installation

If you want to hack on Sugar, the easiest way to get up and running is using Docker Compose:

$ docker-compose build
$ docker-compose run rails bundle install
$ docker-compose run rails bin/rails db:prepare
$ docker-compose up

Sugar is now running on localhost:3000.

You can run the tests and linters with:

$ docker-compose run rails RAILS_ENV=test bin/rails db:prepare
$ docker-compose run rails bin/rspec
$ docker-compose run rails bin/rubocop

Deploying Sugar

Sugar is deployed like a regular Rails app, see the official Rails site. A sample Capistrano recipe is provided config/deploy.rb.dist.

For production use, you'll want a full grown Solr setup. See the Sunspot documentation for guides on how to get up and running.

Heroku is currently not supported.

Configuring Sugar

Most of Sugar is configured with a web interface. However, a few details must be sorted out before the app starts. The defaults should be fine for development, but you need tweak these settings for production use with environment variables.

Environment variable Required Info
SUGAR_SECRET_KEY_BASE Yes Set to a long, random string
SUGAR_SECRET_TOKEN - Use if you are upgrading from Rails 3
SUGAR_SESSION_KEY - Default: _sugar_session
SUGAR_DB - Database backend. Default: mysql, also valid: postgresql
SUGAR_DB_DATABASE - Default: sugar_<%= Rails.env %>
SUGAR_DB_HOST - Default: localhost
SUGAR_DB_USERNAME - Default: rails
SUGAR_DB_PASSWORD - Default: ``
SENTRY_DSN - Default: none, set if you want to use Sentry

Credits

Thanks to the members of the B3S community for feedback, ideas and encouragement, names far too many to be mentioned. Napkin was written by Branden Hall of Automata Studios.

License

Copyright (c) 2008 Inge Jørgensen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

You can’t perform that action at this time.