Skip to content

Commit

Permalink
Initial revision
Browse files Browse the repository at this point in the history
  • Loading branch information
obra committed Dec 8, 1997
0 parents commit de52aae
Show file tree
Hide file tree
Showing 65 changed files with 10,265 additions and 0 deletions.
339 changes: 339 additions & 0 deletions COPYING

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
all:
@echo "Read the readme."


dist:
cd src; make dist
22 changes: 22 additions & 0 deletions NEWS
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Aug 24, 1997
------------
The mailing routines now correctly print the To: line.
The mailing routines should now be able to handle bizzare
email addresses on the command line. (I added a pair of " marks.)

25 Aug 1997
-----------
Changing subject now returns a correct response.
Database Select errors are now more verbose.
Added in Rich West's new README. (Thanks, Rich!)

9 Sep 1997
----------
Added support routines for importing requests
Added rich west's req2rt program in contrib
Web interface now does header parsing
Web interface now displays things in <angle brackets> in messages properly.
There were other fixes which I've forgotten.



263 changes: 263 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,263 @@

RT is (c) 1996,1997 by Jesse Vincent <jrvincent@wesleyan.edu>

RT is distributed under the GNU Public License.
If you don't have a copy of the GPL, you've been living in a cave,
but one should be included in this distribution.


WARNING: RT IS BETA SOFTWARE. VERSIONS OF IT HAVE BEEN RUNNING IN
SEVERALPLACES FOR OVER A YEAR, HOWEVER I MAKE NO PROMISES AS TO ITS
STABILITY.

Development of RT has been sponsored in part by Utopia Inc, by The
Leftbank Operation and by Wesleyan University.

Some code for RT has been derived from Remy Evard's req package.
Some code for RT has been derived from Reuven Lerner's form-mail.pl
Some code for RT has been derived from Argonne National Labs' anlpasswd suite

All of these works are either in the public domain or distributed under
the GPL



REQUIRED PACKAGES:
------------------

o Perl5.x ( http://www.perl.com ) -- free

o MySQL ( http://www.tcx.se ) -- free

FTP mysql from www.tcx.se and follow the INSTALL instructions
contained therein

o MysqlPerl ( http://www.tcx.se ) -- free

FTP mysqlperl from www.tcx.se and follow the INSTALL instructions
containted therein

o Glimpse 4.0 (http://glimpse.cs.arizona.edu) -- free (detect a trend?)

FTP glimpse from ftp.cs.arizona.edu and follow the install
instructions containted therein.

At this stage of the game, glimpse won't buy you any
functionality. However, in the future, it will make your life
much easier by allowing you to search the full text of requests easily.


INSTALL INSTRUCTIONS
--------------------



With all of the above installed, it's time to do the rather easy job
of installing RT. Choose a directory in which you wish to install RT.
For the sake of simplicity, we use /usr/local/rt as the installation
directory.

If you wish to install this software in an alternate location, please
refer to the section entitled ALTERNATE INSTALLATION.


GENERAL INSTALLATION
--------------------



1 Unpack this distribution as /usr/local/rt

Granted, you've already got it open. To do this cleanly:

tar xzvf rt.tar.gz -C /usr/local

2 Create a user rt with primary group rt

3 Check over /usr/local/rt/src/Makefile

Mainly, you want to make sure all the paths up top are correct.
Is gcc your preferred compiler?

4 Edit /usr/local/rt/lib/routines/RT.pm

Specifically, you NEED to change the value for $rtpass to something
secret. After all, you don't want other people logging in and mucking
with your request database. Though it is nice to be able to escalate
one's requests secretly ;)

You also need to change the default return address for RT and
the rtname variable.


5 Edit /usr/local/rt/etc/mysql.acl

Specifically, you NEED to change the password listed there to
whatever you changed $rtpass to a moment ago.



6a FOR A NEW INSTALLATION: (If you don't have RT requests you want to keep):

As ROOT: cd /usr/local/rt/src; make install
There will be some errors about reqnum and transactnum.
That is OK. It has to do with Makefile weirdness.

6b FOR UPGRADING: (After RT version 970802):

As ROOT: cd /usr/local/rt/src; make nondestruct
This will compile new RT wrappers and fix permissions without
overwriting your RT database.




SETTING UP THE ALIAS
--------------------

In general, that is about it. All of the proper files have been
configured at this point, and you are nearly ready to get the entire
system up and running.

An alias for the initial queue will need to be made in either your
global mail aliases file (if you are using NIS) or locally on your
machine.


Add the following line to /etc/aliases (or your local equivalent) :

rt: |"/usr/local/rt/bin/rt-mailgate general correspond"
| |
<<queue-name>----/ |
|
<<correspond or comment depending on whether |
the mail shoud be resent to the requestor>---/
"action" here will make this address only
parse actions in the message without
recording the message as a transaction
of its own"


THE WEB UI
----------

If you don't already have an http daemon set up, you will probably want
to start one to handle the CGI interface. For now, I'd recommend the CERN
httpd. Apache with www.hughes.com's authentication patches has been
reported to work, as well. See the following URL for apache patches:
http://www.Hughes.com.au/software/misc/apache_1.2.1_hughes.tar.gz
Netscape's servers don't allow nph-cgi scripts to perform their own
authentication so they don't really work well with WebRT.

The CERN httpd ( http://www.w3.org ) is free. A sample config file
is in rt/etc/httpd/cern. Invoke it with the following command line:

/path/to/cern/httpd -r /usr/local/rt/etc/httpd/cern/httpd.conf

o you'll find rt-admin at http://host:8080/rt/nph-admin-webrt.cgi
o you'll find rt at http://host:8080/rt/nph-webrt.cgi and
o http://host:8080/rt/nph-webrt.cgi/frames



THE CLI
-------


Binaries for the CLI are located in /usr/local/rt/bin
You've got:

"rtq" (display a request queue)
"rt" (manipulate a request)
"rtadmin" (modify queues, users and acls)

All three of these programs take --help as an option.

NOTE: The only user with acls to access rt is root.
NOTE: root's password for the web interface is "wordpass" (without the quotes)


THE MAIL GATEWAY
----------------

The RT Mail Gateway can now be used to perform actions on requests.
For an explanation of how to use the Mail Gateway, send a message to
any RT address with the command %RT HELP on a line by itself.


ALTERNATE INSTALLATION
----------------------

So you are being daring and attempting to either install RT into a
place other than /usr/local or you would prefer to use an account/group
other than "rt". That shouldn't pose a problem, really. The regular
installation is rather easy and this only adds a few steps.


1 Unpack this distribution as <<path>/rt

Granted, you've already got it open. To do this cleanly:

tar xzvf rt.tar.gz -C <<path>

2 Create a user <<username> with primary group <<groupname>

Edit the following files to reflect the username and groupname changes:

o <<path_to_rt>/lib/routines/RT.pm
o <<path_to_rt>/etc/mysql.acl
o <<path_to_rt>/src/Makefile

3 Edit the following files, changing the path to the RT directory:


o <<path_to_rt>/lib/interfaces/cli_admin.pl
o <<path_to_rt>/lib/interfaces/cli_manipulate.pl
o <<path_to_rt>/lib/interfaces/cli_queue.pl
o <<path_to_rt>/lib/interfaces/mail_gateway.pl
o <<path_to_rt>/lib/interfaces/web_admin.pl
o <<path_to_rt>/lib/interfaces/web_manipulate.pl

o <<path_to_rt>/lib/routines/RT.pm


4 Follow the instructions above, starting from step 3



RT-USERS MAILINGLIST
--------------------


By now, you've probably hit at least one sticking point. you probably
want to join the RT-users mailinglist. Send a message to:

rt-users-request@auk.con.wesleyan.edu

With the body of the message consisting of only the word:

subscribe

Address questions to the mailinglist. If you feel your questions are
best not asked publically, send them to me personally at:
jrvincent@wesleyan.edu.




CREDITS
-------

A lot of people are responsible for making RT a better program. Many
thanks to Lauren Burka, who originally tasked me with writing this beast.
She forced me to use a database backend. I've thanked her for it every
day since. Rich West rewrote this readme and did some UI hacking. Adam
Hirsch, John Adams, Trey Belew, Sean Dague, Nathan Mehl and Kee Hinckley
have all contributed bug reports or ideas that have helped RT along. If
I've left you out, please drop me a line....it wasn't intentional.

Enjoy

Jesse Vincent
jrvincent@wesleyan.edu

17 changes: 17 additions & 0 deletions TODO
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
RT Todo List

1. Web interface for requestors.
2. Mail interface for take,give, resolve, etc.
3. Convert to DBI. (So one could use oracle, mysql, etc.)
4. Simplify Web interface.
5. Reporting tool.
6. "Actions since" command (cli, web)
7. cleaner cli.
8. mailgate should be better about mime.
9. Web interface should let users change their own info. (such as passwd)
10. Searching on text of requests.
11. req import tool.

98. rt daemon. (for running interfaces remotely or not setuid)
99. TK interface

0 comments on commit de52aae

Please sign in to comment.