From: richard Date: Mon, 1 Oct 2001 06:30:23 +0000 (+0000) Subject: More documentation and a new TODO item. X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=f72ddc901fafbcfe1c65129cd15514a57e32dc81;p=roundup.git More documentation and a new TODO item. git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/trunk@268 57a73879-2fb5-44c3-a270-3262357dd7e2 --- diff --git a/README.txt b/README.txt index 0c89029..eae2bf5 100644 --- a/README.txt +++ b/README.txt @@ -93,6 +93,7 @@ roundupdb: . split the file storage into multiple dirs? roundup-mailgw: . errors as attachments + . limits on the e-mail addresses that may use the mail gateway roundup-server: . check the source file timestamps before reloading cgi_client diff --git a/doc/index.html b/doc/index.html index 46dd8c0..8da76f8 100644 --- a/doc/index.html +++ b/doc/index.html @@ -32,6 +32,7 @@
  • Customising Roundup @@ -125,25 +126,26 @@ asked a series of questions:
  • Administration user "admin" password. -Roundup is configurable using a localconfig.py file in the instance home. -It may have the following variable declarations: +Roundup is configurable using an instance_config.py file in the instance home. +It should be edited before roundup is used, and may have the following +variable declarations:
    1. MAILHOST
      The SMTP mail host that roundup will use to send mail
    2. MAIL_DOMAIN
      The domain name used for email addresses +
    3. ISSUE_TRACKER_WEB +
      The web address of the issue tracker's web interface
    -Any further configuration should be possible by editing the instance home's -__init__.py directly.

    The email addresses used by the system by default are:

      -
    1. issue_tracker@MAIL_DOMAIN +
    2. ISSUE_TRACKER_EMAIL - issue_tracker@MAIL_DOMAIN
      submissions of issues -
    3. roundup-admin@MAIL_DOMAIN +
    4. ADMIN_EMAIL - roundup-admin@MAIL_DOMAIN
      roundup's internal use (problems, etc)
    @@ -268,18 +270,18 @@ Usage: - - - - - - - - - - - -
    Command Help
    historyhistory designator
    +     		history designator

    Lists the journal entries for the node identified by the designator.

    findfind classname propname=value ...
    +     		find classname propname=value ...

    Find the nodes of the given class with a given property value. The value may be either the nodeid of the linked node, or its key value.

    listlist classname [property]
    +     		list classname [property]

    Lists all instances of the given class along. If the property is not specified, the "label" property is used. The label property is tried in order: the key, "name", "title" and then the first property, @@ -287,42 +289,42 @@ Usage:

    retireretire designator[,designator]*
    +     		retire designator[,designator]*

    This action indicates that a particular node is not to be retrieved by the list or find commands, and its key value may be re-used.

    createcreate classname property=value ...
    +     		create classname property=value ...

    This creates a new entry of the given class using the property name=value arguments provided on the command line after the "create" command.

    getget property designator[,designator]*
    +     		get property designator[,designator]*

    Retrieves the property value of the nodes specified by the designators.

    specspec classname
    +     		spec classname

    This lists the properties for a given class.

    setset designator[,designator]* propname=value ...
    +     		set designator[,designator]* propname=value ...

    Sets the property to the value for all designators given.

    initinit [template [backend [admin password]]]
    +     		init [template [backend [admin password]]]

    The command will prompt for the instance home directory (if not supplied through INSTANCE_HOME or the -i option. The template, backend and admin password may be specified on the command-line as arguments, in that order.

    freshenfreshen
    +     		freshen

    **DO NOT USE**

    This currently kills databases!!!! @@ -334,12 +336,12 @@ Usage:

    helphelp [command]
    +     		help [command]

    Short help about roundup-admin or the specific command.

    morehelpmorehelp
    +     		morehelp

    All available help from the roundup-admin tool.

    @@ -459,12 +461,12 @@ explanatory message given in the exception. Instances have the following structure: - - - + + + - + @@ -474,9 +476,58 @@ Instances have the following structure: - +
    dbinit.pyHolds the instance schema
    instance_config.pyHolds the basic instance configuration
    Holds the basic instance configuration
    dbinit.pyHolds the instance schema
    interfaces.pyDefines the Web and E-Mail interfaces for the instance
    Defines the Web and E-Mail interfaces for the instance
    select_db.py Selects the database back-end for the instance
    db/
    detectors/ Auditors and reactors for this instance
    html/Web interface templates, images and style sheets
    Web interface templates, images and style sheets
    +

    Instance Configuration

    +The instance_config.py located in your instance home contains the +basic configuration for the web and e-mail components of roundup's +interfaces. This file is a Python module. The default +instance_config.py is given below - as you can see, the +MAIL_DOMAIN must be edited before any interaction with the instance is +attempted. + +

    +

    +MAIL_DOMAIN=MAILHOST=HTTP_HOST=None
+HTTP_PORT=0
+
+# roundup home is this package's directory
+INSTANCE_HOME=os.path.split(__file__)[0]
+
+# The SMTP mail host that roundup will use to send mail
+if not MAILHOST:
+    MAILHOST = 'localhost'
+
+# The domain name used for email addresses.
+if not MAIL_DOMAIN:
+    MAIL_DOMAIN = 'fill.me.in.'
+
+# the next two are only used for the standalone HTTP server.
+if not HTTP_HOST:
+    HTTP_HOST = ''
+if not HTTP_PORT:
+    HTTP_PORT = 9080
+
+# This is the directory that the database is going to be stored in
+DATABASE = os.path.join(INSTANCE_HOME, 'db')
+
+# This is the directory that the HTML templates reside in
+TEMPLATES = os.path.join(INSTANCE_HOME, 'html')
+
+# The email address that mail to roundup should go to
+ISSUE_TRACKER_EMAIL = 'issue_tracker@%s'%MAIL_DOMAIN
+
+# The web address that the instance is viewable at
+ISSUE_TRACKER_WEB = 'http://some.useful.url/'
+
+# The email address that roundup will complain to if it runs into trouble
+ADMIN_EMAIL = 'roundup-admin@%s'%MAIL_DOMAIN
+
+# Somewhere for roundup to log stuff internally sent to stdout or stderr
+LOG = os.path.join(INSTANCE_HOME, 'roundup.log')
+
    +

    Instance Schema

    An instance schema defines what data is stored in the instance's database. The two schemas shipped with Roundup turn it into a typical software bug @@ -987,7 +1038,7 @@ system on their time.

     

    -$Id: index.html,v 1.6 2001-10-01 04:58:33 richard Exp $ +$Id: index.html,v 1.7 2001-10-01 06:30:23 richard Exp $