https://rt-wiki.bestpractical.com/api.php?action=feedcontributions&feedformat=atom&user=Craigkai 2026-08-21T21:54:23Z User contributions MediaWiki 1.41.1 https://rt-wiki.bestpractical.com/index.php?title=ManualEmailConfig&diff=26861 2019-03-22T14:31:11Z

<p>Craigkai: </p> <hr /> <div>Prev: [[ManualApacheConfig]] --- Up: [[UserManual]] --- Next: [[ManualBasicAdministration]]<br /> <br /> ----<br /> <br /> = SETTING UP THE MAIL GATEWAY =<br /> <br /> The mail gateway is used to receive mail messages '''into''' an RT instance; outbound mail is usually just handed off to the local SMTP sending program, or a specified SMTP smarthost.<br /> <br /> The mail gateway requires the web UI to be set up and functional. If you intend to use SSL to secure your mail gateway, you need to make sure that lib-www-perl, a.k.a LWP, is built with SSL support.<br /> <br /> 1) Documentation for setting up the mail gateway can be found at:<br /> <br /> https://docs.bestpractical.com/rt/latest/rt-mailgate.html<br /> <br /> 2) You need to tell your Mail Transfer Agent (e.g. sendmail, postfix, or qmail) how to forward messages to RT's mail gateway. To do this, create an aliases in your system's mail aliases file. Here's an example, which routes mail to the mailbox [=[mailto:rt@example.com rt@example.com]] (and [=[mailto:rt-comment@example.com rt-comment@example.com]]) into new tickets in the RT queue named '''General'''. Note that the queue name is case-insensitive.<br /> <br /> Add the following lines to /etc/aliases (or your local equivalent such as /etc/mail/aliases):<br /> rt: &quot;|/opt/rt4/bin/rt-mailgate --queue general --action correspond --url http://localhost/rt&quot;<br /> rt-comment: &quot;|/opt/rt4/bin/rt-mailgate --queue general --action comment --url http://localhost/rt&quot;<br /> (Replace /opt/rt4 by your RT installation path and http://localhost/rt by the URL of your RT installation on your webserver)<br /> <br /> '''NOTE:''' When you add the above each alias entry should be all one line; make sure you include the quotes.<br /> <br /> '''NOTE:''' &lt;code&gt;qmail&lt;/code&gt; users should follow the [[QMail]] link to review caveats about &lt;code&gt;fastforward&lt;/code&gt; command aliases.<br /> <br /> Replace '''general''' with the name of your queue and '''rt''' (before the colon in the alias) with the email address you wish people to send their messages to. You might, for example, have messages to '''support''' go into the '''service''' queue, and '''abuse''' go into the '''ops''' queue. You can have more than one set of aliases point to the same queue, if, for example, you wanted mail to both '''abuse''' and '''security''' both go to the '''ops''' queue.<br /> <br /> The queue name may have spaces. &lt;code&gt;rt-mailgate&lt;/code&gt; works as well with them, but do not forget to escape these spaces by enclosing the queue name in single quote:<br /> my-queue: &quot;|/opt/rt4/bin/rt-mailgate --queue 'My Queue' --action correspond --url http://localhost/&quot;<br /> If you are using the default sendmail included in most redhat distro's you will most likely need to copy (cp) rt-mailgate to /etc/smrsh or create a symbolic link and change /opt/rt4/bin above to /etc/smrsh or sendmail will complain. These sendmails will only execute programs as alias targets which have been blessed by placing them in a special directory. This is not necessary for Exim or postfix.<br /> <br /> You'll choose from &quot;--action correspond&quot; and &quot;--action comment&quot; depending on whether the mail should be resent to the requestor. If you want the requestor to see it, choose correspond; if you want to keep it from the requestor, choose comment.<br /> <br /> The URL will be the URL for RT's web interface, such as http://issues.bestpractical.com/, [http://fsck.com/rt/ =]; whatever is the root of your RT install.<br /> <br /> 3) Stop and start your mail server, so it picks up your configuration changes. With sendmail or postfix (possibly others), you usually also need to type the command &quot;newaliases&quot; to get the server to recognize the new aliases. If this command is unrecognized, it's probably not in your default path; a common location is &quot;/usr/sbin/newaliases&quot;.<br /> <br /> You '''can''' have the mail gateway on your MX or some other server and have it talk to RT via HTTP. For more details, see [[InstallMailgateOnly]].<br /> <br /> To configure a mail transfer agent (postfix) to post tickets to RT4 on a separate server ....<br /> <br /> Add the following lines to /etc/aliases (or your local equivalent such as /etc/mail/aliases):<br /> rt: &quot;|/&amp;lt;path-to-mailgate&amp;gt;/rt-mailgate --queue general --action correspond --url http://&amp;lt;the-URL-of-the-RT-server&amp;gt;/&quot;<br /> rt-comment: &quot;|/&amp;lt;path-to-mailgate&amp;gt;/rt-mailgate --queue general --action comment --url http://&amp;lt;the-URL-of-the-RT-server&amp;gt;/&quot;<br /> The link to RT is now configured. However, the rt-mailgate script is a perl script which requires support. On a fresh [[SuSE]] 9.3 server install, the following was needed to provide the necessary perl libraries (someone with deeper knowledge may know of a more restrictive set of libraries, but these worked).<br /> <br /> #(install gcc and glibc, if necessary)<br /> perl -MCPAN -eshell (to configure CPAN)<br /> perl -MCPAN -e 'install(&quot;LWP&quot;)'<br /> perl -MCPAN -e 'install(&quot;Bundle::LWP&quot;)'<br /> <br /> If Using SSL, add:<br /> perl -MCPAN -e 'install(&quot;Crypt::SSLeay&quot;)'<br /> To test the connection...<br /> echo 'hello' | mail -s &quot;Test subject&quot; rt<br /> If you get a &quot;command died with status 1&quot; error message, the rt-mailgate script possibly doesn't have the execute bit set for the user/group under which postfix is running.<br /> chmod o+x /&amp;lt;path-to-mailgate&amp;gt;/rt-mailgate<br /> For more information on configuring your mail gateway, see [[ManualAdministration]]<br /> <br /> <br /> = Using Fetchmail/Getmail For Incoming Email =<br /> <br /> Fetchmail or Getmail can be used to fetch email from a inbox using IMAP or POP. An example configuration for Fetchmail can be seen below:<br /> set daemon 0<br /> # PID files are more useful for forking systemd services. But fetchmail will<br /> # always write one. Since the service runs fetchmail as the apache user,<br /> # www-data, we need to give fetchmail a path that it has write permission to.<br /> #set pidfile '/opt/rt4/var/run/fetchmail-rtir.pid'<br /> poll &quot;IP_OF_MAIL_SERVER&quot; proto imap port 993<br /> user &quot;rt@mycompany.com&quot; password &quot;password&quot;<br /> ssl<br /> folder 'Inbox'<br /> # Some IMAP servers generate an error like this:<br /> #<br /> # could not decode BASE64 challenge<br /> #<br /> # This might be because the server is configured to expect<br /> # certain authentication attempt types, first. fetchmail also<br /> # tries certain authentication methods first, but not password,<br /> # even with the 'password' keyword.<br /> #<br /> # The 'auth' keyword tells fetchmail to attempt the given<br /> # authentication type, first. That can eliminate initial<br /> # authentication failures, which might eliminate this error<br /> # messgae<br /> # IMAP supports flags on individual messages to indicate the<br /> # message status. The 'Seen' flag indicates that the message has<br /> # been read by a client. This could be a webmail client like Gmail<br /> # our Outlook, or fetchmail. The RT use case for fetchmail expects<br /> # that fetchmail will get all mail that hasn't been delivered to<br /> # RT, regardless of whether other clients have seen it. Without<br /> # this option, fetchmail will only download mail from an IMAP<br /> # server without the 'Seen' flag. This option tells fetchmail to<br /> # ignore 'Seen' flags and download all messages.<br /> # fetchall<br /> mda '/opt/rt4/bin/rt-mailgate --url https://rt.mycompany.com --queue &quot;support&quot; --action correspond'<br /> idle<br /> Lastly you will need a cronjob to pull your inbox periodically<br /> `*/1 * * * * root /usr/bin/getmail --fetchmailrc /opt/rt4/etc/fetchmailrc --quiet`<br /> ----<br /> Prev: [[ManualApacheConfig]] --- Up: [[UserManual]] --- Next: [[ManualBasicAdministration]]<br /> [[Category:RT User Manual]]</div>

Craigkai https://rt-wiki.bestpractical.com/index.php?title=ManualEmailConfig&diff=26860 2019-03-22T14:27:10Z

