654 |
@cindex configuring @sc{gnats} on a network |
@cindex configuring @sc{gnats} on a network |
655 |
|
|
656 |
When you install the @sc{gnats} utilities, the user tools are |
When you install the @sc{gnats} utilities, the user tools are |
657 |
installed by default on the host machine. If your machine is part of |
installed by default on the server machine. If your machine is part |
658 |
a network, however, you may wish to install the user tools on each |
of a network, however, you may wish to install the user tools on each |
659 |
machine in the network so that responsible parties on those machines |
machine in the network so that responsible parties on those machines |
660 |
can submit new Problem Reports, query the database, and edit existing |
can submit new Problem Reports, query the database, and edit existing |
661 |
PRs. |
PRs. In the following discussion, machines with the @sc{gnats} user |
662 |
|
tools installed are referred to as @dfn{client} machines. In general, |
663 |
|
there are three distinct types of client that a @sc{gnats} server may |
664 |
|
have to cater for: |
665 |
|
|
666 |
|
@itemize |
667 |
|
@item Machines that are on the same local network as the |
668 |
|
@sc{gnats} server, i.e. machines that are under the same |
669 |
|
administratice control. |
670 |
|
|
671 |
|
@item Machines on the general, open Internet. |
672 |
|
|
673 |
|
@item Machines behind firewalls etc. which deny direct access |
674 |
|
over the network to the @sc{gnats} server. |
675 |
|
@end itemize |
676 |
|
|
677 |
In the following discussion, machines with the @sc{gnats} user |
Each type of client requires a different approach when it comes to |
678 |
tools installed are referred to as @dfn{client} machines. |
providing access. |
|
|
|
|
As discussed below, there are two main ways to make the user tools |
|
|
available on client hosts, depending on where the client machines are |
|
|
located. |
|
679 |
|
|
680 |
@subsection User tools on a local network |
@subsection User tools on a local network |
681 |
@cindex using @sc{gnats} over a local network |
@cindex using @sc{gnats} over a local network |
707 |
|
|
708 |
Then, @code{send-pr} can simply be invoked without any options. |
Then, @code{send-pr} can simply be invoked without any options. |
709 |
|
|
710 |
|
The other tools, @code{query-pr} and @code{edit-pr}, work in similar |
711 |
|
ways, honoring the @code{-d} option as well as the @code{GNATSDB} |
712 |
|
environment variable. @xref{GNATS user tools}. |
713 |
|
|
714 |
@subsection User tools for remote users |
@subsection User tools for remote users |
715 |
@cindex using @sc{gnats} remotely |
@cindex using @sc{gnats} remotely |
716 |
@cindex configuring @sc{gnats} for remote users |
@cindex configuring @sc{gnats} for remote users |
717 |
|
|
718 |
Outline for each host: |
When client machines reside on the general Internet, both security and |
719 |
|
practical considerations may make it impossible to provide a shared |
720 |
|
installation of the @sc{gnats} tools. In this case, you may choose to |
721 |
|
only provide access through a web interface such as Gnatsweb. For |
722 |
|
clients that need the @sc{gnats} tools, the following needs to be |
723 |
|
carried out on the remote machines: |
724 |
|
|
725 |
@enumerate |
@enumerate |
726 |
@item Download |
@item Download |
733 |
need to submit by e-mail, create a template by running ``send-pr -p'' |
need to submit by e-mail, create a template by running ``send-pr -p'' |
734 |
and install this file on the clients. |
and install this file on the clients. |
735 |
|
|
736 |
@c --------------------------------------------------------------- |
For clients that have no direct network access to your @sc{gnats} |
737 |
|
server, such as those that are located behind strict firewalls, you |
738 |
|
either need to set up a web interface such as Gnatsweb (provided that |
739 |
|
the firewall lets web traffic through) or use a variation on the |
740 |
|
procedure above which sets up @code{send-pr} to submit Problem Reports |
741 |
|
by e-mail. In order to query PRs, users on the remote machines will |
742 |
|
then have to use the the e-mail functionality of @code{query-pr} |
743 |
|
(@pxref{Invoking query-pr}. Editing PRs by e-mail is not possible, so |
744 |
|
clients in this group who need edit access have to get access through |
745 |
|
a web interface if possible. |
746 |
|
|
747 |
|
For clients without direct network access, you need to go through the |
748 |
|
procedure described above to install the @sc{gnats} user tools. Then |
749 |
|
you should run the command |
750 |
|
|
751 |
|
@smallexample |
752 |
|
send-pr -p |
753 |
|
@end smallexample |
754 |
|
|
755 |
|
@emph{on the @sc{gnats} server} to print out a template for new PRs. |
756 |
|
Save this template and have it installed on the remote client. Then |
757 |
|
add the following lines to the file @file{send-pr.conf} on the client: |
758 |
|
|
759 |
|
@smallexample |
760 |
|
TEMPLATE=@var{path to template file} |
761 |
|
MAILPROG=@var{mail program} |
762 |
|
MAILADDR=@var{submission address for new PRs} |
763 |
|
@end smallexample |
764 |
|
|
765 |
|
Substitute as appropriate for the client machine. @xref{send-pr.conf |
766 |
|
file}. |
767 |
|
|
768 |
|
Note that when @code{send-pr} is set up to work over e-mail, the |
769 |
|
@code{GNATSDB} environment variable and the @code{-d} command line |
770 |
|
option have no effect since @code{send-pr} is tied to a specific |
771 |
|
database by way of the value of @code{MAILAADR} in the |
772 |
|
file{send-pr.conf} file. |
773 |
|
|
774 |
|
@C--------------------------------------------------------------- |
775 |
@node Upgrading |
@node Upgrading |
776 |
@section Upgrading from older versions |
@section Upgrading from older versions |
777 |
@cindex upgrading from older versions |
@cindex upgrading from older versions |