Skip to content

Authentication Module Technical Documentation

Benjamin Heet edited this page Jun 25, 2013 · 18 revisions

Supported Browsers

  • Current and recent Firefox, IE, Safari, Seamonkey, Opera an Chrome versions all supported
  • Requires browser to have Javascript enabled. The CORAL interface relies heavily on AJAX, JQuery and JQuery plugins

Note: The majority of technical details are the same as in the CORAL Technical Documentation. Differences are noted here.

Server-Side Requirements and Setup

Database

The recommended name for the auth database is coral_auth_prod. If you have created a “coral” user for your other modules, it should have select, insert, update and delete privileges to the coral_auth_prod. If you are using different users for your other CORAL installs, you will need to make sure that all of your other users have select access to the new authentication database.

For the authentication data model and the MySQL Workbench file, refer to http://erm.library.nd.edu/documentation.html

Installation

Installation can occur in one of two ways – either through the web installation script or manually. Web installation will provide advantages over manual because will check MySQL privileges and PHP version. Installation is recommended in the /coral/auth/ directory. It is also recommended that you check out the CORAL Main Landing page and place it into the /coral/ directory. This contains an HTML file and graphics for each module, similar to the landing page on the CORAL demo website.

Web Installation

Visit http://.../coral/auth/install/ and follow instructions on the screen

Be sure to remove the /install/ directory once installation is complete

Manual Installation

Install database tables

  1. Create new database schema (recommended name is coral_auth_prod)
  2. Open SQL file in /coral/auth/install/create_tables_data.sql and replace DATABASE_NAME with your new database schema name
  3. Run SQL file

Update /admin/configuration.ini

Important: First rename /admin/configuration_sample.ini to /admin/configuration.ini

  1. Under [settings] a. timeout= , length of time (in seconds) the user remains logged in
  2. Under [database] a. type=mysql , currently only MySQL is supported but other database types could be supported if modifications to the generic database classes are made b. host= , MySQL server - could be localhost as well c. name= , database name (for example, coral_resources_prod) d. username= , recommended to have a single user with select, update, insert, delete access to all coral modules e. password= , password for above mentioned user
  3. Be sure to add .htaccess file and remove the /install/ directory once complete for security reasons
  4. When installing multiple modules for interoperability you may see errors from either module until all modules are installed

Setting up and using Authentication module for the first time

After installation a single default user will be set up with the username coral and password admin. In your browser, visit the page /coral/auth/admin.php to add your username/password and set yourself (or anyone else) as ‘admin’. The ‘admin’ users will be able to add, edit and delete users in Authentication. Once you have another ‘admin’ user set up you can delete the original coral/admin user.

Important: Your usernames should always match the usernames in other CORAL modules for proper privileges. Note that after the CORAL Authentication install the only user set up is ‘coral’. Be sure to add all other users from other modules on the CORAL Authentication Admin page – link is at the bottom of the login page.

Page Under Construction

Clone this wiki locally