<p>Craigkai: </p> <hr /> <div>Prev: [[ManualApacheConfig]] --- Up: [[UserManual]] --- Next: [[ManualBasicAdministration]]<br /> <br /> ----<br /> <br /> = SETTING UP THE MAIL GATEWAY =<br /> <br /> The mail gateway is used to receive mail messages '''into''' an RT instance; outbound mail is usually just handed off to the local SMTP sending program, or a specified SMTP smarthost.<br /> <br /> The mail gateway requires the web UI to be set up and functional. If you intend to use SSL to secure your mail gateway, you need to make sure that lib-www-perl, a.k.a LWP, is built with SSL support.<br /> <br /> 1) Documentation for setting up the mail gateway can be found at:<br /> <br /> https://docs.bestpractical.com/rt/latest/rt-mailgate.html<br /> <br /> 2) You need to tell your Mail Transfer Agent (e.g. sendmail, postfix, or qmail) how to forward messages to RT's mail gateway. To do this, create an aliases in your system's mail aliases file. Here's an example, which routes mail to the mailbox [=[mailto:rt@example.com rt@example.com]] (and [=[mailto:rt-comment@example.com rt-comment@example.com]]) into new tickets in the RT queue named '''General'''. Note that the queue name is case-insensitive.<br /> <br /> Add the following lines to /etc/aliases (or your local equivalent such as /etc/mail/aliases):<br /> rt: &quot;|/opt/rt4/bin/rt-mailgate --queue general --action correspond --url http://localhost/rt&quot;<br /> rt-comment: &quot;|/opt/rt4/bin/rt-mailgate --queue general --action comment --url http://localhost/rt&quot;<br /> (Replace /opt/rt4 by your RT installation path and http://localhost/rt by the URL of your RT installation on your webserver)<br /> <br /> '''NOTE:''' When you add the above each alias entry should be all one line; make sure you include the quotes.<br /> <br /> '''NOTE:''' &lt;code&gt;qmail&lt;/code&gt; users should follow the [[QMail]] link to review caveats about &lt;code&gt;fastforward&lt;/code&gt; command aliases.<br /> <br /> Replace '''general''' with the name of your queue and '''rt''' (before the colon in the alias) with the email address you wish people to send their messages to. You might, for example, have messages to '''support''' go into the '''service''' queue, and '''abuse''' go into the '''ops''' queue. You can have more than one set of aliases point to the same queue, if, for example, you wanted mail to both '''abuse''' and '''security''' both go to the '''ops''' queue.<br /> <br /> The queue name may have spaces. &lt;code&gt;rt-mailgate&lt;/code&gt; works as well with them, but do not forget to escape these spaces by enclosing the queue name in single quote:<br /> my-queue: &quot;|/opt/rt4/bin/rt-mailgate --queue 'My Queue' --action correspond --url http://localhost/&quot;<br /> If you are using the default sendmail included in most redhat distro's you will most likely need to copy (cp) rt-mailgate to /etc/smrsh or create a symbolic link and change /opt/rt4/bin above to /etc/smrsh or sendmail will complain. These sendmails will only execute programs as alias targets which have been blessed by placing them in a special directory. This is not necessary for Exim or postfix.<br /> <br /> You'll choose from &quot;--action correspond&quot; and &quot;--action comment&quot; depending on whether the mail should be resent to the requestor. If you want the requestor to see it, choose correspond; if you want to keep it from the requestor, choose comment.<br /> <br /> The URL will be the URL for RT's web interface, such as http://issues.bestpractical.com/, [http://fsck.com/rt/ =]; whatever is the root of your RT install.<br /> <br /> 3) Stop and start your mail server, so it picks up your configuration changes. With sendmail or postfix (possibly others), you usually also need to type the command &quot;newaliases&quot; to get the server to recognize the new aliases. If this command is unrecognized, it's probably not in your default path; a common location is &quot;/usr/sbin/newaliases&quot;.<br /> <br /> You '''can''' have the mail gateway on your MX or some other server and have it talk to RT via HTTP. For more details, see [[InstallMailgateOnly]].<br /> <br /> To configure a mail transfer agent (postfix) to post tickets to RT4 on a separate server ....<br /> <br /> Add the following lines to /etc/aliases (or your local equivalent such as /etc/mail/aliases):<br /> rt: &quot;|/&amp;lt;path-to-mailgate&amp;gt;/rt-mailgate --queue general --action correspond --url http://&amp;lt;the-URL-of-the-RT-server&amp;gt;/&quot;<br /> rt-comment: &quot;|/&amp;lt;path-to-mailgate&amp;gt;/rt-mailgate --queue general --action comment --url http://&amp;lt;the-URL-of-the-RT-server&amp;gt;/&quot;<br /> The link to RT is now configured. However, the rt-mailgate script is a perl script which requires support. On a fresh [[SuSE]] 9.3 server install, the following was needed to provide the necessary perl libraries (someone with deeper knowledge may know of a more restrictive set of libraries, but these worked).<br /> <br /> #(install gcc and glibc, if necessary)<br /> perl -MCPAN -eshell (to configure CPAN)<br /> perl -MCPAN -e 'install(&quot;LWP&quot;)'<br /> perl -MCPAN -e 'install(&quot;Bundle::LWP&quot;)'<br /> <br /> If Using SSL, add:<br /> perl -MCPAN -e 'install(&quot;Crypt::SSLeay&quot;)'<br /> To test the connection...<br /> echo 'hello' | mail -s &quot;Test subject&quot; rt<br /> If you get a &quot;command died with status 1&quot; error message, the rt-mailgate script possibly doesn't have the execute bit set for the user/group under which postfix is running.<br /> chmod o+x /&amp;lt;path-to-mailgate&amp;gt;/rt-mailgate<br /> For more information on configuring your mail gateway, see [[ManualAdministration]]<br /> <br /> <br /> = Using Fetchmail/Getmail For Incoming Email =<br /> <br /> Fetchmail or Getmail can be used to fetch email from a inbox using IMAP or POP. An example configuration for Fetchmail can be seen below:<br /> set daemon 0<br /> <br /> # PID files are more useful for forking systemd services. But fetchmail will<br /> # always write one. Since the service runs fetchmail as the apache user,<br /> # www-data, we need to give fetchmail a path that it has write permission to.<br /> #set pidfile '/opt/rt4/var/run/fetchmail-rtir.pid'<br /> <br /> poll &quot;IP_OF_MAIL_SERVER&quot; proto imap port 993<br /> user &quot;rt@mycompany.com&quot; password &quot;password&quot;<br /> ssl<br /> folder 'Inbox'<br /> # Some IMAP servers generate an error like this:<br /> #<br /> # could not decode BASE64 challenge<br /> #<br /> # This might be because the server is configured to expect<br /> # certain authentication attempt types, first. fetchmail also<br /> # tries certain authentication methods first, but not password,<br /> # even with the 'password' keyword.<br /> #<br /> # The 'auth' keyword tells fetchmail to attempt the given<br /> # authentication type, first. That can eliminate initial<br /> # authentication failures, which might eliminate this error<br /> # messgae<br /> # auth password<br /> <br /> # IMAP supports flags on individual messages to indicate the<br /> # message status. The 'Seen' flag indicates that the message has<br /> # been read by a client. This could be a webmail client like Gmail<br /> # our Outlook, or fetchmail. The RT use case for fetchmail expects<br /> # that fetchmail will get all mail that hasn't been delivered to<br /> # RT, regardless of whether other clients have seen it. Without<br /> # this option, fetchmail will only download mail from an IMAP<br /> # server without the 'Seen' flag. This option tells fetchmail to<br /> # ignore 'Seen' flags and download all messages.<br /> # fetchall<br /> <br /> mda '/opt/rt4/bin/rt-mailgate --url https://rt.mycompany.com --queue &quot;support&quot; --action correspond'<br /> idle<br /> <br /> Lastly you will need a cronjob to pull your inbox periodically<br /> `*/1 * * * * root /usr/bin/getmail --fetchmailrc /opt/rt4/etc/fetchmailrc --quiet`<br /> ----<br /> Prev: [[ManualApacheConfig]] --- Up: [[UserManual]] --- Next: [[ManualBasicAdministration]]<br /> [[Category:RT User Manual]]</div>

Craigkai https://rt-wiki.bestpractical.com/index.php?title=ManualEmailConfig&diff=26859 2019-03-22T14:26:43Z

<p>Craigkai: </p> <hr /> <div>Prev: [[ManualApacheConfig]] --- Up: [[UserManual]] --- Next: [[ManualBasicAdministration]]<br /> <br /> ----<br /> <br /> = SETTING UP THE MAIL GATEWAY =<br /> <br /> The mail gateway is used to receive mail messages '''into''' an RT instance; outbound mail is usually just handed off to the local SMTP sending program, or a specified SMTP smarthost.<br /> <br /> The mail gateway requires the web UI to be set up and functional. If you intend to use SSL to secure your mail gateway, you need to make sure that lib-www-perl, a.k.a LWP, is built with SSL support.<br /> <br /> 1) Documentation for setting up the mail gateway can be found at:<br /> <br /> https://docs.bestpractical.com/rt/latest/rt-mailgate.html<br /> <br /> 2) You need to tell your Mail Transfer Agent (e.g. sendmail, postfix, or qmail) how to forward messages to RT's mail gateway. To do this, create an aliases in your system's mail aliases file. Here's an example, which routes mail to the mailbox [=[mailto:rt@example.com rt@example.com]] (and [=[mailto:rt-comment@example.com rt-comment@example.com]]) into new tickets in the RT queue named '''General'''. Note that the queue name is case-insensitive.<br /> <br /> Add the following lines to /etc/aliases (or your local equivalent such as /etc/mail/aliases):<br /> rt: &quot;|/opt/rt4/bin/rt-mailgate --queue general --action correspond --url http://localhost/rt&quot;<br /> rt-comment: &quot;|/opt/rt4/bin/rt-mailgate --queue general --action comment --url http://localhost/rt&quot;<br /> (Replace /opt/rt4 by your RT installation path and http://localhost/rt by the URL of your RT installation on your webserver)<br /> <br /> '''NOTE:''' When you add the above each alias entry should be all one line; make sure you include the quotes.<br /> <br /> '''NOTE:''' &lt;code&gt;qmail&lt;/code&gt; users should follow the [[QMail]] link to review caveats about &lt;code&gt;fastforward&lt;/code&gt; command aliases.<br /> <br /> Replace '''general''' with the name of your queue and '''rt''' (before the colon in the alias) with the email address you wish people to send their messages to. You might, for example, have messages to '''support''' go into the '''service''' queue, and '''abuse''' go into the '''ops''' queue. You can have more than one set of aliases point to the same queue, if, for example, you wanted mail to both '''abuse''' and '''security''' both go to the '''ops''' queue.<br /> <br /> The queue name may have spaces. &lt;code&gt;rt-mailgate&lt;/code&gt; works as well with them, but do not forget to escape these spaces by enclosing the queue name in single quote:<br /> my-queue: &quot;|/opt/rt4/bin/rt-mailgate --queue 'My Queue' --action correspond --url http://localhost/&quot;<br /> If you are using the default sendmail included in most redhat distro's you will most likely need to copy (cp) rt-mailgate to /etc/smrsh or create a symbolic link and change /opt/rt4/bin above to /etc/smrsh or sendmail will complain. These sendmails will only execute programs as alias targets which have been blessed by placing them in a special directory. This is not necessary for Exim or postfix.<br /> <br /> You'll choose from &quot;--action correspond&quot; and &quot;--action comment&quot; depending on whether the mail should be resent to the requestor. If you want the requestor to see it, choose correspond; if you want to keep it from the requestor, choose comment.<br /> <br /> The URL will be the URL for RT's web interface, such as http://issues.bestpractical.com/, [http://fsck.com/rt/ =]; whatever is the root of your RT install.<br /> <br /> 3) Stop and start your mail server, so it picks up your configuration changes. With sendmail or postfix (possibly others), you usually also need to type the command &quot;newaliases&quot; to get the server to recognize the new aliases. If this command is unrecognized, it's probably not in your default path; a common location is &quot;/usr/sbin/newaliases&quot;.<br /> <br /> You '''can''' have the mail gateway on your MX or some other server and have it talk to RT via HTTP. For more details, see [[InstallMailgateOnly]].<br /> <br /> To configure a mail transfer agent (postfix) to post tickets to RT4 on a separate server ....<br /> <br /> Add the following lines to /etc/aliases (or your local equivalent such as /etc/mail/aliases):<br /> rt: &quot;|/&amp;lt;path-to-mailgate&amp;gt;/rt-mailgate --queue general --action correspond --url http://&amp;lt;the-URL-of-the-RT-server&amp;gt;/&quot;<br /> rt-comment: &quot;|/&amp;lt;path-to-mailgate&amp;gt;/rt-mailgate --queue general --action comment --url http://&amp;lt;the-URL-of-the-RT-server&amp;gt;/&quot;<br /> The link to RT is now configured. However, the rt-mailgate script is a perl script which requires support. On a fresh [[SuSE]] 9.3 server install, the following was needed to provide the necessary perl libraries (someone with deeper knowledge may know of a more restrictive set of libraries, but these worked).<br /> <br /> #(install gcc and glibc, if necessary)<br /> perl -MCPAN -eshell (to configure CPAN)<br /> perl -MCPAN -e 'install(&quot;LWP&quot;)'<br /> perl -MCPAN -e 'install(&quot;Bundle::LWP&quot;)'<br /> <br /> If Using SSL, add:<br /> perl -MCPAN -e 'install(&quot;Crypt::SSLeay&quot;)'<br /> To test the connection...<br /> echo 'hello' | mail -s &quot;Test subject&quot; rt<br /> If you get a &quot;command died with status 1&quot; error message, the rt-mailgate script possibly doesn't have the execute bit set for the user/group under which postfix is running.<br /> chmod o+x /&amp;lt;path-to-mailgate&amp;gt;/rt-mailgate<br /> For more information on configuring your mail gateway, see [[ManualAdministration]]<br /> <br /> <br /> = Using Fetchmail/Getmail For Incoming Email =<br /> <br /> Fetchmail or Getmail can be used to fetch email from a inbox using IMAP or POP. An example configuration for Fetchmail can be seen below:<br /> set daemon 0<br /> <br /> # PID files are more useful for forking systemd services. But fetchmail will<br /> # always write one. Since the service runs fetchmail as the apache user,<br /> # www-data, we need to give fetchmail a path that it has write permission to.<br /> #set pidfile '/opt/rt4/var/run/fetchmail-rtir.pid'<br /> <br /> poll &quot;IP_OF_MAIL_SERVER&quot; proto imap port 993<br /> user &quot;rt@mycompany.com&quot; password &quot;password&quot;<br /> ssl<br /> folder 'Inbox'<br /> # Some IMAP servers generate an error like this:<br /> #<br /> # could not decode BASE64 challenge<br /> #<br /> # This might be because the server is configured to expect<br /> # certain authentication attempt types, first. fetchmail also<br /> # tries certain authentication methods first, but not password,<br /> # even with the 'password' keyword.<br /> #<br /> # The 'auth' keyword tells fetchmail to attempt the given<br /> # authentication type, first. That can eliminate initial<br /> # authentication failures, which might eliminate this error<br /> # messgae<br /> # auth password<br /> <br /> # IMAP supports flags on individual messages to indicate the<br /> # message status. The 'Seen' flag indicates that the message has<br /> # been read by a client. This could be a webmail client like Gmail<br /> # our Outlook, or fetchmail. The RT use case for fetchmail expects<br /> # that fetchmail will get all mail that hasn't been delivered to<br /> # RT, regardless of whether other clients have seen it. Without<br /> # this option, fetchmail will only download mail from an IMAP<br /> # server without the 'Seen' flag. This option tells fetchmail to<br /> # ignore 'Seen' flags and download all messages.<br /> # fetchall<br /> <br /> mda '/opt/rt4/bin/rt-mailgate --url https://rt.mycompany.com --queue &quot;support&quot; --action correspond'<br /> idle<br /> <br /> Lastly you will need a cronjob to pull your inbox periodically<br /> <br /> */1 * * * * root /usr/bin/getmail --fetchmailrc /opt/rt4/etc/fetchmailrc --quiet<br /> ----<br /> Prev: [[ManualApacheConfig]] --- Up: [[UserManual]] --- Next: [[ManualBasicAdministration]]<br /> [[Category:RT User Manual]]</div>

