Mercurial > p > roundup > code
comparison doc/installation.txt @ 3524:ed82c2c6ee34
fix doc
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Sun, 29 Jan 2006 23:40:41 +0000 |
| parents | f29a307ab3fe |
| children | 762d65fefea5 |
comparison
equal
deleted
inserted
replaced
| 3523:f29a307ab3fe | 3524:ed82c2c6ee34 |
|---|---|
| 126 | 126 |
| 127 Basic Installation Steps | 127 Basic Installation Steps |
| 128 ------------------------ | 128 ------------------------ |
| 129 | 129 |
| 130 To install the Roundup support code into your Python tree and | 130 To install the Roundup support code into your Python tree and |
| 131 Roundup scripts into /usr/local/bin (substitute that path for whatever is | 131 Roundup scripts into /usr/bin (substitute that path for whatever is |
| 132 appropriate on your system). You need to have write permissions | 132 appropriate on your system). You need to have write permissions |
| 133 for these locations, eg. being root on unix:: | 133 for these locations, eg. being root on unix:: |
| 134 | 134 |
| 135 python setup.py install | 135 python setup.py install |
| 136 | 136 |
| 137 If you would like to place the Roundup scripts in a directory other | 137 If you would like to place the Roundup scripts in a directory other |
| 138 than ``/usr/local/bin``, then specify the preferred location with | 138 than ``/usr/bin``, then specify the preferred location with |
| 139 ``--install-script``. For example, to install them in | 139 ``--install-script``. For example, to install them in |
| 140 ``/opt/roundup/bin``:: | 140 ``/opt/roundup/bin``:: |
| 141 | 141 |
| 142 python setup.py install --install-scripts=/opt/roundup/bin | 142 python setup.py install --install-scripts=/opt/roundup/bin |
| 143 | 143 |
| 506 | 506 |
| 507 As a mail alias pipe process | 507 As a mail alias pipe process |
| 508 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 508 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 509 | 509 |
| 510 Set up a mail alias called "issue_tracker" as (include the quote marks): | 510 Set up a mail alias called "issue_tracker" as (include the quote marks): |
| 511 "``|/usr/bin/python /usr/local/bin/roundup-mailgw <tracker_home>``" | 511 "``|/usr/bin/python /usr/bin/roundup-mailgw <tracker_home>``" |
| 512 (substitute ``/usr/local/bin`` for wherever roundup-mailgw is installed). | 512 (substitute ``/usr/bin`` for wherever roundup-mailgw is installed). |
| 513 | 513 |
| 514 In some installations (e.g. RedHat 6.2 I think) you'll need to set up smrsh so | 514 In some installations (e.g. RedHat 6.2 I think) you'll need to set up smrsh so |
| 515 sendmail will accept the pipe command. In that case, symlink | 515 sendmail will accept the pipe command. In that case, symlink |
| 516 ``/etc/smrsh/roundup-mailgw`` to "``/usr/local/bin/roundup-mailgw``" and change | 516 ``/etc/smrsh/roundup-mailgw`` to "``/usr/bin/roundup-mailgw``" and change |
| 517 the command to:: | 517 the command to:: |
| 518 | 518 |
| 519 |roundup-mailgw /opt/roundup/trackers/support | 519 |roundup-mailgw /opt/roundup/trackers/support |
| 520 | 520 |
| 521 To test the mail gateway on unix systems, try:: | 521 To test the mail gateway on unix systems, try:: |
| 618 | 618 |
| 619 As a regular job using a mailbox source | 619 As a regular job using a mailbox source |
| 620 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 620 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 621 | 621 |
| 622 Set ``roundup-mailgw`` up to run every 10 minutes or so. For example | 622 Set ``roundup-mailgw`` up to run every 10 minutes or so. For example |
| 623 (substitute ``/usr/local/bin`` for wherever roundup-mailgw is installed):: | 623 (substitute ``/usr/bin`` for wherever roundup-mailgw is installed):: |
| 624 | 624 |
| 625 0,10,20,30,40,50 * * * * /usr/local/bin/roundup-mailgw /opt/roundup/trackers/support mailbox <mail_spool_file> | 625 0,10,20,30,40,50 * * * * /usr/bin/roundup-mailgw /opt/roundup/trackers/support mailbox <mail_spool_file> |
| 626 | 626 |
| 627 Where the ``mail_spool_file`` argument is the location of the roundup submission | 627 Where the ``mail_spool_file`` argument is the location of the roundup submission |
| 628 user's mail spool. On most systems, the spool for a user "issue_tracker" | 628 user's mail spool. On most systems, the spool for a user "issue_tracker" |
| 629 will be "``/var/mail/issue_tracker``". | 629 will be "``/var/mail/issue_tracker``". |
| 630 | 630 |
| 631 As a regular job using a POP source | 631 As a regular job using a POP source |
| 632 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 632 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 633 | 633 |
| 634 To retrieve from a POP mailbox, use a *cron* entry similar to the mailbox | 634 To retrieve from a POP mailbox, use a *cron* entry similar to the mailbox |
| 635 one (substitute ``/usr/local/bin`` for wherever roundup-mailgw is | 635 one (substitute ``/usr/bin`` for wherever roundup-mailgw is |
| 636 installed):: | 636 installed):: |
| 637 | 637 |
| 638 0,10,20,30,40,50 * * * * /usr/local/bin/roundup-mailgw /opt/roundup/trackers/support pop <pop_spec> | 638 0,10,20,30,40,50 * * * * /usr/bin/roundup-mailgw /opt/roundup/trackers/support pop <pop_spec> |
| 639 | 639 |
| 640 where pop_spec is "``username:password@server``" that specifies the roundup | 640 where pop_spec is "``username:password@server``" that specifies the roundup |
| 641 submission user's POP account name, password and server. | 641 submission user's POP account name, password and server. |
| 642 | 642 |
| 643 On windows, you would set up the command using the windows scheduler. | 643 On windows, you would set up the command using the windows scheduler. |
| 644 | 644 |
| 645 As a regular job using an IMAP source | 645 As a regular job using an IMAP source |
| 646 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 646 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 647 | 647 |
| 648 To retrieve from an IMAP mailbox, use a *cron* entry similar to the | 648 To retrieve from an IMAP mailbox, use a *cron* entry similar to the |
| 649 POP one (substitute ``/usr/local/bin`` for wherever roundup-mailgw is | 649 POP one (substitute ``/usr/bin`` for wherever roundup-mailgw is |
| 650 installed):: | 650 installed):: |
| 651 | 651 |
| 652 0,10,20,30,40,50 * * * * /usr/local/bin/roundup-mailgw /opt/roundup/trackers/support imap <imap_spec> | 652 0,10,20,30,40,50 * * * * /usr/bin/roundup-mailgw /opt/roundup/trackers/support imap <imap_spec> |
| 653 | 653 |
| 654 where imap_spec is "``username:password@server``" that specifies the roundup | 654 where imap_spec is "``username:password@server``" that specifies the roundup |
| 655 submission user's IMAP account name, password and server. You may | 655 submission user's IMAP account name, password and server. You may |
| 656 optionally include a mailbox to use other than the default ``INBOX`` with | 656 optionally include a mailbox to use other than the default ``INBOX`` with |
| 657 "``imap username:password@server mailbox``". | 657 "``imap username:password@server mailbox``". |