Mercurial > p > roundup > code
diff doc/getting_started.txt @ 1010:768bc93f7d1b maint-0.4
backported fix to CGI form handling from 0.5
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Mon, 02 Sep 2002 21:49:04 +0000 |
| parents | b38f4f95bffd |
| children |
line wrap: on
line diff
--- a/doc/getting_started.txt Tue Aug 27 22:01:34 2002 +0000 +++ b/doc/getting_started.txt Mon Sep 02 21:49:04 2002 +0000 @@ -2,7 +2,7 @@ Getting Started =============== -:Version: $Revision: 1.3 $ +:Version: $Revision: 1.3.2.1 $ .. contents:: @@ -45,26 +45,18 @@ Command Line Tool ----------------- -To initiliase a new instance, run "``roundup-admin init``". You will be asked a -series of questions: +To set up a new instance, run "``roundup-admin install``". You will be +asked a few questions: 1. Instance home directory 2. Schema to use 3. Database back-end to use -4. Administration user "admin" password. -You should also think about whether there is going to be controlled access -to the -instance on the machine the instance is running on. That is, who can -actually make -changes to the database using the roundup-admin tool. See the section on -Users_and_Access_Control for information on how to secure your instance from the -start. - -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: +Once you've chosen these, roundup will install the instance for you. It will +then indicate that you should configure some more information in the +file "``instance_config.py``" in the instance home. It +should be edited before roundup is initialised, and may have the following +variable declarations: MAILHOST The SMTP mail host that roundup will use to send mail @@ -81,6 +73,20 @@ ADMIN_EMAIL: ``roundup-admin@MAIL_DOMAIN`` roundup's internal use (problems, etc) +You may also alter the default schema - see the `customisation`_ documentation +for more info on both configuration variables and schema modifications. + +Once you're happy (and note that you can change any of this after the instance +is initialised too!) you must run "``roundup-admin initialise``". + +You should also think about whether there is going to be controlled access +to the +instance on the machine the instance is running on. That is, who can +actually make +changes to the database using the roundup-admin tool. See the section on +Users_and_Access_Control for information on how to secure your instance from the +start. + E-Mail Interface ---------------- @@ -160,7 +166,7 @@ SetEnv ROUNDUP_LOG "/var/log/roundup.log" SetEnv ROUNDUP_INSTANCE_HOMES "Default=/usr/local/share/roundup/instances/Default" SetEnv ROUNDUP_DEBUG "0" - + 7. On Windows, write a batch file "roundup.bat" similar to the one below and place it into your cgi-bin directory:: @@ -269,4 +275,5 @@ .. _`table of contents`: index.html .. _`user guide`: user_guide.html +.. _`customisation`: customizing.html