Craigkai https://rt-wiki.bestpractical.com/index.php?title=ManualEmailConfig&diff=26858 2019-03-22T14:24:58Z

<p>Craigkai: </p> <hr /> <div>Prev: [[ManualApacheConfig]] --- Up: [[UserManual]] --- Next: [[ManualBasicAdministration]]<br /> <br /> ----<br /> <br /> = SETTING UP THE MAIL GATEWAY =<br /> <br /> The mail gateway is used to receive mail messages '''into''' an RT instance; outbound mail is usually just handed off to the local SMTP sending program, or a specified SMTP smarthost.<br /> <br /> The mail gateway requires the web UI to be set up and functional. If you intend to use SSL to secure your mail gateway, you need to make sure that lib-www-perl, a.k.a LWP, is built with SSL support.<br /> <br /> 1) Documentation for setting up the mail gateway can be found at:<br /> <br /> https://docs.bestpractical.com/rt/latest/rt-mailgate.html<br /> <br /> 2) You need to tell your Mail Transfer Agent (e.g. sendmail, postfix, or qmail) how to forward messages to RT's mail gateway. To do this, create an aliases in your system's mail aliases file. Here's an example, which routes mail to the mailbox [=[mailto:rt@example.com rt@example.com]] (and [=[mailto:rt-comment@example.com rt-comment@example.com]]) into new tickets in the RT queue named '''General'''. Note that the queue name is case-insensitive.<br /> <br /> Add the following lines to /etc/aliases (or your local equivalent such as /etc/mail/aliases):<br /> rt: &quot;|/opt/rt4/bin/rt-mailgate --queue general --action correspond --url http://localhost/rt&quot;<br /> rt-comment: &quot;|/opt/rt4/bin/rt-mailgate --queue general --action comment --url http://localhost/rt&quot;<br /> (Replace /opt/rt4 by your RT installation path and http://localhost/rt by the URL of your RT installation on your webserver)<br /> <br /> '''NOTE:''' When you add the above each alias entry should be all one line; make sure you include the quotes.<br /> <br /> '''NOTE:''' &lt;code&gt;qmail&lt;/code&gt; users should follow the [[QMail]] link to review caveats about &lt;code&gt;fastforward&lt;/code&gt; command aliases.<br /> <br /> Replace '''general''' with the name of your queue and '''rt''' (before the colon in the alias) with the email address you wish people to send their messages to. You might, for example, have messages to '''support''' go into the '''service''' queue, and '''abuse''' go into the '''ops''' queue. You can have more than one set of aliases point to the same queue, if, for example, you wanted mail to both '''abuse''' and '''security''' both go to the '''ops''' queue.<br /> <br /> The queue name may have spaces. &lt;code&gt;rt-mailgate&lt;/code&gt; works as well with them, but do not forget to escape these spaces by enclosing the queue name in single quote:<br /> my-queue: &quot;|/opt/rt4/bin/rt-mailgate --queue 'My Queue' --action correspond --url http://localhost/&quot;<br /> If you are using the default sendmail included in most redhat distro's you will most likely need to copy (cp) rt-mailgate to /etc/smrsh or create a symbolic link and change /opt/rt4/bin above to /etc/smrsh or sendmail will complain. These sendmails will only execute programs as alias targets which have been blessed by placing them in a special directory. This is not necessary for Exim or postfix.<br /> <br /> You'll choose from &quot;--action correspond&quot; and &quot;--action comment&quot; depending on whether the mail should be resent to the requestor. If you want the requestor to see it, choose correspond; if you want to keep it from the requestor, choose comment.<br /> <br /> The URL will be the URL for RT's web interface, such as http://issues.bestpractical.com/, [http://fsck.com/rt/ =]; whatever is the root of your RT install.<br /> <br /> 3) Stop and start your mail server, so it picks up your configuration changes. With sendmail or postfix (possibly others), you usually also need to type the command &quot;newaliases&quot; to get the server to recognize the new aliases. If this command is unrecognized, it's probably not in your default path; a common location is &quot;/usr/sbin/newaliases&quot;.<br /> <br /> You '''can''' have the mail gateway on your MX or some other server and have it talk to RT via HTTP. For more details, see [[InstallMailgateOnly]].<br /> <br /> To configure a mail transfer agent (postfix) to post tickets to RT4 on a separate server ....<br /> <br /> Add the following lines to /etc/aliases (or your local equivalent such as /etc/mail/aliases):<br /> rt: &quot;|/&amp;lt;path-to-mailgate&amp;gt;/rt-mailgate --queue general --action correspond --url http://&amp;lt;the-URL-of-the-RT-server&amp;gt;/&quot;<br /> rt-comment: &quot;|/&amp;lt;path-to-mailgate&amp;gt;/rt-mailgate --queue general --action comment --url http://&amp;lt;the-URL-of-the-RT-server&amp;gt;/&quot;<br /> The link to RT is now configured. However, the rt-mailgate script is a perl script which requires support. On a fresh [[SuSE]] 9.3 server install, the following was needed to provide the necessary perl libraries (someone with deeper knowledge may know of a more restrictive set of libraries, but these worked).<br /> <br /> #(install gcc and glibc, if necessary)<br /> perl -MCPAN -eshell (to configure CPAN)<br /> perl -MCPAN -e 'install(&quot;LWP&quot;)'<br /> perl -MCPAN -e 'install(&quot;Bundle::LWP&quot;)'<br /> <br /> If Using SSL, add:<br /> perl -MCPAN -e 'install(&quot;Crypt::SSLeay&quot;)'<br /> To test the connection...<br /> echo 'hello' | mail -s &quot;Test subject&quot; rt<br /> If you get a &quot;command died with status 1&quot; error message, the rt-mailgate script possibly doesn't have the execute bit set for the user/group under which postfix is running.<br /> chmod o+x /&amp;lt;path-to-mailgate&amp;gt;/rt-mailgate<br /> For more information on configuring your mail gateway, see [[ManualAdministration]]<br /> <br /> <br /> = Using Fetchmail/Getmail For Incoming Email =<br /> <br /> Fetchmail or Getmail can be used to fetch email from a inbox using IMAP or POP. An example configuration for Fetchmail can be seen below:<br /> set daemon 0<br /> <br /> # PID files are more useful for forking systemd services. But fetchmail will<br /> # always write one. Since the service runs fetchmail as the apache user,<br /> # www-data, we need to give fetchmail a path that it has write permission to.<br /> #set pidfile '/opt/rt4/var/run/fetchmail-rtir.pid'<br /> <br /> poll &quot;IP_OF_MAIL_SERVER&quot; proto imap port 993<br /> user &quot;rt@mycompany.com&quot; password &quot;password&quot;<br /> ssl<br /> folder 'Inbox'<br /> # Some IMAP servers generate an error like this:<br /> #<br /> # could not decode BASE64 challenge<br /> #<br /> # This might be because the server is configured to expect<br /> # certain authentication attempt types, first. fetchmail also<br /> # tries certain authentication methods first, but not password,<br /> # even with the 'password' keyword.<br /> #<br /> # The 'auth' keyword tells fetchmail to attempt the given<br /> # authentication type, first. That can eliminate initial<br /> # authentication failures, which might eliminate this error<br /> # messgae<br /> # auth password<br /> <br /> # IMAP supports flags on individual messages to indicate the<br /> # message status. The 'Seen' flag indicates that the message has<br /> # been read by a client. This could be a webmail client like Gmail<br /> # our Outlook, or fetchmail. The RT use case for fetchmail expects<br /> # that fetchmail will get all mail that hasn't been delivered to<br /> # RT, regardless of whether other clients have seen it. Without<br /> # this option, fetchmail will only download mail from an IMAP<br /> # server without the 'Seen' flag. This option tells fetchmail to<br /> # ignore 'Seen' flags and download all messages.<br /> # fetchall<br /> <br /> mda '/opt/rt4/bin/rt-mailgate --url https://rt.mycompany.com --queue &quot;support&quot; --action correspond'<br /> idle<br /> ----<br /> Prev: [[ManualApacheConfig]] --- Up: [[UserManual]] --- Next: [[ManualBasicAdministration]]<br /> [[Category:RT User Manual]]</div>

Craigkai https://rt-wiki.bestpractical.com/index.php?title=ManualEmailConfig&diff=26857 2019-03-22T14:24:25Z

