Download Aqualung

From OSA

Jump to: navigation, search

Aqualung is the name of the web framework OSA is built on. The mundane stuff (logins, database connections, logging, session management, etc) are all handled by Aqualung.

Why Aqualung? Because I'm a long time Cousteau fan and a once upon a time SCUBA diving fanatic. Thanks to efforts of Jacques-Yves, development of the aqualung freed the aquatic diver to explore the underwater world without restrictive ties to the surface for air. Likewise the Aqualung web framework frees the Perl coder to explore the web app world without restrictive ties to the system infrastructure needed to make it work. Poetic or corny, I leave that to the reader ;)

The sample web app is a simple example demonstrating the use of templates and macros, and serves as 'living' documentation for Aqualung. It's a self installing perl script that checks for required packages, locates the webserver user/group information, confirms CGI/Document directories, then extracts both the Aqualung base and the web app into the appropriate locations, creating paths and setting mode/permissions in the process. This is a gentle introduction the code base and a painless way to get started.

The Aqualung sample is also a testing vehicle for the packaging tool built into the framework and the installer script that gets automatically generated. As such it will see continual updates to the install process that may not necessarily have much to do with Aqualung or the sample web app.

Download: Latest Aqualung Sample March 6, 2013

Source: Latest Aqualung Source March 6, 2013

How To Install

  1. Download the Aqualung sample and run the script.
    • Run the script in a terminal (from the command line).
    • It will create/populate cgi, html and data directories, generate a config file and create/setup any database requirements.
    • The script must be run as the root user:
    perl -T pathToScript/
    • On systems that require sudo type:
    sudo perl -T pathToScript/
  2. Verify the web app config file.
    • Snoop around the cgi directory and find the web app config directory, something like '/var/www/cgi-bin/aqualung/main/etc'.
    • On the Mac the config files will likely be in '/Library/WebServer/CGI-Executables/aqualung/main/etc'.
    • On the OpenSUSE the config files will likely be in '/srv/www/cgi-bin/aqualung/main/etc'.
    • Verify/change the directory paths in the config.txt file if required.
    • You'll also find a config.default.txt file in the same location that contains all the configuration options in more detail (don't edit config.default.txt!).
  3. Initialise the web app.
    • Find the script (something like /var/www/cgi-bin/aqualung/
    • Initialize the application by running the script with the '--init' option.
      • type the command:
      /var/www/cgi-bin/aqualung/ --init
      • On systems that require sudo type:
      sudo perl -T /var/www/cgi-bin/aqualung/ --init
    • If the config.txt file is correct and no errors occured, the default MySQL tables and a default 'superuser' user will be created for the web app.
    someday the install script will take care of this for you
  4. Verify the Apache web server setup
    • A a sample Apache config file 'apache.conf' is generated in the web app config directory by the init step.
    • If you've got the same Apache set up I do (CentOS), this file can be copied to the /etc/httpd/conf.d. You may have to customize it.
  5. Run the web app from a browser.
  6. Sit back and relax. You're done!
Personal tools