Squid Users Manager - Installation

Requirements

Ruby: http://www.ruby-lang.org/en/
Optionals (Rails includes its own http server Webrick):
- Apache 1.3.x or 2.x or lighttpd 1.3.11+ (or any FastCGI-capable webserver with a mod_rewrite-like module)
- FastCGI (or mod_ruby) for better performance on Apache

Installation

The following instructions assume you've got shell access to the computer you want Squid Users Management installed on.

Unpack the sources, if this didn't already happen.

$ tar -xvzf squsermanager-*.tar.gz

This creates a 'SquidUsersManager' directory, which is further named the installation directory.

CD to directory created.

$ cd SquidUsersManager

Edit the file config/environment.rb and set HTPASSWD with the htpasswd in your system. The file should be writable by web server process.

Change the variable ADMINPASS to your choice password.

Run the WEBrick servlet:

$ ruby script/server -d --environment=production

Go to http://localhost:3000/ and get the login view

Examples for Apache or lighttpd configuration

Examples of Apache or lighttpd configuration can be found on the Rails web site in case you would like to run Squid Users management on top of them instead of Webrick.

Description of contents

  	app/
  	  Holds all the code that's specific to this 
  	  particular application.
  	  
  	app/controllers/
  	  Holds Squid Users management controllers.
  	  
  	app/models/
  	  Holds Squid Users management models.
  	  
  	app/views/
  	  Holds the template files for the views.
  	  
  	app/helpers/
  	  Holds view helpers.
  	  
  	config/
  	  Configuration files for the Rails environment, 
  	  the routing map, the database, and other 
  	  dependencies.
  	  
  	components/	
  	  Self-contained mini-applications that can bundle
  	  controllers, models,   and views together.
  	  
  	doc/
  	  Holds Squid Users management documentation in plain 
  	  text and html.
  	  
  	lib/
  	  Application specific libraries.
  	  
  	public/
  	  The directory available for the web server.
  	  Contains sub-directories for images, stylesheets,
  	  and javascripts. Also contains the dispatchers and
  	  the default HTML files.
  	  
  	script/
  	  Helper scripts for automation and generation.
  	  
  	test/
  	  Unit and functional tests along with fixtures.
  	  
  	vendor/
  	  External libraries that the application depend on.
  	  This directory is in the load path.