<p>Craigkai: </p> <hr /> <div>Prev: [[ManualApacheConfig]] --- Up: [[UserManual]] --- Next: [[ManualBasicAdministration]]<br /> <br /> ----<br /> <br /> = SETTING UP THE MAIL GATEWAY =<br /> <br /> The mail gateway is used to receive mail messages '''into''' an RT instance; outbound mail is usually just handed off to the local SMTP sending program, or a specified SMTP smarthost.<br /> <br /> The mail gateway requires the web UI to be set up and functional. If you intend to use SSL to secure your mail gateway, you need to make sure that lib-www-perl, a.k.a LWP, is built with SSL support.<br /> <br /> 1) Documentation for setting up the mail gateway can be found at:<br /> <br /> https://docs.bestpractical.com/rt/latest/rt-mailgate.html<br /> <br /> 2) You need to tell your Mail Transfer Agent (e.g. sendmail, postfix, or qmail) how to forward messages to RT's mail gateway. To do this, create an aliases in your system's mail aliases file. Here's an example, which routes mail to the mailbox [=[mailto:rt@example.com rt@example.com]] (and [=[mailto:rt-comment@example.com rt-comment@example.com]]) into new tickets in the RT queue named '''General'''. Note that the queue name is case-insensitive.<br /> <br /> Add the following lines to /etc/aliases (or your local equivalent such as /etc/mail/aliases):<br /> rt: &quot;|/opt/rt4/bin/rt-mailgate --queue general --action correspond --url http://localhost/rt&quot;<br /> rt-comment: &quot;|/opt/rt4/bin/rt-mailgate --queue general --action comment --url http://localhost/rt&quot;<br /> (Replace /opt/rt4 by your RT installation path and http://localhost/rt by the URL of your RT installation on your webserver)<br /> <br /> '''NOTE:''' When you add the above each alias entry should be all one line; make sure you include the quotes.<br /> <br /> '''NOTE:''' &lt;code&gt;qmail&lt;/code&gt; users should follow the [[QMail]] link to review caveats about &lt;code&gt;fastforward&lt;/code&gt; command aliases.<br /> <br /> Replace '''general''' with the name of your queue and '''rt''' (before the colon in the alias) with the email address you wish people to send their messages to. You might, for example, have messages to '''support''' go into the '''service''' queue, and '''abuse''' go into the '''ops''' queue. You can have more than one set of aliases point to the same queue, if, for example, you wanted mail to both '''abuse''' and '''security''' both go to the '''ops''' queue.<br /> <br /> The queue name may have spaces. &lt;code&gt;rt-mailgate&lt;/code&gt; works as well with them, but do not forget to escape these spaces by enclosing the queue name in single quote:<br /> my-queue: &quot;|/opt/rt4/bin/rt-mailgate --queue 'My Queue' --action correspond --url http://localhost/&quot;<br /> If you are using the default sendmail included in most redhat distro's you will most likely need to copy (cp) rt-mailgate to /etc/smrsh or create a symbolic link and change /opt/rt4/bin above to /etc/smrsh or sendmail will complain. These sendmails will only execute programs as alias targets which have been blessed by placing them in a special directory. This is not necessary for Exim or postfix.<br /> <br /> You'll choose from &quot;--action correspond&quot; and &quot;--action comment&quot; depending on whether the mail should be resent to the requestor. If you want the requestor to see it, choose correspond; if you want to keep it from the requestor, choose comment.<br /> <br /> The URL will be the URL for RT's web interface, such as http://issues.bestpractical.com/, [http://fsck.com/rt/ =]; whatever is the root of your RT install.<br /> <br /> 3) Stop and start your mail server, so it picks up your configuration changes. With sendmail or postfix (possibly others), you usually also need to type the command &quot;newaliases&quot; to get the server to recognize the new aliases. If this command is unrecognized, it's probably not in your default path; a common location is &quot;/usr/sbin/newaliases&quot;.<br /> <br /> You '''can''' have the mail gateway on your MX or some other server and have it talk to RT via HTTP. For more details, see [[InstallMailgateOnly]].<br /> <br /> To configure a mail transfer agent (postfix) to post tickets to RT4 on a separate server ....<br /> <br /> Add the following lines to /etc/aliases (or your local equivalent such as /etc/mail/aliases):<br /> rt: &quot;|/&amp;lt;path-to-mailgate&amp;gt;/rt-mailgate --queue general --action correspond --url http://&amp;lt;the-URL-of-the-RT-server&amp;gt;/&quot;<br /> rt-comment: &quot;|/&amp;lt;path-to-mailgate&amp;gt;/rt-mailgate --queue general --action comment --url http://&amp;lt;the-URL-of-the-RT-server&amp;gt;/&quot;<br /> The link to RT is now configured. However, the rt-mailgate script is a perl script which requires support. On a fresh [[SuSE]] 9.3 server install, the following was needed to provide the necessary perl libraries (someone with deeper knowledge may know of a more restrictive set of libraries, but these worked).<br /> <br /> #(install gcc and glibc, if necessary)<br /> perl -MCPAN -eshell (to configure CPAN)<br /> perl -MCPAN -e 'install(&quot;LWP&quot;)'<br /> perl -MCPAN -e 'install(&quot;Bundle::LWP&quot;)'<br /> <br /> If Using SSL, add:<br /> perl -MCPAN -e 'install(&quot;Crypt::SSLeay&quot;)'<br /> To test the connection...<br /> echo 'hello' | mail -s &quot;Test subject&quot; rt<br /> If you get a &quot;command died with status 1&quot; error message, the rt-mailgate script possibly doesn't have the execute bit set for the user/group under which postfix is running.<br /> chmod o+x /&amp;lt;path-to-mailgate&amp;gt;/rt-mailgate<br /> For more information on configuring your mail gateway, see [[ManualAdministration]]<br /> <br /> <br /> = Using Fetchmail/Getmail For Incoming Email =<br /> <br /> Fetchmail or Getmail can be used to fetch email from a inbox using IMAP or POP. An example configuration for Fetchmail can be seen below:<br /> set daemon 0<br /> <br /> # PID files are more useful for forking systemd services. But fetchmail will<br /> # always write one. Since the service runs fetchmail as the apache user,<br /> # www-data, we need to give fetchmail a path that it has write permission to.<br /> #set pidfile '/opt/rt4/var/run/fetchmail-rtir.pid'<br /> <br /> poll &quot;IP_OF_MAIL_SERVER&quot; proto imap port 993<br /> user &quot;rt@mycompany.com&quot; password &quot;password&quot;<br /> ssl<br /> folder 'Inbox'<br /> # Some IMAP servers generate an error like this:<br /> #<br /> # could not decode BASE64 challenge<br /> #<br /> # This might be because the server is configured to expect<br /> # certain authentication attempt types, first. fetchmail also<br /> # tries certain authentication methods first, but not password,<br /> # even with the 'password' keyword.<br /> #<br /> # The 'auth' keyword tells fetchmail to attempt the given<br /> # authentication type, first. That can eliminate initial<br /> # authentication failures, which might eliminate this error<br /> # messgae<br /> # auth password<br /> <br /> # IMAP supports flags on individual messages to indicate the<br /> # message status. The 'Seen' flag indicates that the message has<br /> # been read by a client. This could be a webmail client like Gmail<br /> # our Outlook, or fetchmail. The RT use case for fetchmail expects<br /> # that fetchmail will get all mail that hasn't been delivered to<br /> # RT, regardless of whether other clients have seen it. Without<br /> # this option, fetchmail will only download mail from an IMAP<br /> # server without the 'Seen' flag. This option tells fetchmail to<br /> # ignore 'Seen' flags and download all messages.<br /> # fetchall<br /> <br /> mda '/opt/rt4/bin/rt-mailgate --url https://rt.mycompany.com --queue &quot;support&quot; --action correspond'<br /> idle<br /> ----<br /> <br /> Prev: [[ManualApacheConfig]] --- Up: [[UserManual]] --- Next: [[ManualBasicAdministration]]<br /> [[Category:RT User Manual]]</div>

Craigkai https://rt-wiki.bestpractical.com/index.php?title=ManualApacheConfig&diff=26845 2019-03-21T17:04:34Z

<p>Craigkai: </p> <hr /> <div>Prev: [[ManualInstallation]] --- Up: [[UserManual]] --- Next: [[ManualEmailConfig]]<br /> <br /> See official docs: https://docs.bestpractical.com/rt/latest/web_deployment.html<br /> {{OutdatedInstallGuide}}<br /> <br /> '''NOTE: The information on this page is outdated. It is superseded by the documentation in docs/web_deployment.pod in the base RT tarball.'''<br /> <br /> Apache + mod_perl2 guide updated for RT4<br /> <br /> ----<br /> <br /> = SETTING UP THE WEB INTERFACE =<br /> <br /> == Choosing a web handler ==<br /> <br /> A note of caution: Do not use symbolic links in the Apache conf directory structures.<br /> <br /> RT's web interface is written using HTML::Mason, which works with the mod_perl embedded perl interpreter within Apache httpd. Alternatively, support for the [[FastCGI]] interface is also provided as 'bin/mason_handler.fcgi'. Setting up either of these can be fairly intricate; don't get discouraged if it takes you some time to get this right -- though it's not nearly as difficult as it used to be.<br /> <br /> === FastCGI vs. mod_perl ===<br /> <br /> Both work fine. Each have some strong and weak points.<br /> <br /> You cannot run multiple instances of RT under one server with mod_perl, even in multiple vhosts; since mod_perl embeds a perl process in apache, but only one, whichever configuration is loaded last will clobber all other ones. If you need to run more than once instance of RT on the same server, you will need to run them with fastcgi.<br /> <br /> If you have something already installed then use it. Otherwise here are a few notes to help choose:<br /> <br /> * apache 1.x is for those who are already using it and don't want to upgrade<br /> * use whatever version of apache is installed on your system<br /> * have no experience with [[FastCGI]] or mod_perl then just throw a coin to choose between -- or pick whichever one is provided as a package by your distribution<br /> * a few warnings about mod_perl:<br /> ** If your system has only mod_perl 1.9x (development version before mod_perl 2 release) and you don't know how to or don't want to build mod_perl from scratch then just ignore it and '''DON'T TRY TO USE''' RT with mod_perl 1.9x, jump to [[FastCGI]] (this is unlikely to be the case on new installs, as mod_perl 2 has been out for some number of years now).<br /> ** If you have apache 2.x then you need mod_perl 2.x as well. mod_perl 1.x just won't work with apache 2.x<br /> ** If you have apache 1.x then you need mod_perl 1.xx where xx is not 9x<br /> <br /> The [[PerformanceTuning]] page has some info about the [[FastCGI]] vs. mod_perl. Read the Myths section.<br /> <br /> === Other options ===<br /> <br /> Other options as well exist, like speedycgi, [[FastCGI]]+nginx, [[FastCGI]]+lighttpd... But Apache+[[FastCGI]] and Apache+mod_perl these are two major variants perl developers pay attention to as they are most common. If it's your first install then make your life easier and choose a common solution. Later you may find time to experiment with others.<br /> <br /> === Checking dependencies ===<br /> <br /> Once you've made your choice then test dependencies again to make sure everything is there for web environment of choice:<br /> <br /> : &amp;#35; without arguments to get list of options<br /> : make testdeps<br /> <br /> You can choose web handler during ./configure step using its option. Check ./configure --help<br /> <br /> == Choosing web layout ==<br /> <br /> Before you start your install, you have to decide which URL will be the base for your RT instance. Will it be [[ManualInstallation|http://rt.example.com/]] or do you prefer [[ManualInstallation|http://www.example.com/rt/]] ? RT can't get this info from apache config or preconfigure your server for any possible setup, so it's your task to decide and configure both ends.<br /> <br /> If you decide to use rt.example.com, and you're sharing the webserver with other domains using [[VirtualHosts]], then you'll have additional configuration to perform.<br /> <br /> == SiteConfig ==<br /> <br /> RT config has several options to define web server [[URLs]] layout [[WebBaseURL]], [[WebPath]] and [[WebURL]]. The first two are the most important things you must configure:<br /> <br /> * [[WebBaseURL]] - it's the base URL for the server that serves RT web interface, it should contain scheme (http or https), server name and port (if it's not standard value 80), for example [[ManualInstallation|http://rt.example.com]], [[ManualInstallation|https://rt.example.com]] and [[ManualInstallation|http://www.example.com]] are valid and sane values. Note that there is '''no trailing slash''' and '''it's root URL of the server'''.<br /> * [[WebPath]] - it's URL path relative to the root of the server (WebBaseURL option) that has leading slash and no trailing slash, for example &lt;code&gt;/rt&lt;/code&gt;, &lt;code&gt;/helpdesk&lt;/code&gt; or empty value.<br /> <br /> We discussed these in the [[ManualInstallation]] section, previously, but here are some examples to recap:<br /> <br /> * You want [[ManualInstallation|http://rt.example.com/]] as RT main page then WebBaseURL should be [[ManualInstallation|http://rt.example.com]] and WebPath should be empty.<br /> * You want [[ManualInstallation|http://www.example.com/helpdesk/]] as RT main page then WebBaseURL should be [[ManualInstallation|http://www.example.com]] and WebPath should be &lt;code&gt;/helpdesk&lt;/code&gt;.<br /> <br /> That's all: once you've chosen layout and configured RT's config you can configure apache server.<br /> <br /> == Configuring Apache ==<br /> <br /> You've made several choices above and now you're ready to configure your server. Usually configuration files are in /etc/apache* or /etc/httpd<br /> <br /> You'll need to add a few lines to your httpd.conf telling it to use RT's web interface and how to handle it. Search below for a variant matching your choices. If you can not find it here then search on other pages and move here example or ask on [[MailingLists]], but don't forget mention that you came from this page and it has no example for your case, so people can update it.<br /> <br /> Note: RT will not load without a valid virtual host name<br /> <br /> === apache2 + mod_perl2 and RT4 on [[ManualInstallation|http://rt.example.com/]] ===<br /> <br /> &lt;pre&gt;<br /> &amp;lt;VirtualHost rt.example.com&amp;gt;<br /> # Optional apache logs for RT<br /> # ErrorLog /opt/rt4/var/log/apache2.error<br /> # TransferLog /opt/rt4/var/log/apache2.access<br /> # LogLevel debug<br /> <br /> AddDefaultCharset UTF-8<br /> DocumentRoot &quot;/opt/rt4/share/html&quot;<br /> <br /> &amp;lt;Location /&amp;gt;<br /> Order allow,deny<br /> Allow from all<br /> <br /> SetHandler modperl<br /> PerlResponseHandler Plack::Handler::Apache2<br /> PerlSetVar psgi_app /opt/rt4/sbin/rt-server<br /> &amp;lt;/Location&amp;gt;<br /> &amp;lt;Perl&amp;gt;<br /> use Plack::Handler::Apache2;<br /> Plack::Handler::Apache2-&gt;preload(&quot;/opt/rt4/sbin/rt-server&quot;);<br /> &amp;lt;/Perl&amp;gt;<br /> &amp;lt;/VirtualHost&amp;gt;<br /> &lt;/pre&gt;<br /> <br /> === apache2 + mod_perl2 and RT on [[ManualInstallation|http://rt.example.com/]] ===<br /> Note: This only works for RT4<br /> <br /> &lt;pre&gt;# ip based virtual host<br /> Listen ip_of_the_rt.example.com:80<br /> &amp;lt;VirtualHost ip_of_the_rt.example.com:80&amp;gt;<br /> ServerName rt.example.com<br /> ServerAdmin Email.Address@example.com<br /> <br /> <br /> DocumentRoot /opt/rt4/share/html<br /> <br /> AddDefaultCharset UTF-8<br /> PerlRequire /opt/rt4/bin/webmux.pl<br /> <br /> <br /> &amp;lt;Directory /opt/rt4/share/html&amp;gt;<br /> Order allow,deny<br /> Allow from all<br /> <br /> SetHandler perl-script<br /> PerlResponseHandler RT::Mason<br /> &amp;lt;/Directory&amp;gt;<br /> &amp;lt;/VirtualHost&amp;gt;<br /> &lt;/pre&gt;<br /> <br /> === apache2 + mod_perl2 and RT on [[ManualInstallation|http://www.example.com/rt/]] ===<br /> <br /> Listen ip_of_the_www.example.com:80<br /> &lt;pre&gt;<br /> &amp;lt;VirtualHost ip_of_the_www.example.com:80&amp;gt;<br /> ServerName www.example.com<br /> ServerAdmin Email.Address@example.com<br /> <br /> # config for your main content<br /> DocumentRoot /www/www.example.com<br /> &amp;lt;Directory /www/www.example.com&amp;gt;<br /> # here and in other places goes config<br /> # of your main host<br /> &amp;lt;/Directory&amp;gt;<br /> <br /> # as RT is out of document root then we want alias<br /> # and should define directory access<br /> Alias /rt/ /opt/rt4/share/html/<br /> &amp;lt;Directory /opt/rt4/share/html/&amp;gt;<br /> Order allow,deny<br /> Allow from all<br /> &amp;lt;/Directory&amp;gt;<br /> <br /> PerlRequire /opt/rt4/bin/webmux.pl<br /> &amp;lt;Location /rt/&amp;gt;<br /> AddDefaultCharset UTF-8<br /> SetHandler perl-script<br /> PerlHandler RT::Mason<br /> &amp;lt;/Location&amp;gt;<br /> &amp;lt;/VirtualHost&amp;gt;<br /> &lt;/pre&gt;<br /> <br /> === Some historical notes people left, some make sense, some are wrong, for refactoring ===<br /> <br /> '''NOTE:''' If you are running Apache 2, the recommended configuration directive is:<br /> <br /> RedirectMatch permanent (.*)/$ [[ManualInstallation|http://example.com$1/index.html]]<br /> <br /> in your [[VirtualHost]] section<br /> <br /> This line will take all requests of form &quot;[http://example.com/foo/ http://example.com/foo/&quot;] into &quot;[http://example.com/foo/index.html http://example.com/foo/index.html&quot;]<br /> <br /> '''NOTE:''' If &quot;your.ip.address&quot; above is the same as your webserver's IP and you're not planning to assign a unique IP address or alias (CNAME) for RT, you should realize that the above [[VirtualHost]] configuration works when RT is the only content provided at the root of the webserver. If your webserver has existing content or you plan to add content later, you'll probably want to place RT in a directory other than the root of the webserver. If you choose to use &quot;[http://fsck.com/rt/ http://fsck.com/rt/&quot;], you'll want to modify the [[VirtualHost]] configuration as follows:<br /> <br /> Comment with '#' or remove the following line:<br /> &lt;pre&gt;<br /> DocumentRoot /opt/rt4/share/html<br /> &lt;/pre&gt;<br /> and add in its place:<br /> &lt;pre&gt;<br /> Alias /rt &quot;/opt/rt4/share/html&quot;<br /> &lt;/pre&gt;<br /> Lastly, change the Location path from:<br /> &lt;pre&gt;<br /> &amp;lt;Location /&amp;gt;<br /> &lt;/pre&gt;<br /> to<br /> &lt;pre&gt;<br /> &amp;lt;Location /rt&amp;gt;<br /> &lt;/pre&gt;<br /> That gives a configuration similar to<br /> &lt;pre&gt;<br /> Alias /rt &quot;/opt/rt4/share/html&quot;<br /> PerlModule Apache::DBI<br /> PerlRequire /opt/rt4/bin/webmux.pl<br /> &amp;lt;Directory /opt/rt4/share/html&amp;gt;<br /> AllowOverride All<br /> Options ExecCGI FollowSymLinks<br /> &amp;lt;IfModule mod_access.c&amp;gt;<br /> Order allow,deny<br /> Allow from all<br /> &amp;lt;/IfModule&amp;gt;<br /> &amp;lt;/Directory&amp;gt;<br /> <br /> &amp;lt;Location /rt&amp;gt;<br /> RewriteEngine On<br /> RedirectMatch permanent (.*)/$ $1/index.html<br /> AddDefaultCharset UTF-8<br /> SetHandler perl-script<br /> PerlHandler RT::Mason<br /> &amp;lt;/Location&amp;gt;<br /> &lt;/pre&gt;<br /> You will also need to modify the $[[WebPath]] variable in etc/[[RT SiteConfig|RT_SiteConfig]].pm in your RT installation directory. For the above example you would use:<br /> &lt;pre&gt;<br /> $WebPath = &quot;/rt&quot;;<br /> &lt;/pre&gt;<br /> Remember that $[[WebPath]] requires a leading / but no trailing /. $[[WebPath]], your Apache alias, and your Apache Location should all contain the same string.<br /> <br /> == Testing ==<br /> <br /> Next, stop Apache. This will vary by system but might look something like this:<br /> <br /> cd /etc/init.d<br /> ./httpd stop<br /> <br /> or, if your distro includes it:<br /> <br /> apachectl stop<br /> <br /> Try to use a browser to go to your RT server's website. You shouldn't be able to do it. Restart Apache:<br /> <br /> ./httpd start<br /> <br /> Now, you should be able to go to your RT URL and get the login screen.<br /> <br /> Once this works, you may move on to setting up your email gateway.<br /> <br /> == Troubleshooting ==<br /> <br /> '''Note:''' Read the entry in the [[FAQ]] about [[MaxRequestsPerChild]].<br /> <br /> === client denied by server configuration ===<br /> <br /> If you receive a &quot;client denied by server configuration: /opt/rt4/share/html&quot; in your Apache error.log or a &quot;403 Forbidden&quot; error then also add the following to your [[VirtualHost]] section:<br /> &lt;pre&gt;<br /> &amp;lt;Directory &quot;/opt/rt4/share/html&quot;&amp;gt;<br /> Order allow,deny<br /> Allow from all<br /> &amp;lt;/Directory&amp;gt;<br /> &lt;/pre&gt;<br /> (the above hint for 403/denied was found on [[ManualInstallation|http://wiki.bestpractical.com/view/FastCGIConfiguration]])<br /> <br /> === Can't locate Apache/DBI.pm in ... ===<br /> <br /> At this point you can either delete &quot;[[PerlModule]] Apache::DBI&quot; from apache config, or figure out how to install it -- [[SuSE]], for example, provides it as a package to match their Apache2 package.<br /> <br /> This feature is *optional*. Read ApacheConfig for more info about &quot;mod_perl and caching connections to the DB&quot;.<br /> <br /> ----<br /> <br /> Prev: [[ManualInstallation]] --- Up: [[UserManual]] --- Next: [[ManualEmailConfig]]<br /> [[Category:RT User Manual]]</div>

