There is no formal installation procedure for aLogin2. Simply download the zip file, unpack it, and put aLogin2 into your web server's space. Where in the space is lives in unimportant, but we recommend at the top level where it can be easily shared by a variety of applications. In all of our examples, we're going to assume that this is where the code is loaded.
Making aLogin2 available for use by an application involves running the provided setup script. This creates a configuration file that the application can use and copies certain files into the applications folder on the server. In order to run the script you will need to have the following information available:
|Path to the application||This is the path to the location of the application that is going to use aLogin2.|
|The name of the application3||Whatever you want to name your application.|
|Path to the configuration file||This file will be build automatically during the set up process. The path should include the file name. Since the configuration file will be a php file, the file name should end in ".php". For security the path should not be located within the web servers data tree but it must be located somewhere that the server can write to.|
|Administrator Username||Username of an account within aLogin that will have administrative privileges. Note that even if you intend to combine aLogin with another authentication system, you'll need this account.|
|Administrator Password||The password for the administrator account. We strongly recommend against reusing the password from another system even if reusing a username.|
|Administrator Email||If the system is going to allow users to request new accounts, it will need this address so it can notify the administrator when new requests come it.|
|Path to the data library2||This is the path to a file that contains functions for accessing the database. See the page on using the database for details. Two possible libraries are supplied with aLogin, mysql_datalib.php and sqlite_datalib.php. Both are located in the top directory of aLogin. (./mysql_datallib.php or ./sqlite_datalib.php). See the page Localization->Databases on creating new database libraries.|
|Path to the utility library2||This is the path to a file containing some utility functions. You should use the one supplied, pdclib.php. It's also located at the top level of aLogin (./pdcllib.php).|
|URL to the Extjs library||This must be an absolute URL such as /extjs-3.0.3. URLs don't require the http:// notation.|
|URL to the Xajax llibrary||This must be an absolute URL such as /xajax_0.5. URLs don't require the http:// notation.|
|Database Server1 ||The name of the database server you'll use.|
|Database User1 ||The name of the database user account which has write access to the database.|
|Database Password1||The password for the database user account.|
|Database Name1||The name of the database that you're going to use of the database. The user you entered must have write access to this database.|
|Table Prefix||Some text that will be appended to database tables such as "myApp_". By changing the prefix you can have multiple copies of aLogin use the same database. Limited to 10 characters.|
|Default Level||The authority level given to new users by default. Users can request a higher level, but it wouldn't take effect until it's approved by the administrator.|
|Recaptcha Private Key||aLogin2 uses the recaptcha system to prevent robotic account creation. Go to http://recaptcha.net for information on getting these keys.|
|Recaptcha Public Key||aLogin2 uses the recaptcha system to prevent robotic account creation. Go to http://recaptcha.net for information on getting these keys.|
|New Account Notification Message3||Optional: This is the email message send to a user when the administrator creates an account for them using the administrative functions. If this field is blank the message is "An account have been created for you in application name."|
1 Depending on how you are handling the database, these fields may or may not be needed. They will definitely be needed if using mySQL.
2 If you are using aBlog, aMapApp or anything else that uses the same database and utility libraries, they should all use the same copy. For example, you could point these fields to the copies of mysql_datalib.php and pdclib.php that live in the aBlog directory.
3 Single and double quotes in text strings need to be double escaped. For instance, an application name of Paul's site would need to entered as Paul\\\'s site. These strings are processed twice. The first pass would result in Paul\'s Site and the final path would give Paul's Site.
Paths can be given either in absolute terms or relative to the aLogin2 main directory. Paths are not URLs. For instance, if your web servers data tree starts at /var/www/html and your application lives in the directory myApp at the top level of of the server, and the aLogin2 library lives in the directory aLogin2 also at the top level, the path to the application could be give as either /var/www/html/myApp or ../myApp. The URL /myAppwouldn't work.