652 |
@cindex using @sc{gnats} over a network |
@cindex using @sc{gnats} over a network |
653 |
@cindex configuring @sc{gnats} on a network |
@cindex configuring @sc{gnats} on a network |
654 |
|
|
655 |
When you install the @sc{gnats} utilities, the user tools are |
When you install the @sc{gnats} utilities, the user tools |
656 |
installed by default on the server machine. If your machine is part |
@code{send-pr}, @code{query-pr} and @code{edit-pr} are installed on the |
657 |
of a network, however, you may wish to install the user tools on each |
server machine. If your machine is part of a network, however, you may |
658 |
machine in the network so that responsible parties on those machines |
wish to install the user tools on each machine in the network so that |
659 |
can submit new Problem Reports, query the database, and edit existing |
responsible parties on those machines can submit new Problem Reports, |
660 |
PRs. In the following discussion, machines with the @sc{gnats} user |
query the database, and edit existing PRs. In the following discussion, |
661 |
tools installed are referred to as @dfn{client} machines. In general, |
machines with the @sc{gnats} user tools installed are referred to as |
662 |
there are three distinct types of client that a @sc{gnats} server may |
@dfn{client} machines. In general, there are three distinct types of |
663 |
have to cater for: |
client that a @sc{gnats} server may have to cater for: |
664 |
|
|
665 |
@itemize |
@itemize @minus |
666 |
@item Machines that are on the same local network as the |
@item Machines that are on the same local network as the |
667 |
@sc{gnats} server, i.e. machines that are under the same |
@sc{gnats} server, i.e. machines that are under the same |
668 |
administratice control. |
administrative control. |
669 |
|
|
670 |
@item Machines on the general, open Internet. |
@item Machines on the general, open Internet. |
671 |
|
|
680 |
@cindex using @sc{gnats} over a local network |
@cindex using @sc{gnats} over a local network |
681 |
@cindex configuring @sc{gnats} on a local network |
@cindex configuring @sc{gnats} on a local network |
682 |
|
|
683 |
If all the machines involved reside on the same local network |
If all the machines involved reside on the same local network as the |
684 |
as the @sc{gnats} server, you can simply share out the directories on |
@sc{gnats} server, you can simply share out the directories on the |
685 |
the server that contain the user tools, by default |
server that contain the user tools, by default @file{/usr/local/bin} and |
686 |
@file{/usr/local/bin} and the directory which contains the |
the directory which contains the @file{send-pr.conf} configuration file |
687 |
@file{send-pr.conf} configuration file, by default |
(@pxref{send-pr.conf file,,The send-pr.conf configuration file}), by |
688 |
@file{/usr/local/etc/gnats}. If you have a heterogeneous environment, |
default @file{/usr/local/etc/gnats}. If you have a heterogeneous |
689 |
i.e. hosts running different operating systems, you need to create |
environment, i.e. hosts running different operating systems, you need to |
690 |
several shared @sc{gnats} installations. The @file{send-pr.conf} file |
create several shared @sc{gnats} installations, one for each platform. |
691 |
is platform-independent, though. |
The @file{send-pr.conf} file is platform-independent, though. |
692 |
|
|
693 |
In order to submit a new PR, @code{send-pr} would then be invoked as |
In order to submit a new PR, @code{send-pr} would then be invoked as |
694 |
follows on the client machines: |
follows on the client machines: |
721 |
clients that need the @sc{gnats} tools, the following needs to be |
clients that need the @sc{gnats} tools, the following needs to be |
722 |
carried out on the remote machines: |
carried out on the remote machines: |
723 |
|
|
724 |
@enumerate |
@enumerate |
725 |
@item Download |
@item Configure and build @sc{gnats} on the client machine |
|
@item Configure |
|
|
@item make |
|
|
@item Install send-pr.conf |
|
|
@end enumerate |
|
726 |
|
|
727 |
Use same send-pr syntax as above or use GNATSDB, OR for sites that |
@item Configure @code{send-pr} on the client machine |
728 |
need to submit by e-mail, create a template by running ``send-pr -p'' |
@end enumerate |
|
and install this file on the clients. |
|
729 |
|
|
730 |
For clients that have no direct network access to your @sc{gnats} |
You should unpack the distribution and run @code{configure} on the |
731 |
server, such as those that are located behind strict firewalls, you |
client machine in the same way as described in @ref{Configure and |
732 |
either need to set up a web interface such as Gnatsweb (provided that |
make,,Configuring and compiling the software}. Note, however, that you |
733 |
the firewall lets web traffic through) or use a variation on the |
do not need to create a @code{gnats} user on the client and you should |
734 |
procedure above which sets up @code{send-pr} to submit Problem Reports |
not use the @code{make all info} command to build. Instead, issue the |
735 |
by e-mail. In order to query PRs, users on the remote machines will |
following commands from the top level directory of the source |
736 |
then have to use the the e-mail functionality of @code{query-pr} |
distribution: |
|
(@pxref{Invoking query-pr}. Editing PRs by e-mail is not possible, so |
|
|
clients in this group who need edit access have to get access through |
|
|
a web interface if possible. |
|
|
|
|
|
For clients without direct network access, you need to go through the |
|
|
procedure described above to install the @sc{gnats} user tools. Then |
|
|
you should run the command |
|
737 |
|
|
738 |
@smallexample |
@smallexample |
739 |
send-pr -p |
cd gnats |
740 |
|
make install-tools |
741 |
|
cd ../send-pr |
742 |
|
make all install |
743 |
@end smallexample |
@end smallexample |
744 |
|
|
745 |
@emph{on the @sc{gnats} server} to print out a template for new PRs. |
This builds and installs the @code{send-pr}, @code{query-pr} and |
746 |
Save this template and have it installed on the remote client. Then |
@code{edit-pr} tools on the client machine. You should now configure |
747 |
add the following lines to the file @file{send-pr.conf} on the client: |
@code{send-pr} by editing the @file{send-pr.conf} file |
748 |
|
(@pxref{send-pr.conf file,,The send-pr.conf configuration file}.) |
749 |
|
|
750 |
|
Users on the client machine can now either use the send-pr syntax or the |
751 |
|
@code{GNATSDB}environment variable described in the previous section. |
752 |
|
|
753 |
|
For sites that need to submit Problem Reports by having send-pr send |
754 |
|
e-mail instead of speaking directly over the network to the @sc{gnats} |
755 |
|
server, you need to create a problem report template on the @sc{gnats} |
756 |
|
server and have that template copied to a suitable location on the |
757 |
|
client machine (any filename and any location will do, as long as |
758 |
|
@code{send-pr} on the client machine can read the file). On the |
759 |
|
@sc{gnats} server, use the command |
760 |
|
|
761 |
@smallexample |
@smallexample |
762 |
TEMPLATE=@var{path to template file} |
send-pr -p > @file{filename} |
|
MAILPROG=@var{mail program} |
|
|
MAILADDR=@var{submission address for new PRs} |
|
763 |
@end smallexample |
@end smallexample |
764 |
|
|
765 |
Substitute as appropriate for the client machine. @xref{send-pr.conf |
The file @file{filename} now contains a PR template for your database. |
766 |
file}. |
Copy this file to the client. Then edit the @file{send-pr.conf} file |
767 |
|
that you created on the client, set the @code{TEMPLATE} variable to |
768 |
|
point to the template file (@pxref{send-pr.conf file,,The send-pr.conf |
769 |
|
configuration file}) and make sure that the @code{MAILPROG} and |
770 |
|
@code{MAILADDR} varables in @file{send-pr.conf} are correctly set. You |
771 |
|
should now have a working remote tool installation. |
772 |
|
|
773 |
|
For clients that have no direct network access to your @sc{gnats} |
774 |
|
server, such as those that are located behind strict firewalls, you |
775 |
|
either need to set up a web interface such as Gnatsweb (provided that |
776 |
|
the firewall lets web traffic through) or use the procedure above which |
777 |
|
sets up @code{send-pr} to submit Problem Reports by e-mail. In order to |
778 |
|
query PRs, users on the remote machines will then have to use the the |
779 |
|
e-mail functionality of @code{query-pr} (@pxref{Invoking query-pr}. |
780 |
|
Editing PRs by e-mail is not possible, so clients in this group who need |
781 |
|
edit access have to get access through a web interface if possible. |
782 |
|
|
783 |
Note that when @code{send-pr} is set up to work over e-mail, the |
Note that when @code{send-pr} is set up to work over e-mail, the |
784 |
@code{GNATSDB} environment variable and the @code{-d} command line |
@code{GNATSDB} environment variable and the @code{-d} command line |
785 |
option have no effect since @code{send-pr} is tied to a specific |
option have no effect since @code{send-pr} is tied to a specific |
786 |
database by way of the value of @code{MAILAADR} in the |
database by way of the value of @code{MAILADDR} in the |
787 |
@file{send-pr.conf} file. |
@file{send-pr.conf} file. |
788 |
|
|
789 |
@c --------------------------------------------------------------- |
@c --------------------------------------------------------------- |