ORC helps participants to simplify interaction with organizers of various competitions, events, tournaments, seminars, conferences, etc.

The system has a web interface and provides the ability to generate different kinds of registration forms, allows to organize an individual or a group registration of participants in events of any type.

Go v1.5.1 or higher.

PostgreSQL v9.3 or higher.

• Install git.
• Configure your GOROOT and GOPATH environment variables.
• Install godep:

    $ go get git@github.com:tools/godep.git

• Get a copy of the repository:

    $ godep get git@github.com:klenin/orc.git

• Configure Your environment as described in following sections.

• Run:

    $ $GOPATH/bin/orc

There is also run.sh file, providing some ease of local test running e.g. database creation and filling it with local test data.

Test user credentials to login the system (number in [1-20]):

Login: user<number>
Password: password

Administrator credentials to login the system:

Login: admin
Password: password

• package pq (godoc)
• package securecookie (godoc)

All external dependenies are vendored with project's source code. Consequently, there is no need to install them separately.

Create a database orc:

    CREATE DATABASE orc;

Create a user account called admin and grant permission for database called orc:

    CREATE USER admin WITH PASSWORD 'admin';
    GRANT ALL PRIVILEGES ON DATABASE orc to admin;

Configuration is a set of key-value string pairs, which should be specified in some of following ways

1. Preparing the configuration file, which is ~/.orcrc, where ~ means home path, by default
   • Configuration file should consist of nonempty lines in format <key>=<value>.
   • File path could be overriden by ORC_CONFIG_PATH environment variable.
2. Setting up configuration environment variables. The name of variable is prefixed with ORC_ string.

Configuration could be set up simultaneously throught both ways. In this case, environment variables have higher priority.

In order to send emails with team invitations, login confirmations etc., You need to configure Admin credentials. In this context, admin is the person who represents project's service.

Set following config keys: ADMIN_NAME -- admin's name EMAIL -- the email to send messages from EMAIL_PASSWORD -- mailbox password SMTP_SERVER -- mailing servise SMTP address SMTP_PORT -- mailing service SMTP port SERVER_URI -- server URI to use with mailing templates

In order to connect to posgres database, DATABASE_URL config key should be set; Set the port (5000 by default) through PORT config key:

###example:

$ export \
    ORC_ADMIN_NAME="Admin Name" \
    ORC_EMAIL="example@gmail.com" \
    ORC_SMTP_SERVER="smtp.gmail.com" \
    ORC_SMTP_PORT="587" \
    ORC_EMAIL_PASSWORD="password" \
    ORC_SERVER_URI="https://server/link/" \
    ORC_DATABASE_URL="user=admin host=localhost dbname=orc password=password sslmode=disable" \
    ORC_CONFIG_PATH="./server_config"
$ echo -e "PORT=6543\nEMAIL_PASSWORD="qwerty" > ./server_config

In this example two config keys are set throught server_config file of cwd, but the value of EMAIL_PASSWORD key would be loaded from ORC_EMAIL_PASSWORD env var, as it has higher priority.

• install heroku and follow it's documentation guidelines
• configure heroku environment variables before running!

Redirection requests from localhost:8080 to localhost:6543.

Install modules mod_proxy and mod_proxy_http. Uncomment lines in httpd.conf:

    # httpd.conf
    LoadModule proxy_module modules/mod_proxy.so
    LoadModule proxy_http_module modules/mod_proxy_http.so

Add to httpd-vhosts.conf:

    # httpd-vhosts.conf

    <VirtualHost localhost:6543>
        DocumentRoot "path/to/orc"
        ServerName localhost:6543

        # Other directives here

    </VirtualHost>

    <VirtualHost *:80>
        DocumentRoot "path/to/localhost"
        ServerName localhost

        ProxyPass /js http://localhost:6543/js
        ProxyPass /css http://localhost:6543/css
        ProxyPass /img http://localhost:6543/img

        ProxyPass /examplecontroller/controlleraction/args http://localhost:6543/examplecontroller/controlleraction/args

        # Other directives here

        ProxyPassReverse /same/path/ http://localhost:6543

    </VirtualHost>