Skip to content

Latest commit

 

History

History
80 lines (54 loc) · 3.39 KB

README.md

File metadata and controls

80 lines (54 loc) · 3.39 KB

Quick Facts

Features

Install

Our public Git repository is hosted on GitHub and can be viewed at

https://github.com/oscurrency/oscurrency

You can clone the the repository with the command:

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

Edit config/config.yml and run heroku_install:

$ script/heroku_install

Admin user

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

You should update the email address and password.

Administration and Configuration

After install, log in with the default admin@example.com account (password is admin) and click on the "Admin View" link in the upper right. This will take you to the Site administration page (rails_admin). Click on "Preferences" in the left panel and your app name will be listed. Click on the pencil icon to edit preferences.

If you need no more than one group/currency, then uncheck the groups checkbox. The whitelist checkbox determines whether new registrations require manual approval by a system administrator. There are many other options here.

Also listed on the left admin panel are the data types which can be browsed, searched and edited. In addition, there is a "Broadcast emails" link which allows an admin to send an email to those who are active and have allowed these emails in their settings.

In addition to configuration through the web admin interface, outgoing email configuration is done through environment variables including the following.

  • SMTP_SERVER: if this is blank, the heroku install script will use the free sendgrid add-on
  • SMTP_USER
  • SMTP_PASSWORD
  • SMTP_PORT: defaults to 587
  • SMTP_DOMAIN: outgoing emails from the system will have this suffix in the from: field
  • EXCEPTION_NOTIFICATION: a list of email addresses to notify when a code exception occurs

How to get help

How to start for Developers

Setting up development environment on Ubuntu

APIs

FAQs

Screencasts

A Very Important Note about the LICENSE

Insoshi Information

This is a forked repository. Have a look at insoshi for more information on the project this code is derived from.