Mercurial > p > roundup > code
comparison doc/getting_started.txt @ 979:f36ffa50374f
Fixes to doc
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Tue, 27 Aug 2002 21:55:35 +0000 |
| parents | b38f4f95bffd |
| children | 79129f013153 |
comparison
equal
deleted
inserted
replaced
| 978:4f57a8f51da4 | 979:f36ffa50374f |
|---|---|
| 1 =============== | 1 =============== |
| 2 Getting Started | 2 Getting Started |
| 3 =============== | 3 =============== |
| 4 | 4 |
| 5 :Version: $Revision: 1.3 $ | 5 :Version: $Revision: 1.4 $ |
| 6 | 6 |
| 7 .. contents:: | 7 .. contents:: |
| 8 | 8 |
| 9 | 9 |
| 10 The following instructions assume that you have installed roundup. If you | 10 The following instructions assume that you have installed roundup. If you |
| 43 Instances are created using the ``roundup-admin`` tool. | 43 Instances are created using the ``roundup-admin`` tool. |
| 44 | 44 |
| 45 Command Line Tool | 45 Command Line Tool |
| 46 ----------------- | 46 ----------------- |
| 47 | 47 |
| 48 To initiliase a new instance, run "``roundup-admin init``". You will be asked a | 48 To set up a new instance, run "``roundup-admin install``". You will be |
| 49 series of questions: | 49 asked a few questions: |
| 50 | 50 |
| 51 1. Instance home directory | 51 1. Instance home directory |
| 52 2. Schema to use | 52 2. Schema to use |
| 53 3. Database back-end to use | 53 3. Database back-end to use |
| 54 4. Administration user "admin" password. | 54 |
| 55 Once you've chosen these, roundup will install the instance for you. It will | |
| 56 then indicate that you should configure some more information in the | |
| 57 file "``instance_config.py``" in the instance home. It | |
| 58 should be edited before roundup is initialised, and may have the following | |
| 59 variable declarations: | |
| 60 | |
| 61 MAILHOST | |
| 62 The SMTP mail host that roundup will use to send mail | |
| 63 MAIL_DOMAIN | |
| 64 The domain name used for email addresses | |
| 65 ISSUE_TRACKER_WEB | |
| 66 The web address of the issue tracker's web interface | |
| 67 | |
| 68 The email addresses used by the system by default are: | |
| 69 | |
| 70 ISSUE_TRACKER_EMAIL: ``issue_tracker@MAIL_DOMAIN`` | |
| 71 submissions of issues | |
| 72 | |
| 73 ADMIN_EMAIL: ``roundup-admin@MAIL_DOMAIN`` | |
| 74 roundup's internal use (problems, etc) | |
| 75 | |
| 76 You may also alter the default schema - see the `customisation`_ documentation | |
| 77 for more info on both configuration variables and schema modifications. | |
| 78 | |
| 79 Once you're happy (and note that you can change any of this after the instance | |
| 80 is initialised too!) you must run "``roundup-admin initialise``". | |
| 55 | 81 |
| 56 You should also think about whether there is going to be controlled access | 82 You should also think about whether there is going to be controlled access |
| 57 to the | 83 to the |
| 58 instance on the machine the instance is running on. That is, who can | 84 instance on the machine the instance is running on. That is, who can |
| 59 actually make | 85 actually make |
| 60 changes to the database using the roundup-admin tool. See the section on | 86 changes to the database using the roundup-admin tool. See the section on |
| 61 Users_and_Access_Control for information on how to secure your instance from the | 87 Users_and_Access_Control for information on how to secure your instance from the |
| 62 start. | 88 start. |
| 63 | |
| 64 Roundup is configurable using an ``instance_config.py`` file in the instance | |
| 65 home. It | |
| 66 should be edited before roundup is used, and may have the following variable | |
| 67 declarations: | |
| 68 | |
| 69 MAILHOST | |
| 70 The SMTP mail host that roundup will use to send mail | |
| 71 MAIL_DOMAIN | |
| 72 The domain name used for email addresses | |
| 73 ISSUE_TRACKER_WEB | |
| 74 The web address of the issue tracker's web interface | |
| 75 | |
| 76 The email addresses used by the system by default are: | |
| 77 | |
| 78 ISSUE_TRACKER_EMAIL: ``issue_tracker@MAIL_DOMAIN`` | |
| 79 submissions of issues | |
| 80 | |
| 81 ADMIN_EMAIL: ``roundup-admin@MAIL_DOMAIN`` | |
| 82 roundup's internal use (problems, etc) | |
| 83 | 89 |
| 84 E-Mail Interface | 90 E-Mail Interface |
| 85 ---------------- | 91 ---------------- |
| 86 | 92 |
| 87 Setup 1: As a mail alias pipe process | 93 Setup 1: As a mail alias pipe process |
| 267 | 273 |
| 268 Next: `User Guide`_ | 274 Next: `User Guide`_ |
| 269 | 275 |
| 270 .. _`table of contents`: index.html | 276 .. _`table of contents`: index.html |
| 271 .. _`user guide`: user_guide.html | 277 .. _`user guide`: user_guide.html |
| 272 | 278 .. _`customisation`: customizing.html |
| 279 |