Craigkai https://rt-wiki.bestpractical.com/index.php?title=ManualApacheConfig&diff=26844 2019-03-21T17:04:23Z

<p>Craigkai: </p> <hr /> <div>Prev: [[ManualInstallation]] --- Up: [[UserManual]] --- Next: [[ManualEmailConfig]]<br /> <br /> See official docs: https://docs.bestpractical.com/rt/latest/web_deployment.html<br /> <br /> {{OutdatedInstallGuide}}<br /> <br /> '''NOTE: The information on this page is outdated. It is superseded by the documentation in docs/web_deployment.pod in the base RT tarball.'''<br /> <br /> Apache + mod_perl2 guide updated for RT4<br /> <br /> ----<br /> <br /> = SETTING UP THE WEB INTERFACE =<br /> <br /> == Choosing a web handler ==<br /> <br /> A note of caution: Do not use symbolic links in the Apache conf directory structures.<br /> <br /> RT's web interface is written using HTML::Mason, which works with the mod_perl embedded perl interpreter within Apache httpd. Alternatively, support for the [[FastCGI]] interface is also provided as 'bin/mason_handler.fcgi'. Setting up either of these can be fairly intricate; don't get discouraged if it takes you some time to get this right -- though it's not nearly as difficult as it used to be.<br /> <br /> === FastCGI vs. mod_perl ===<br /> <br /> Both work fine. Each have some strong and weak points.<br /> <br /> You cannot run multiple instances of RT under one server with mod_perl, even in multiple vhosts; since mod_perl embeds a perl process in apache, but only one, whichever configuration is loaded last will clobber all other ones. If you need to run more than once instance of RT on the same server, you will need to run them with fastcgi.<br /> <br /> If you have something already installed then use it. Otherwise here are a few notes to help choose:<br /> <br /> * apache 1.x is for those who are already using it and don't want to upgrade<br /> * use whatever version of apache is installed on your system<br /> * have no experience with [[FastCGI]] or mod_perl then just throw a coin to choose between -- or pick whichever one is provided as a package by your distribution<br /> * a few warnings about mod_perl:<br /> ** If your system has only mod_perl 1.9x (development version before mod_perl 2 release) and you don't know how to or don't want to build mod_perl from scratch then just ignore it and '''DON'T TRY TO USE''' RT with mod_perl 1.9x, jump to [[FastCGI]] (this is unlikely to be the case on new installs, as mod_perl 2 has been out for some number of years now).<br /> ** If you have apache 2.x then you need mod_perl 2.x as well. mod_perl 1.x just won't work with apache 2.x<br /> ** If you have apache 1.x then you need mod_perl 1.xx where xx is not 9x<br /> <br /> The [[PerformanceTuning]] page has some info about the [[FastCGI]] vs. mod_perl. Read the Myths section.<br /> <br /> === Other options ===<br /> <br /> Other options as well exist, like speedycgi, [[FastCGI]]+nginx, [[FastCGI]]+lighttpd... But Apache+[[FastCGI]] and Apache+mod_perl these are two major variants perl developers pay attention to as they are most common. If it's your first install then make your life easier and choose a common solution. Later you may find time to experiment with others.<br /> <br /> === Checking dependencies ===<br /> <br /> Once you've made your choice then test dependencies again to make sure everything is there for web environment of choice:<br /> <br /> : &amp;#35; without arguments to get list of options<br /> : make testdeps<br /> <br /> You can choose web handler during ./configure step using its option. Check ./configure --help<br /> <br /> == Choosing web layout ==<br /> <br /> Before you start your install, you have to decide which URL will be the base for your RT instance. Will it be [[ManualInstallation|http://rt.example.com/]] or do you prefer [[ManualInstallation|http://www.example.com/rt/]] ? RT can't get this info from apache config or preconfigure your server for any possible setup, so it's your task to decide and configure both ends.<br /> <br /> If you decide to use rt.example.com, and you're sharing the webserver with other domains using [[VirtualHosts]], then you'll have additional configuration to perform.<br /> <br /> == SiteConfig ==<br /> <br /> RT config has several options to define web server [[URLs]] layout [[WebBaseURL]], [[WebPath]] and [[WebURL]]. The first two are the most important things you must configure:<br /> <br /> * [[WebBaseURL]] - it's the base URL for the server that serves RT web interface, it should contain scheme (http or https), server name and port (if it's not standard value 80), for example [[ManualInstallation|http://rt.example.com]], [[ManualInstallation|https://rt.example.com]] and [[ManualInstallation|http://www.example.com]] are valid and sane values. Note that there is '''no trailing slash''' and '''it's root URL of the server'''.<br /> * [[WebPath]] - it's URL path relative to the root of the server (WebBaseURL option) that has leading slash and no trailing slash, for example &lt;code&gt;/rt&lt;/code&gt;, &lt;code&gt;/helpdesk&lt;/code&gt; or empty value.<br /> <br /> We discussed these in the [[ManualInstallation]] section, previously, but here are some examples to recap:<br /> <br /> * You want [[ManualInstallation|http://rt.example.com/]] as RT main page then WebBaseURL should be [[ManualInstallation|http://rt.example.com]] and WebPath should be empty.<br /> * You want [[ManualInstallation|http://www.example.com/helpdesk/]] as RT main page then WebBaseURL should be [[ManualInstallation|http://www.example.com]] and WebPath should be &lt;code&gt;/helpdesk&lt;/code&gt;.<br /> <br /> That's all: once you've chosen layout and configured RT's config you can configure apache server.<br /> <br /> == Configuring Apache ==<br /> <br /> You've made several choices above and now you're ready to configure your server. Usually configuration files are in /etc/apache* or /etc/httpd<br /> <br /> You'll need to add a few lines to your httpd.conf telling it to use RT's web interface and how to handle it. Search below for a variant matching your choices. If you can not find it here then search on other pages and move here example or ask on [[MailingLists]], but don't forget mention that you came from this page and it has no example for your case, so people can update it.<br /> <br /> Note: RT will not load without a valid virtual host name<br /> <br /> === apache2 + mod_perl2 and RT4 on [[ManualInstallation|http://rt.example.com/]] ===<br /> <br /> &lt;pre&gt;<br /> &amp;lt;VirtualHost rt.example.com&amp;gt;<br /> # Optional apache logs for RT<br /> # ErrorLog /opt/rt4/var/log/apache2.error<br /> # TransferLog /opt/rt4/var/log/apache2.access<br /> # LogLevel debug<br /> <br /> AddDefaultCharset UTF-8<br /> DocumentRoot &quot;/opt/rt4/share/html&quot;<br /> <br /> &amp;lt;Location /&amp;gt;<br /> Order allow,deny<br /> Allow from all<br /> <br /> SetHandler modperl<br /> PerlResponseHandler Plack::Handler::Apache2<br /> PerlSetVar psgi_app /opt/rt4/sbin/rt-server<br /> &amp;lt;/Location&amp;gt;<br /> &amp;lt;Perl&amp;gt;<br /> use Plack::Handler::Apache2;<br /> Plack::Handler::Apache2-&gt;preload(&quot;/opt/rt4/sbin/rt-server&quot;);<br /> &amp;lt;/Perl&amp;gt;<br /> &amp;lt;/VirtualHost&amp;gt;<br /> &lt;/pre&gt;<br /> <br /> === apache2 + mod_perl2 and RT on [[ManualInstallation|http://rt.example.com/]] ===<br /> Note: This only works for RT4<br /> <br /> &lt;pre&gt;# ip based virtual host<br /> Listen ip_of_the_rt.example.com:80<br /> &amp;lt;VirtualHost ip_of_the_rt.example.com:80&amp;gt;<br /> ServerName rt.example.com<br /> ServerAdmin Email.Address@example.com<br /> <br /> <br /> DocumentRoot /opt/rt4/share/html<br /> <br /> AddDefaultCharset UTF-8<br /> PerlRequire /opt/rt4/bin/webmux.pl<br /> <br /> <br /> &amp;lt;Directory /opt/rt4/share/html&amp;gt;<br /> Order allow,deny<br /> Allow from all<br /> <br /> SetHandler perl-script<br /> PerlResponseHandler RT::Mason<br /> &amp;lt;/Directory&amp;gt;<br /> &amp;lt;/VirtualHost&amp;gt;<br /> &lt;/pre&gt;<br /> <br /> === apache2 + mod_perl2 and RT on [[ManualInstallation|http://www.example.com/rt/]] ===<br /> <br /> Listen ip_of_the_www.example.com:80<br /> &lt;pre&gt;<br /> &amp;lt;VirtualHost ip_of_the_www.example.com:80&amp;gt;<br /> ServerName www.example.com<br /> ServerAdmin Email.Address@example.com<br /> <br /> # config for your main content<br /> DocumentRoot /www/www.example.com<br /> &amp;lt;Directory /www/www.example.com&amp;gt;<br /> # here and in other places goes config<br /> # of your main host<br /> &amp;lt;/Directory&amp;gt;<br /> <br /> # as RT is out of document root then we want alias<br /> # and should define directory access<br /> Alias /rt/ /opt/rt4/share/html/<br /> &amp;lt;Directory /opt/rt4/share/html/&amp;gt;<br /> Order allow,deny<br /> Allow from all<br /> &amp;lt;/Directory&amp;gt;<br /> <br /> PerlRequire /opt/rt4/bin/webmux.pl<br /> &amp;lt;Location /rt/&amp;gt;<br /> AddDefaultCharset UTF-8<br /> SetHandler perl-script<br /> PerlHandler RT::Mason<br /> &amp;lt;/Location&amp;gt;<br /> &amp;lt;/VirtualHost&amp;gt;<br /> &lt;/pre&gt;<br /> <br /> === Some historical notes people left, some make sense, some are wrong, for refactoring ===<br /> <br /> '''NOTE:''' If you are running Apache 2, the recommended configuration directive is:<br /> <br /> RedirectMatch permanent (.*)/$ [[ManualInstallation|http://example.com$1/index.html]]<br /> <br /> in your [[VirtualHost]] section<br /> <br /> This line will take all requests of form &quot;[http://example.com/foo/ http://example.com/foo/&quot;] into &quot;[http://example.com/foo/index.html http://example.com/foo/index.html&quot;]<br /> <br /> '''NOTE:''' If &quot;your.ip.address&quot; above is the same as your webserver's IP and you're not planning to assign a unique IP address or alias (CNAME) for RT, you should realize that the above [[VirtualHost]] configuration works when RT is the only content provided at the root of the webserver. If your webserver has existing content or you plan to add content later, you'll probably want to place RT in a directory other than the root of the webserver. If you choose to use &quot;[http://fsck.com/rt/ http://fsck.com/rt/&quot;], you'll want to modify the [[VirtualHost]] configuration as follows:<br /> <br /> Comment with '#' or remove the following line:<br /> &lt;pre&gt;<br /> DocumentRoot /opt/rt4/share/html<br /> &lt;/pre&gt;<br /> and add in its place:<br /> &lt;pre&gt;<br /> Alias /rt &quot;/opt/rt4/share/html&quot;<br /> &lt;/pre&gt;<br /> Lastly, change the Location path from:<br /> &lt;pre&gt;<br /> &amp;lt;Location /&amp;gt;<br /> &lt;/pre&gt;<br /> to<br /> &lt;pre&gt;<br /> &amp;lt;Location /rt&amp;gt;<br /> &lt;/pre&gt;<br /> That gives a configuration similar to<br /> &lt;pre&gt;<br /> Alias /rt &quot;/opt/rt4/share/html&quot;<br /> PerlModule Apache::DBI<br /> PerlRequire /opt/rt4/bin/webmux.pl<br /> &amp;lt;Directory /opt/rt4/share/html&amp;gt;<br /> AllowOverride All<br /> Options ExecCGI FollowSymLinks<br /> &amp;lt;IfModule mod_access.c&amp;gt;<br /> Order allow,deny<br /> Allow from all<br /> &amp;lt;/IfModule&amp;gt;<br /> &amp;lt;/Directory&amp;gt;<br /> <br /> &amp;lt;Location /rt&amp;gt;<br /> RewriteEngine On<br /> RedirectMatch permanent (.*)/$ $1/index.html<br /> AddDefaultCharset UTF-8<br /> SetHandler perl-script<br /> PerlHandler RT::Mason<br /> &amp;lt;/Location&amp;gt;<br /> &lt;/pre&gt;<br /> You will also need to modify the $[[WebPath]] variable in etc/[[RT SiteConfig|RT_SiteConfig]].pm in your RT installation directory. For the above example you would use:<br /> &lt;pre&gt;<br /> $WebPath = &quot;/rt&quot;;<br /> &lt;/pre&gt;<br /> Remember that $[[WebPath]] requires a leading / but no trailing /. $[[WebPath]], your Apache alias, and your Apache Location should all contain the same string.<br /> <br /> == Testing ==<br /> <br /> Next, stop Apache. This will vary by system but might look something like this:<br /> <br /> cd /etc/init.d<br /> ./httpd stop<br /> <br /> or, if your distro includes it:<br /> <br /> apachectl stop<br /> <br /> Try to use a browser to go to your RT server's website. You shouldn't be able to do it. Restart Apache:<br /> <br /> ./httpd start<br /> <br /> Now, you should be able to go to your RT URL and get the login screen.<br /> <br /> Once this works, you may move on to setting up your email gateway.<br /> <br /> == Troubleshooting ==<br /> <br /> '''Note:''' Read the entry in the [[FAQ]] about [[MaxRequestsPerChild]].<br /> <br /> === client denied by server configuration ===<br /> <br /> If you receive a &quot;client denied by server configuration: /opt/rt4/share/html&quot; in your Apache error.log or a &quot;403 Forbidden&quot; error then also add the following to your [[VirtualHost]] section:<br /> &lt;pre&gt;<br /> &amp;lt;Directory &quot;/opt/rt4/share/html&quot;&amp;gt;<br /> Order allow,deny<br /> Allow from all<br /> &amp;lt;/Directory&amp;gt;<br /> &lt;/pre&gt;<br /> (the above hint for 403/denied was found on [[ManualInstallation|http://wiki.bestpractical.com/view/FastCGIConfiguration]])<br /> <br /> === Can't locate Apache/DBI.pm in ... ===<br /> <br /> At this point you can either delete &quot;[[PerlModule]] Apache::DBI&quot; from apache config, or figure out how to install it -- [[SuSE]], for example, provides it as a package to match their Apache2 package.<br /> <br /> This feature is *optional*. Read ApacheConfig for more info about &quot;mod_perl and caching connections to the DB&quot;.<br /> <br /> ----<br /> <br /> Prev: [[ManualInstallation]] --- Up: [[UserManual]] --- Next: [[ManualEmailConfig]]<br /> [[Category:RT User Manual]]</div>

