Mercurial > p > roundup > code
comparison doc/index.html @ 270:a4241ddd22d7
Added the Password property type.
See "pydoc roundup.password" for implementation details. Have updated
some of the documentation too.
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Tue, 09 Oct 2001 07:25:59 +0000 |
| parents | dcc1ed25e6bc |
| children | 85908e1f46ad |
comparison
equal
deleted
inserted
replaced
| 269:82cfd78f3c4e | 270:a4241ddd22d7 |
|---|---|
| 19 <ul> | 19 <ul> |
| 20 <li><a href="#instance">The Instance</a> | 20 <li><a href="#instance">The Instance</a> |
| 21 <li><a href="#startcmd">Command Line Tool</a> | 21 <li><a href="#startcmd">Command Line Tool</a> |
| 22 <li><a href="#startweb">E-Mail Interface</a> | 22 <li><a href="#startweb">E-Mail Interface</a> |
| 23 <li><a href="#startweb">Web Interface</a> | 23 <li><a href="#startweb">Web Interface</a> |
| 24 <li><a href="#users">Users</a> (Users and permissions, Adding users) | 24 <li><a href="#users">Users and Access Control</a> (Users and permissions, Adding users) |
| 25 <li><a href="#issues">Issues</a> | 25 <li><a href="#issues">Issues</a> |
| 26 </ul> | 26 </ul> |
| 27 <li><a href="#guide">User Guide</a> | 27 <li><a href="#guide">User Guide</a> |
| 28 <ul> | 28 <ul> |
| 29 <li><a href="#cmd">Command Line Tool</a> | 29 <li><a href="#cmd">Command Line Tool</a> |
| 124 <li>Schema to use | 124 <li>Schema to use |
| 125 <li>Database back-end to use | 125 <li>Database back-end to use |
| 126 <li>Administration user "admin" password. | 126 <li>Administration user "admin" password. |
| 127 </ol> | 127 </ol> |
| 128 | 128 |
| 129 You should also think about whether there is going to be controlled access | |
| 130 to the instance on the machine the instance is running on. That is, who can | |
| 131 actually make changes to the database using the roundup-admin tool. See | |
| 132 the section on <a href="#users">Users and Access Control</a> for | |
| 133 information on how to secure your instance from the start. | |
| 134 | |
| 135 <p> | |
| 136 | |
| 129 Roundup is configurable using an instance_config.py file in the instance home. | 137 Roundup is configurable using an instance_config.py file in the instance home. |
| 130 It should be edited before roundup is used, and may have the following | 138 It should be edited before roundup is used, and may have the following |
| 131 variable declarations: | 139 variable declarations: |
| 132 | 140 |
| 133 <ol> | 141 <ol> |
| 225 roundup, they will be using the database in a read-only mode. That is, if | 233 roundup, they will be using the database in a read-only mode. That is, if |
| 226 roundup doesn't know who they are, they can't change anything. This has the | 234 roundup doesn't know who they are, they can't change anything. This has the |
| 227 following repurcussions: | 235 following repurcussions: |
| 228 <dl> | 236 <dl> |
| 229 <dt><strong>Command-line interface</strong> | 237 <dt><strong>Command-line interface</strong> |
| 230 <dd>The data modification commands (create, init, retire, set) are not | 238 <dd>The data modification commands (create, init, retire, set) are |
| 231 available without a login, and if one is not supplied on the command line | 239 performed as the "admin" user. It is therefore important that the database |
| 232 (-u user:pass) then it will be prompted for. | 240 be protected by the filesystem if protection is required. On a Unix system, |
| 241 the easiest and most flexible method of doing so is: | |
| 242 <ol> | |
| 243 <li>Add a new user and group to your system (e.g. "issue_tracker") | |
| 244 <li>When creating a new instance home, use the following commands | |
| 245 (substituting instance_home for the directory you want to use):<br> | |
| 246 <pre> | |
| 247 mkdir instance_home | |
| 248 chown issue_tracker:issue_tracker instance_home | |
| 249 chmod g+rwxs instance_home | |
| 250 chmod o-rwx instance_home | |
| 251 roundup-admin -i instance_home init | |
| 252 </pre> | |
| 253 <li>Now, edit the /etc/group line for issue_tracker so it includes the unix | |
| 254 logins of all the users who are going to administer your roundup instance. | |
| 255 </ol> | |
| 256 | |
| 233 <dt><strong>E-Mail interface</strong> | 257 <dt><strong>E-Mail interface</strong> |
| 234 <dd>Users are identified by e-mail address - a new user entry will be | 258 <dd>Users are identified by e-mail address - a new user entry will be |
| 235 created for any e-mail address that is not recognised, so users are | 259 created for any e-mail address that is not recognised, so users are |
| 236 <em>always</em> identified by roundup. | 260 <em>always</em> identified by roundup. |
| 237 <dt><strong>Web interface</strong> | 261 <dt><strong>Web interface</strong> |
| 238 <dd>Unidentified users have read-only access. If the users database has an | 262 <dd>Unidentified users have read-only access. If the users database has an |
| 239 entry with the username "anonymous", then unidentified users are | 263 entry with the username "anonymous", then unidentified users are |
| 240 automatically logged in as that user. This gives them write access. | 264 automatically logged in as that user. This gives them write access. |
| 241 </dl> | 265 </dl> |
| 242 <p> | 266 <p> |
| 243 There has been only a half-hearted attempt to restrict certain activities | |
| 244 to the "admin" user. For example, the "extended" schema web interface enables | |
| 245 some fnuctionality for the "admin" user. On the fil-side, it is possible to | |
| 246 obtain the admin user's password using the read-only access on the command | |
| 247 line (it would also be possible to access the database files directly to | |
| 248 obtain this information). | |
| 249 | 267 |
| 250 <h3>Adding users</h3> | 268 <h3>Adding users</h3> |
| 251 To add users, use one of the following interfaces: | 269 To add users, use one of the following interfaces: |
| 252 | 270 |
| 253 <ol> | 271 <ol> |
| 1083 Go Ping, you rock! Also, go Bizar Software for letting me implement this | 1101 Go Ping, you rock! Also, go Bizar Software for letting me implement this |
| 1084 system on their time. | 1102 system on their time. |
| 1085 | 1103 |
| 1086 <p> </p> | 1104 <p> </p> |
| 1087 <hr> | 1105 <hr> |
| 1088 $Id: index.html,v 1.10 2001-10-08 21:49:30 richard Exp $ | 1106 $Id: index.html,v 1.11 2001-10-09 07:25:59 richard Exp $ |
| 1089 <p> </p> | 1107 <p> </p> |
| 1090 | 1108 |
| 1091 </body></html> | 1109 </body></html> |
| 1092 | 1110 |