[Lisppaste-cvs] CVS update: lisppaste2/variable.lisp

[Brian Mastenbrook]

Update of /project/lisppaste/cvsroot/lisppaste2
In directory common-lisp.net:/tmp/cvs-serv16551

Modified Files:
	variable.lisp 
Log Message:
MORE DOCUMENTATION

Date: Thu Jun 17 06:42:32 2004
Author: bmastenbrook

Index: lisppaste2/variable.lisp
diff -u lisppaste2/variable.lisp:1.22 lisppaste2/variable.lisp:1.23
--- lisppaste2/variable.lisp:1.22	Thu Jun 17 06:26:12 2004
+++ lisppaste2/variable.lisp	Thu Jun 17 06:42:32 2004
@@ -1,8 +1,26 @@
-;;;; $Id: variable.lisp,v 1.22 2004/06/17 13:26:12 bmastenbrook Exp $
+;;;; $Id: variable.lisp,v 1.23 2004/06/17 13:42:32 bmastenbrook Exp $
 ;;;; $Source: /project/lisppaste/cvsroot/lisppaste2/variable.lisp,v $
 
 ;;;; See the LICENSE file for licensing information.
 
+;;; This is the main file to edit to customize lisppaste to your
+;;; site. In particular, the main variables are at the top, which
+;;; define how lisppaste knows which site it is running on, and how to
+;;; generate links to itself. There are two ways to run lisppaste:
+;;; naked, and behind a proxying apache. When running naked, you can
+;;; leave much of this file as-is, and change *internal-http-port* and
+;;; *external-http-port* to the port you want it to run on, and
+;;; *paste-site-name* to the hostname it is running on.
+
+;;; When running behind a proxy, set *internal-http-port* to the port
+;;; it will listen for requests from Apache, but set
+;;; *external-http-port* to 80. Set *paste-site-name* to a hostname
+;;; that lisppaste is running on, and comment out the line in
+;;; *paste-external-url* as indicated.
+
+;;; There are a few other options below, but the defaults should work
+;;; well.
+
 (in-package :lisppaste)
 
 (defparameter *internal-http-port* 8000
@@ -23,25 +41,32 @@
   (araneida:merge-url
    (araneida:make-url :scheme "http"
                       :host *paste-site-name*
+                      ;;; comment out this next line when running
+                      ;;; behind a proxying apache
 		      :port *external-http-port*
                       ) "/paste/"))
 
-(defvar *meme-links* nil) ; whether to link to meme IRC logs
+(defvar *meme-links* nil) ; whether to link to meme IRC logs, probably
+			  ; only useful for freenode's lisppaste
 
-(defvar *paste-maximum-size* 51200)
+(defvar *paste-maximum-size* 51200) ; in bytes
 
-(defvar *pastes-per-page* 50)
+(defvar *pastes-per-page* 50) ; for the paste list
 
 (defparameter *banned-ips*
-  '("69.11.238.252" "168.143.113.138"))
+  '("69.11.238.252" "168.143.113.138")) ; two examples of
+					; troublemakers affecting
+					; freenode's lisppaste
 
 (defparameter *ban-log-file*
-  "ban-log")
+  "ban-log") ; where logs of attempts by banned users to paste go
 
 (defparameter *event-log-file*
-  "event-log")
+  "event-log") ; where normal events are logged
 
-(defparameter *no-channel-pastes* nil)
+(defparameter *no-channel-pastes* nil) ; whether to allow pastes that
+				       ; don't get announced on a
+				       ; channel
 
 ;; You shouldn't need to edit below this line.
 ;; LINE