Changeset - b02339418086
[Not reviewed]
default
0 2 0
Nathan Brink (binki) - 15 years ago 2011-01-22 02:59:47
ohnobinki@ohnopublishing.net
Add information about using securimage-2.0.2 (which has my patch) with slate_permutate.
2 files changed with 7 insertions and 1 deletions:
0 comments (0 inline, 0 general)
README
Show inline comments
 
slate_permutate: the semester scheduling assistant.
 

	
 
Authors:
 
  See AUTHORS
 

	
 
Resources:
 
  Support: irc://irc.ohnopub.net/slatepermutate
 
  Mercurial repo: http://protofusion.org/hg/SlatePermutate/
 
  Bugzilla: http://protofusion.org/bugzilla/
 

	
 
  Please use the means listed above to give us any feedback about
 
  slate_permutate's functionality. Thanks!
 

	
 
Installation Requirements:
 
  - PHP-enabled httpd (tested with apache, patches for supporting others welcome).
 
  - Access to PHP's CLI interface
 
  - libcURL extension to PHP (for Calvin's crawler and soon others).
 
  - json_encode()/json_decode() functions (as a PEAR addon or with the recent PHP versions).
 
  - PHP libraries
 
    - securimage-2.0.2 (optional) for captcha support for the feedback
 
      form. http://phpcapatcha.org/ , see inc/config.example for
 
      details.
 

	
 
Installation:
 
  - Get a copy of slate_permutate.
 
    - development version:
 
      $ hg clone http://protofusion.org/hg/SlatePermutate slate_permutate
 
    - stable: not yet available.
 
  - copy inc/config.inc.example to inc/config.inc. Read and adjust
 
    settings as necessary.
 
  - copy .htaccess.example to .htaccess if you're interested in
 
    ``clean urls'' (corresponding to the $clean_urls option in
 
    config.inc).
 
  - run admin/rehash.php to populate the cache/ directory with
 
    information such as the list and rDNS information for schools in
 
    school.d.
 
  - ensure that the webserver has write-access to the saved_schedules/
 
    folder because schedule storage is filesystem-based.
 

	
 
License:
 
  - The Affero General Public License version 3. This, in essence, is
 
    the same as a normal GPL. However, if slate_permutate is use as
 
    part of a publically-accessible web service and alterations have
 
    been made, those alterations must be published and available under
 
    the same license as existing code. However, the above simple
 
    understanding is no replacement for the actual content of the
inc/config.inc.example
Show inline comments
 
@@ -44,49 +44,51 @@
 
 *
 
 * Set this to an array of Google Analytics tracker IDs if you want to
 
 * analyze access to your slate_permutate installation.
 
 */
 
/* $ga_trackers = array(); */
 
/* $ga_trackers = array('UA-XXXXXXXX-X'); */
 

	
 
/**
 
 * \brief
 
 *   List of email addresses to send feedback form submissions to.
 
 *
 
 * Set this to a PHP array of email addresses to which feedback
 
 * submissions should be mailed.
 
 */ 
 
/* $feedback_emails = array('ethanzonca@gmail.com, ngelderloos7@gmail.com, ohnobinki@ohnopublishing.net'); */
 
/* $feedback_emails = array('user@example.org'); */
 

	
 
/**
 
 * \brief
 
 *   Whether or not to use SecureImage phpcaptcha.
 
 *
 
 * Set to TRUE to use SecureImage captcha, FALSE to not use
 
 * it. Requires PHP library available from http://phpcaptcha.org/
 
 * which may be placed in slate_permutate's lib/ directory or into the
 
 * system PHP include path.
 
 * system PHP include path. If you are using the lib/ directory,
 
 * ensure that securimage is accessible at
 
 * lib/securimage/securimage.php .
 
 */
 
/* $use_captcha = FALSE; */
 

	
 
/**
 
 * \brief
 
 *   Password to be used for administration page (admin.php)
 
 *
 
 */
 
/* $admin_pass = ''; */
 

	
 
/**
 
 * \brief
 
 *   Setting this variable true enables the administration page
 
 *
 
 */
 
/* $admin_enable = FALSE; */
 

	
 
/**
 
 * \brief
 
 *   Enable purging saved schedules through the admin/rehash.php
 
 *   script or web interface.
 
 *
 
 * Set to TRUE to enable this functionality. It is disabled by default
 
 * because it causes irreparable information loss.
0 comments (0 inline, 0 general)