From 61242e494503a2f8a113aa8a08211d43fe4b9a25 Mon Sep 17 00:00:00 2001 From: richard Date: Fri, 5 Oct 2001 02:44:06 +0000 Subject: [PATCH] Some more documentation. git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/trunk@273 57a73879-2fb5-44c3-a270-3262357dd7e2 --- doc/index.html | 53 ++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 43 insertions(+), 10 deletions(-) diff --git a/doc/index.html b/doc/index.html index 8da76f8..53788e0 100644 --- a/doc/index.html +++ b/doc/index.html @@ -21,20 +21,20 @@
  • Command Line Tool
  • E-Mail Interface
  • Web Interface -
  • Users +
  • Users (Users and permissions, Adding users)
  • Issues
  • User Guide
  • Customising Roundup
  • Roundup's Design Document ("Implementation Guide")
  • Acknowledgements @@ -215,6 +215,39 @@ RewriteRule ^/roundup/roundup.cgi(.*) /home/httpd/html/roundup/roundup.cgi$1 [e=

    Users

    + +

    Users and permissions

    +By default, roundup automatically creates one user when the instance +database is initialised (using roundup-admin init). The user is "admin" and +the password is the one you supply at that time. +

    +If users attempt to use roundup in any manner and are not identified to +roundup, they will be using the database in a read-only mode. That is, if +roundup doesn't know who they are, they can't change anything. This has the +following repurcussions: +

    +
    Command-line interface +
    The data modification commands (create, init, retire, set) are not +available without a login, and if one is not supplied on the command line +(-u user:pass) then it will be prompted for. +
    E-Mail interface +
    Users are identified by e-mail address - a new user entry will be +created for any e-mail address that is not recognised, so users are +always identified by roundup. +
    Web interface +
    Unidentified users have read-only access. If the users database has an +entry with the username "anonymous", then unidentified users are +automatically logged in as that user. This gives them write access. +
    +

    +There has been only a half-hearted attempt to restrict certain activities +to the "admin" user. For example, the "extended" schema web interface enables +some fnuctionality for the "admin" user. On the fil-side, it is possible to +obtain the admin user's password using the read-only access on the command +line (it would also be possible to access the database files directly to +obtain this information). + +

    Adding users

    To add users, use one of the following interfaces:
      @@ -415,14 +448,14 @@ Incoming messages are examined for multiple parts: subpart and ignore the other parts. -

      Summary

      +

      Message content summary

      The "summary" property on message nodes is taken from the first non-quoting section in the message body. The message body is divided into sections by blank lines. Sections where the second and all subsequent lines begin with a ">" or "|" character are considered "quoting sections". The first line of the first non-quoting section becomes the summary of the message. -

      Addresses

      +

      Address handling

      All of the addresses in the To: and Cc: headers of the incoming message are looked up among the user nodes, and the corresponding users are placed in the "recipients" property on the new "msg" node. The address in the From: @@ -434,7 +467,7 @@ passwords.) If we prefer to reject mail from outside sources, we can simply register an auditor on the "user" class that prevents the creation of user nodes with no passwords. -

      Actions

      +

      Performing Actions

      The subject line of the incoming message is examined to determine whether the message is an attempt to create a new item or to discuss an existing item. A designator enclosed in square brackets is sought as the first thing @@ -640,7 +673,7 @@ the item was last edited (equivalently, these are the dates on the first and last records in the item's journal). The "creator" property holds a link to the user that created the issue. -

      setkey(property)

      +

      setkey(property)

      Select a String property of the class to be the key property. The key property muse be unique, and allows references to the items in the class by the content of the key property. That is, we can refer to users by their @@ -657,7 +690,7 @@ or

      Note, the same thing can be done in the web and e-mail interfaces. -

      create(information)

      +

      create(information)

      Create an item in the database. This is generally used to create items in the "definitional" classes like "priority" and "status". @@ -1038,7 +1071,7 @@ system on their time.

       

      -$Id: index.html,v 1.7 2001-10-01 06:30:23 richard Exp $ +$Id: index.html,v 1.8 2001-10-05 02:44:06 richard Exp $

       

      -- 2.30.2