Craigkai https://rt-wiki.bestpractical.com/index.php?title=ManualApacheConfig&diff=26843 2019-03-21T16:34:10Z

<p>Craigkai: </p> <hr /> <div>Prev: [[ManualInstallation]] --- Up: [[UserManual]] --- Next: [[ManualEmailConfig]]<br /> <br /> {{OutdatedInstallGuide}}<br /> <br /> '''NOTE: The information on this page is outdated. It is superseded by the documentation in docs/web_deployment.pod in the base RT tarball.'''<br /> <br /> Apache + mod_perl2 guide updated for RT4<br /> <br /> ----<br /> <br /> = SETTING UP THE WEB INTERFACE =<br /> <br /> == Choosing a web handler ==<br /> <br /> A note of caution: Do not use symbolic links in the Apache conf directory structures.<br /> <br /> RT's web interface is written using HTML::Mason, which works with the mod_perl embedded perl interpreter within Apache httpd. Alternatively, support for the [[FastCGI]] interface is also provided as 'bin/mason_handler.fcgi'. Setting up either of these can be fairly intricate; don't get discouraged if it takes you some time to get this right -- though it's not nearly as difficult as it used to be.<br /> <br /> === FastCGI vs. mod_perl ===<br /> <br /> Both work fine. Each have some strong and weak points.<br /> <br /> You cannot run multiple instances of RT under one server with mod_perl, even in multiple vhosts; since mod_perl embeds a perl process in apache, but only one, whichever configuration is loaded last will clobber all other ones. If you need to run more than once instance of RT on the same server, you will need to run them with fastcgi.<br /> <br /> If you have something already installed then use it. Otherwise here are a few notes to help choose:<br /> <br /> * apache 1.x is for those who are already using it and don't want to upgrade<br /> * use whatever version of apache is installed on your system<br /> * have no experience with [[FastCGI]] or mod_perl then just throw a coin to choose between -- or pick whichever one is provided as a package by your distribution<br /> * a few warnings about mod_perl:<br /> ** If your system has only mod_perl 1.9x (development version before mod_perl 2 release) and you don't know how to or don't want to build mod_perl from scratch then just ignore it and '''DON'T TRY TO USE''' RT with mod_perl 1.9x, jump to [[FastCGI]] (this is unlikely to be the case on new installs, as mod_perl 2 has been out for some number of years now).<br /> ** If you have apache 2.x then you need mod_perl 2.x as well. mod_perl 1.x just won't work with apache 2.x<br /> ** If you have apache 1.x then you need mod_perl 1.xx where xx is not 9x<br /> <br /> The [[PerformanceTuning]] page has some info about the [[FastCGI]] vs. mod_perl. Read the Myths section.<br /> <br /> === Other options ===<br /> <br /> Other options as well exist, like speedycgi, [[FastCGI]]+nginx, [[FastCGI]]+lighttpd... But Apache+[[FastCGI]] and Apache+mod_perl these are two major variants perl developers pay attention to as they are most common. If it's your first install then make your life easier and choose a common solution. Later you may find time to experiment with others.<br /> <br /> === Checking dependencies ===<br /> <br /> Once you've made your choice then test dependencies again to make sure everything is there for web environment of choice:<br /> <br /> : &amp;#35; without arguments to get list of options<br /> : make testdeps<br /> <br /> You can choose web handler during ./configure step using its option. Check ./configure --help<br /> <br /> == Choosing web layout ==<br /> <br /> Before you start your install, you have to decide which URL will be the base for your RT instance. Will it be [[ManualInstallation|http://rt.example.com/]] or do you prefer [[ManualInstallation|http://www.example.com/rt/]] ? RT can't get this info from apache config or preconfigure your server for any possible setup, so it's your task to decide and configure both ends.<br /> <br /> If you decide to use rt.example.com, and you're sharing the webserver with other domains using [[VirtualHosts]], then you'll have additional configuration to perform.<br /> <br /> == SiteConfig ==<br /> <br /> RT config has several options to define web server [[URLs]] layout [[WebBaseURL]], [[WebPath]] and [[WebURL]]. The first two are the most important things you must configure:<br /> <br /> * [[WebBaseURL]] - it's the base URL for the server that serves RT web interface, it should contain scheme (http or https), server name and port (if it's not standard value 80), for example [[ManualInstallation|http://rt.example.com]], [[ManualInstallation|https://rt.example.com]] and [[ManualInstallation|http://www.example.com]] are valid and sane values. Note that there is '''no trailing slash''' and '''it's root URL of the server'''.<br /> * [[WebPath]] - it's URL path relative to the root of the server (WebBaseURL option) that has leading slash and no trailing slash, for example &lt;code&gt;/rt&lt;/code&gt;, &lt;code&gt;/helpdesk&lt;/code&gt; or empty value.<br /> <br /> We discussed these in the [[ManualInstallation]] section, previously, but here are some examples to recap:<br /> <br /> * You want [[ManualInstallation|http://rt.example.com/]] as RT main page then WebBaseURL should be [[ManualInstallation|http://rt.example.com]] and WebPath should be empty.<br /> * You want [[ManualInstallation|http://www.example.com/helpdesk/]] as RT main page then WebBaseURL should be [[ManualInstallation|http://www.example.com]] and WebPath should be &lt;code&gt;/helpdesk&lt;/code&gt;.<br /> <br /> That's all: once you've chosen layout and configured RT's config you can configure apache server.<br /> <br /> == Configuring Apache ==<br /> <br /> You've made several choices above and now you're ready to configure your server. Usually configuration files are in /etc/apache* or /etc/httpd<br /> <br /> You'll need to add a few lines to your httpd.conf telling it to use RT's web interface and how to handle it. Search below for a variant matching your choices. If you can not find it here then search on other pages and move here example or ask on [[MailingLists]], but don't forget mention that you came from this page and it has no example for your case, so people can update it.<br /> <br /> Note: RT will not load without a valid virtual host name<br /> <br /> === apache2 + mod_perl2 and RT4 on [[ManualInstallation|http://rt.example.com/]] ===<br /> <br /> &lt;pre&gt;<br /> &amp;lt;VirtualHost rt.example.com&amp;gt;<br /> # Optional apache logs for RT<br /> # ErrorLog /opt/rt4/var/log/apache2.error<br /> # TransferLog /opt/rt4/var/log/apache2.access<br /> # LogLevel debug<br /> <br /> AddDefaultCharset UTF-8<br /> DocumentRoot &quot;/opt/rt4/share/html&quot;<br /> <br /> &amp;lt;Location /&amp;gt;<br /> Order allow,deny<br /> Allow from all<br /> <br /> SetHandler modperl<br /> PerlResponseHandler Plack::Handler::Apache2<br /> PerlSetVar psgi_app /opt/rt4/sbin/rt-server<br /> &amp;lt;/Location&amp;gt;<br /> &amp;lt;Perl&amp;gt;<br /> use Plack::Handler::Apache2;<br /> Plack::Handler::Apache2-&gt;preload(&quot;/opt/rt4/sbin/rt-server&quot;);<br /> &amp;lt;/Perl&amp;gt;<br /> &amp;lt;/VirtualHost&amp;gt;<br /> &lt;/pre&gt;<br /> <br /> === apache2 + mod_perl2 and RT on [[ManualInstallation|http://rt.example.com/]] ===<br /> Note: This only works for RT4<br /> <br /> &lt;pre&gt;# ip based virtual host<br /> Listen ip_of_the_rt.example.com:80<br /> &amp;lt;VirtualHost ip_of_the_rt.example.com:80&amp;gt;<br /> ServerName rt.example.com<br /> ServerAdmin Email.Address@example.com<br /> <br /> <br /> DocumentRoot /opt/rt4/share/html<br /> <br /> AddDefaultCharset UTF-8<br /> PerlRequire /opt/rt4/bin/webmux.pl<br /> <br /> <br /> &amp;lt;Directory /opt/rt4/share/html&amp;gt;<br /> Order allow,deny<br /> Allow from all<br /> <br /> SetHandler perl-script<br /> PerlResponseHandler RT::Mason<br /> &amp;lt;/Directory&amp;gt;<br /> &amp;lt;/VirtualHost&amp;gt;<br /> &lt;/pre&gt;<br /> <br /> === apache2 + mod_perl2 and RT on [[ManualInstallation|http://www.example.com/rt/]] ===<br /> <br /> Listen ip_of_the_www.example.com:80<br /> &lt;pre&gt;<br /> &amp;lt;VirtualHost ip_of_the_www.example.com:80&amp;gt;<br /> ServerName www.example.com<br /> ServerAdmin Email.Address@example.com<br /> <br /> # config for your main content<br /> DocumentRoot /www/www.example.com<br /> &amp;lt;Directory /www/www.example.com&amp;gt;<br /> # here and in other places goes config<br /> # of your main host<br /> &amp;lt;/Directory&amp;gt;<br /> <br /> # as RT is out of document root then we want alias<br /> # and should define directory access<br /> Alias /rt/ /opt/rt4/share/html/<br /> &amp;lt;Directory /opt/rt4/share/html/&amp;gt;<br /> Order allow,deny<br /> Allow from all<br /> &amp;lt;/Directory&amp;gt;<br /> <br /> PerlRequire /opt/rt4/bin/webmux.pl<br /> &amp;lt;Location /rt/&amp;gt;<br /> AddDefaultCharset UTF-8<br /> SetHandler perl-script<br /> PerlHandler RT::Mason<br /> &amp;lt;/Location&amp;gt;<br /> &amp;lt;/VirtualHost&amp;gt;<br /> &lt;/pre&gt;<br /> <br /> === Some historical notes people left, some make sense, some are wrong, for refactoring ===<br /> <br /> '''NOTE:''' If you are running Apache 2, the recommended configuration directive is:<br /> <br /> RedirectMatch permanent (.*)/$ [[ManualInstallation|http://example.com$1/index.html]]<br /> <br /> in your [[VirtualHost]] section<br /> <br /> This line will take all requests of form &quot;[http://example.com/foo/ http://example.com/foo/&quot;] into &quot;[http://example.com/foo/index.html http://example.com/foo/index.html&quot;]<br /> <br /> '''NOTE:''' If &quot;your.ip.address&quot; above is the same as your webserver's IP and you're not planning to assign a unique IP address or alias (CNAME) for RT, you should realize that the above [[VirtualHost]] configuration works when RT is the only content provided at the root of the webserver. If your webserver has existing content or you plan to add content later, you'll probably want to place RT in a directory other than the root of the webserver. If you choose to use &quot;[http://fsck.com/rt/ http://fsck.com/rt/&quot;], you'll want to modify the [[VirtualHost]] configuration as follows:<br /> <br /> Comment with '#' or remove the following line:<br /> &lt;pre&gt;<br /> DocumentRoot /opt/rt4/share/html<br /> &lt;/pre&gt;<br /> and add in its place:<br /> &lt;pre&gt;<br /> Alias /rt &quot;/opt/rt4/share/html&quot;<br /> &lt;/pre&gt;<br /> Lastly, change the Location path from:<br /> &lt;pre&gt;<br /> &amp;lt;Location /&amp;gt;<br /> &lt;/pre&gt;<br /> to<br /> &lt;pre&gt;<br /> &amp;lt;Location /rt&amp;gt;<br /> &lt;/pre&gt;<br /> That gives a configuration similar to<br /> &lt;pre&gt;<br /> Alias /rt &quot;/opt/rt4/share/html&quot;<br /> PerlModule Apache::DBI<br /> PerlRequire /opt/rt4/bin/webmux.pl<br /> &amp;lt;Directory /opt/rt4/share/html&amp;gt;<br /> AllowOverride All<br /> Options ExecCGI FollowSymLinks<br /> &amp;lt;IfModule mod_access.c&amp;gt;<br /> Order allow,deny<br /> Allow from all<br /> &amp;lt;/IfModule&amp;gt;<br /> &amp;lt;/Directory&amp;gt;<br /> <br /> &amp;lt;Location /rt&amp;gt;<br /> RewriteEngine On<br /> RedirectMatch permanent (.*)/$ $1/index.html<br /> AddDefaultCharset UTF-8<br /> SetHandler perl-script<br /> PerlHandler RT::Mason<br /> &amp;lt;/Location&amp;gt;<br /> &lt;/pre&gt;<br /> You will also need to modify the $[[WebPath]] variable in etc/[[RT SiteConfig|RT_SiteConfig]].pm in your RT installation directory. For the above example you would use:<br /> &lt;pre&gt;<br /> $WebPath = &quot;/rt&quot;;<br /> &lt;/pre&gt;<br /> Remember that $[[WebPath]] requires a leading / but no trailing /. $[[WebPath]], your Apache alias, and your Apache Location should all contain the same string.<br /> <br /> == Testing ==<br /> <br /> Next, stop Apache. This will vary by system but might look something like this:<br /> <br /> cd /etc/init.d<br /> ./httpd stop<br /> <br /> or, if your distro includes it:<br /> <br /> apachectl stop<br /> <br /> Try to use a browser to go to your RT server's website. You shouldn't be able to do it. Restart Apache:<br /> <br /> ./httpd start<br /> <br /> Now, you should be able to go to your RT URL and get the login screen.<br /> <br /> Once this works, you may move on to setting up your email gateway.<br /> <br /> == Troubleshooting ==<br /> <br /> '''Note:''' Read the entry in the [[FAQ]] about [[MaxRequestsPerChild]].<br /> <br /> === client denied by server configuration ===<br /> <br /> If you receive a &quot;client denied by server configuration: /opt/rt4/share/html&quot; in your Apache error.log or a &quot;403 Forbidden&quot; error then also add the following to your [[VirtualHost]] section:<br /> &lt;pre&gt;<br /> &amp;lt;Directory &quot;/opt/rt4/share/html&quot;&amp;gt;<br /> Order allow,deny<br /> Allow from all<br /> &amp;lt;/Directory&amp;gt;<br /> &lt;/pre&gt;<br /> (the above hint for 403/denied was found on [[ManualInstallation|http://wiki.bestpractical.com/view/FastCGIConfiguration]])<br /> <br /> === Can't locate Apache/DBI.pm in ... ===<br /> <br /> At this point you can either delete &quot;[[PerlModule]] Apache::DBI&quot; from apache config, or figure out how to install it -- [[SuSE]], for example, provides it as a package to match their Apache2 package.<br /> <br /> This feature is *optional*. Read ApacheConfig for more info about &quot;mod_perl and caching connections to the DB&quot;.<br /> <br /> ----<br /> <br /> Prev: [[ManualInstallation]] --- Up: [[UserManual]] --- Next: [[ManualEmailConfig]]<br /> [[Category:RT User Manual]]</div>

Craigkai https://rt-wiki.bestpractical.com/index.php?title=ManualScrips&diff=26832 2019-03-21T12:51:04Z

<p>Craigkai: </p> <hr /> <div>Prev: [[ManualRights]] --- Up: [[UserManual]] --- Next: [[ManualApprovals]]<br /> <br /> = Appendix 3 =<br /> <br /> == Scrips ==<br /> <br /> Official docs can be found here: https://docs.bestpractical.com/rt/latest/customizing/scrip_conditions_and_action.html<br /> <br /> A scrip performs some action when some conditions are met. Many actions use a template. You can read a scrip as a sentence like: When &amp;lt;condition&amp;gt;, do &amp;lt;action&amp;gt; with &amp;lt;template&amp;gt;. When creating a Scrip, it is helpful to make the &quot;Description&quot; field a user-friendly phrase such as &quot;Send replies to Requestor and Cc users&quot; because users see that description in '''bold''' on the ticket update composition page.<br /> <br /> === Table 1: Conditions ===<br /> <br /> {| border=&quot;1&quot;<br /> |- valign=&quot;top&quot;<br /> | Condition Name<br /> | What it means<br /> | Possible Template<br /> |- valign=&quot;top&quot;<br /> | User Defined<br /> | A user-defined condition (should be described below)<br /> | User-defined templates<br /> |- valign=&quot;top&quot;<br /> | On Create<br /> | When a new ticket is created<br /> | Global template: Autoreply<br /> |- valign=&quot;top&quot;<br /> | On Transaction<br /> | When a ticket is updated or changed in any way<br /> | Global template: Transaction<br /> |- valign=&quot;top&quot;<br /> | On Reply<br /> | When a watcher replies to a ticket<br /> | Global template: Reply or Global template: Admin Reply<br /> |- valign=&quot;top&quot;<br /> | On Comment<br /> | When a watcher comments on a ticket (privately)<br /> | Global template: Admin Comment<br /> |- valign=&quot;top&quot;<br /> | On Correspond<br /> | When a watcher corresponds to (replies to) a ticket (publicly)<br /> | Global template: Blank<br /> |- valign=&quot;top&quot;<br /> | On Status<br /> | When the ticket's status changes<br /> | Global template: Status Changed<br /> |- valign=&quot;top&quot;<br /> | On Owner Change<br /> | When the ticket gets a new owner<br /> | Global template: Transaction<br /> |- valign=&quot;top&quot;<br /> | On Queue Change<br /> | When the ticket is put in a different queue<br /> | Global template: Transaction<br /> |- valign=&quot;top&quot;<br /> | On Resolve<br /> | When the ticket is resolved (completed)<br /> | Global template: Resolved<br /> |}<br /> <br /> Note: don't create a global scrip using the &quot;On Create&quot; condition and the &quot;Create Ticket&quot; scrip action. This will create a loop.<br /> <br /> User Defined Condition:<br /> $self-&gt;ScripObj RT::Scrip,<br /> $self-&gt;TicketObj RT::Ticket,<br /> $self-&gt;TransactionObj RT::Transaction,<br /> === Table 2: Actions ===<br /> <br /> {| border=&quot;1&quot;<br /> |- valign=&quot;top&quot;<br /> | Action Name<br /> | What It Means<br /> |- valign=&quot;top&quot;<br /> | Auto Reply to Requestors<br /> | Email an Auto Reply template to the ticket's requestor<br /> |- valign=&quot;top&quot;<br /> | Notify Requestors<br /> | Email the ticket's requestor<br /> |- valign=&quot;top&quot;<br /> | Notify Owner As Comment<br /> | Email the ticket's owner. &quot;As Comment&quot; means the return address of the email is RT's comment address and all responses will be posted as comments not visible to the requestor.<br /> |- valign=&quot;top&quot;<br /> | Notify Owner<br /> | Email the ticket's owner.<br /> |- valign=&quot;top&quot;<br /> | Notify Admin Ccs As Comment<br /> | Email the ticket's Admin Ccs. &quot;As Comment&quot; means the return address of the email is RT's comment address and all responses will be posted as comments not visible to the requestor.<br /> |- valign=&quot;top&quot;<br /> | Notify Admin Ccs<br /> | Email the ticket's Admin Ccs.<br /> |- valign=&quot;top&quot;<br /> | Notify Requestors And Ccs As Comment<br /> | Email the ticket's requestor and Ccs. &quot;As Comment&quot; means the return address of the email is RT's comment address and all responses will be posted as comments not visible to the requestor.<br /> |- valign=&quot;top&quot;<br /> | Notify Requestors And Ccs<br /> | Email the ticket's requestor and Ccs.<br /> |- valign=&quot;top&quot;<br /> | Notify All Watchers As Comment<br /> | Email the ticket's requestor, owner, Ccs, and Admin Ccs. &quot;As Comment&quot; means the return address of the email is RT's comment address and all responses will be posted as comments not visible to the requestor.<br /> |- valign=&quot;top&quot;<br /> | Notify All Watchers<br /> | Email the ticket's requestor, owner, Ccs, and Admin Ccs.<br /> |- valign=&quot;top&quot;<br /> | Notify Other Recipients As Comment<br /> | Email the addresses in the Cc: and Bcc: fields of a ticket's reply or comment. &quot;As Comment&quot; means the return address of the email is RT's comment address and all responses will be posted as comments not visible to the requestor.<br /> |- valign=&quot;top&quot;<br /> | Notify Other Recipients<br /> | Email the addresses in the Cc: and Bcc: fields of a ticket's reply or comment<br /> |- valign=&quot;top&quot;<br /> | Open Tickets<br /> | Automatically opens a stalled, resolved, or rejected ticket when anyone replies to it; automatically opens new tickets when anyone except the requestor replies to it. Does not apply to tickets that are already open.<br /> |}<br /> <br /> Custom Action Commit/Preparation Code:<br /> $self-&gt;ScripActionObj RT::ScripAction,<br /> $self-&gt;ScripObj RT::Scrip,<br /> $self-&gt;TemplateObj RT::Template,<br /> $self-&gt;TicketObj RT::Ticket,<br /> $self-&gt;TransactionObj RT::Transaction,<br /> Prev: [[ManualRights]] --- Up: [[UserManual]] --- Next: [[ManualApache]]<br /> [[Category:RT User Manual]]</div>

Craigkai https://rt-wiki.bestpractical.com/index.php?title=ManualScrips&diff=26831 2019-03-21T12:50:14Z

<p>Craigkai: </p> <hr /> <div>Prev: [[ManualRights]] --- Up: [[UserManual]] --- Next: [[ManualApprovals]]<br /> <br /> = Appendix 3 =<br /> <br /> == Scrips ==<br /> <br /> Official docs can be found here: https://docs.bestpractical.com/rt/4.4.4/customizing/scrip_conditions_and_action.html<br /> <br /> A scrip performs some action when some conditions are met. Many actions use a template. You can read a scrip as a sentence like: When &amp;lt;condition&amp;gt;, do &amp;lt;action&amp;gt; with &amp;lt;template&amp;gt;. When creating a Scrip, it is helpful to make the &quot;Description&quot; field a user-friendly phrase such as &quot;Send replies to Requestor and Cc users&quot; because users see that description in '''bold''' on the ticket update composition page.<br /> <br /> === Table 1: Conditions ===<br /> <br /> {| border=&quot;1&quot;<br /> |- valign=&quot;top&quot;<br /> | Condition Name<br /> | What it means<br /> | Possible Template<br /> |- valign=&quot;top&quot;<br /> | User Defined<br /> | A user-defined condition (should be described below)<br /> | User-defined templates<br /> |- valign=&quot;top&quot;<br /> | On Create<br /> | When a new ticket is created<br /> | Global template: Autoreply<br /> |- valign=&quot;top&quot;<br /> | On Transaction<br /> | When a ticket is updated or changed in any way<br /> | Global template: Transaction<br /> |- valign=&quot;top&quot;<br /> | On Reply<br /> | When a watcher replies to a ticket<br /> | Global template: Reply or Global template: Admin Reply<br /> |- valign=&quot;top&quot;<br /> | On Comment<br /> | When a watcher comments on a ticket (privately)<br /> | Global template: Admin Comment<br /> |- valign=&quot;top&quot;<br /> | On Correspond<br /> | When a watcher corresponds to (replies to) a ticket (publicly)<br /> | Global template: Blank<br /> |- valign=&quot;top&quot;<br /> | On Status<br /> | When the ticket's status changes<br /> | Global template: Status Changed<br /> |- valign=&quot;top&quot;<br /> | On Owner Change<br /> | When the ticket gets a new owner<br /> | Global template: Transaction<br /> |- valign=&quot;top&quot;<br /> | On Queue Change<br /> | When the ticket is put in a different queue<br /> | Global template: Transaction<br /> |- valign=&quot;top&quot;<br /> | On Resolve<br /> | When the ticket is resolved (completed)<br /> | Global template: Resolved<br /> |}<br /> <br /> Note: don't create a global scrip using the &quot;On Create&quot; condition and the &quot;Create Ticket&quot; scrip action. This will create a loop.<br /> <br /> User Defined Condition:<br /> $self-&gt;ScripObj RT::Scrip,<br /> $self-&gt;TicketObj RT::Ticket,<br /> $self-&gt;TransactionObj RT::Transaction,<br /> === Table 2: Actions ===<br /> <br /> {| border=&quot;1&quot;<br /> |- valign=&quot;top&quot;<br /> | Action Name<br /> | What It Means<br /> |- valign=&quot;top&quot;<br /> | Auto Reply to Requestors<br /> | Email an Auto Reply template to the ticket's requestor<br /> |- valign=&quot;top&quot;<br /> | Notify Requestors<br /> | Email the ticket's requestor<br /> |- valign=&quot;top&quot;<br /> | Notify Owner As Comment<br /> | Email the ticket's owner. &quot;As Comment&quot; means the return address of the email is RT's comment address and all responses will be posted as comments not visible to the requestor.<br /> |- valign=&quot;top&quot;<br /> | Notify Owner<br /> | Email the ticket's owner.<br /> |- valign=&quot;top&quot;<br /> | Notify Admin Ccs As Comment<br /> | Email the ticket's Admin Ccs. &quot;As Comment&quot; means the return address of the email is RT's comment address and all responses will be posted as comments not visible to the requestor.<br /> |- valign=&quot;top&quot;<br /> | Notify Admin Ccs<br /> | Email the ticket's Admin Ccs.<br /> |- valign=&quot;top&quot;<br /> | Notify Requestors And Ccs As Comment<br /> | Email the ticket's requestor and Ccs. &quot;As Comment&quot; means the return address of the email is RT's comment address and all responses will be posted as comments not visible to the requestor.<br /> |- valign=&quot;top&quot;<br /> | Notify Requestors And Ccs<br /> | Email the ticket's requestor and Ccs.<br /> |- valign=&quot;top&quot;<br /> | Notify All Watchers As Comment<br /> | Email the ticket's requestor, owner, Ccs, and Admin Ccs. &quot;As Comment&quot; means the return address of the email is RT's comment address and all responses will be posted as comments not visible to the requestor.<br /> |- valign=&quot;top&quot;<br /> | Notify All Watchers<br /> | Email the ticket's requestor, owner, Ccs, and Admin Ccs.<br /> |- valign=&quot;top&quot;<br /> | Notify Other Recipients As Comment<br /> | Email the addresses in the Cc: and Bcc: fields of a ticket's reply or comment. &quot;As Comment&quot; means the return address of the email is RT's comment address and all responses will be posted as comments not visible to the requestor.<br /> |- valign=&quot;top&quot;<br /> | Notify Other Recipients<br /> | Email the addresses in the Cc: and Bcc: fields of a ticket's reply or comment<br /> |- valign=&quot;top&quot;<br /> | Open Tickets<br /> | Automatically opens a stalled, resolved, or rejected ticket when anyone replies to it; automatically opens new tickets when anyone except the requestor replies to it. Does not apply to tickets that are already open.<br /> |}<br /> <br /> Custom Action Commit/Preparation Code:<br /> $self-&gt;ScripActionObj RT::ScripAction,<br /> $self-&gt;ScripObj RT::Scrip,<br /> $self-&gt;TemplateObj RT::Template,<br /> $self-&gt;TicketObj RT::Ticket,<br /> $self-&gt;TransactionObj RT::Transaction,<br /> Prev: [[ManualRights]] --- Up: [[UserManual]] --- Next: [[ManualApache]]<br /> [[Category:RT User Manual]]</div>

Craigkai