root/trunk/INSTALL

Revision 344, 2.4 kB (checked in by obaltzer, 3 years ago)

Getting rid of the odd looking embedded add forms for groups and categories
on the event posting page by modifying them to be sliding forms that open
on demand.

Line 
1 TigerEvents
2
3 If you encounter any problems please submit a bug report on our website
4 http://www.tigeronrails.com/, send us an email to acm+dev@cs.dal.ca or join
5 the developers in IRC channel #tigers on the Freenode network
6 (irc.freenode.net).
7
8 Dependencies:
9
10   - Ruby >= 1.8
11
12   - Rails >= 0.14.1
13
14   - ruby/ldap
15    
16     Ruby/LDAP must be installed in order to use LDAP user authentication.
17     You can obtain the latest Ruby/LDAP distribution from
18     http://ruby-ldap.sourceforge.net/.
19
20 Setup:
21
22   - Create a database and associate a user with it for usage by
23     tigerevents.
24
25   - Run the setup script from the root directory of the distribution using
26     the following command:
27
28     ruby setup.rb
29
30     The script will ask you a variety of questions to setup your
31     TigerEvents environment
32
33   - Run the Webrick webserver by calling:
34
35     ruby script/server
36
37   - Log in with the admin account and create your priorities, selectors, and
38     group classes (there are some defaults available) through the online
39     administration interface.
40
41   - For a production site setup please refer to the Rails documentation in
42     README.Rails
43
44 System Settings:
45
46   - LDAP SSL Connection
47  
48     For those of you that elect to use the LDAP user authentication, we use
49     a SSL connection for additional security. Here are the following
50     settings that you must follow in order to setup an SSL LDAP connection:
51    
52       1. Download the server certificate for your LDAP server and save it
53          somewhere in the filesystem (e.g. your home directory
54          /home/username/.certs/ldap.pem).
55
56       2. Create a file '.ldaprc' in your home directory or a file 'ldaprc'
57          in the directory from which the application is executed, with the
58          following content:
59
60                 TLS_CACERT /path/to/ldap.pem
61
62       3. You can ensure that everything is working by running:
63
64          ldapsearch -ZZ -h ldap.server -x -b 'dc=search,dc=domain' \
65                          '(uid=username)' dn
66
67          If you do not get an error, then the SSL connection is working.
68
69     For details see: http://www.openldap.org/pub/ksoper/OpenLDAP_TLS_howto.html
70
71   - Rails Environment Setting
72  
73     Before you can start using TigerEvents, you have to update the
74     following constants in config/tigerevents_config.rb.
75    
76         #LDAP settings
77    
78         # the LDAP server to connect to
79         LDAP_URL = 'ldap.somewhere.com'
80        
81         # the LDAP port (use 389 for TLS and 636 for SSL)
82         LDAP_PORT = 389
83        
84         # the search base for LDAP queries
85         LDAP_DN = 'dc=dal,dc=ca'
Note: See TracBrowser for help on using the browser.