[Rt-commit] rt branch, 5.0/update-readme, created. rt-5.0.0alpha1-215-g92423216c5
Jim Brandt
jbrandt at bestpractical.com
Mon May 4 13:50:18 EDT 2020
The branch, 5.0/update-readme has been created
at 92423216c5345412157da329be766308400afe76 (commit)
- Log -----------------------------------------------------------------
commit 0e0e496580cd1592b9811f5d6db35d8bedcc0238
Author: Jim Brandt <jbrandt at bestpractical.com>
Date: Mon May 4 13:42:20 2020 -0400
Update README for RT 5.0
diff --git a/README b/README
index 1e765a36ee..06cf14d67c 100644
--- a/README
+++ b/README
@@ -22,14 +22,15 @@ o A supported SQL database
Currently supported: MySQL 5.7 with InnoDB support
MariaDB 10.2 or later with InnoDB support
- Postgres 9.0 or later
- Oracle 11g or later
+ Postgres 9.5 or later
+ Oracle 12c or later
SQLite 3.0 or later; for testing only, no
upgrade path guaranteed
-o Apache version 1.3.x or 2.x (http://httpd.apache.org)
- with FastCGI -- (http://www.fastcgi.com)
+o Apache version 2.x (https://httpd.apache.org)
+ with mod_fcgid -- (https://httpd.apache.org/mod_fcgid/mod/mod_fcgid.html)
or mod_perl -- (http://perl.apache.org)
+ or nginx -- (https://nginx.org/)
or another webserver with FastCGI support
RT's FastCGI handler needs to access RT's configuration file.
@@ -67,10 +68,10 @@ GENERAL INSTALLATION
If you are upgrading from a previous version of RT, please review
the upgrade notes for the appropriate versions, which can be found
- in docs/UPGRADING-* If you are coming from 4.2.x to 4.4.x you should
- review both the UPGRADING-4.2 and UPGRADING-4.4 files. Similarly, if
- you were coming from 4.0.x, you would want to review the UPGRADING-4.0,
- UPGRADING-4.2 and UPGRADING-4.4 documents.
+ in docs/UPGRADING-* If you are coming from 4.4.x to 5.0.x you should
+ review both the UPGRADING-4.4 and UPGRADING-5.0 files. Similarly, if
+ you were coming from 4.2.x, you would want to review the UPGRADING-4.2,
+ UPGRADING-4.4 and UPGRADING-5.0 documents.
Any upgrade steps given in version-specific UPGRADING files should
be run after the rest of the steps below; however, please read the
@@ -93,12 +94,17 @@ GENERAL INSTALLATION
make fixdeps
Some modules require user input or environment variables to install
- correctly, so it may be necessary to install them manually.
+ correctly, so it may be necessary to install them manually. Some modules
+ also require external source libraries, so you may need to install
+ additional packages.
If you are having trouble installing GD, refer to "Installing GD libraries"
in docs/charts.pod. Ticket relationship graphing requires the graphviz
library which you should install using your distribution's package manager.
+ See docs/rt_perl.pod for additional information about installing perl and
+ RT's dependencies.
+
5) Check to make sure everything was installed properly.
make testdeps
@@ -160,7 +166,7 @@ GENERAL INSTALLATION
You should back up your database before running this command.
When you run it, you will be prompted for your previous version of
- RT (such as 4.2.12) so that the appropriate set of database
+ RT (such as 4.4.1) so that the appropriate set of database
upgrades can be applied.
If 'make upgrade-database' completes without error, your upgrade
@@ -168,6 +174,12 @@ GENERAL INSTALLATION
supplied in version-specific UPGRADING documentation. You should
then restart your webserver.
+ Depending on the size and composition of your database, some upgrade
+ steps may run for a long time. You may also need extra disk space or
+ other resources while running upgrade steps. It's a good idea to run
+ through the upgrade steps on a test server so you know what to expect
+ before running on your production system.
+
7) Configure the web server, as described in docs/web_deployment.pod,
and the email gateway, as described below.
@@ -176,12 +188,6 @@ GENERAL INSTALLATION
Pass: password
Not changing the root password from the default is a SECURITY risk!
- Once you've set up the web interface, consider setting up automatic
- logout for inactive sessions. For more information about how to do
- that, run:
-
- perldoc /opt/rt5/sbin/rt-clean-sessions
-
8) Set up users, groups, queues, scrips and access control.
Until you do this, RT will not be able to send or receive email, nor
@@ -190,19 +196,27 @@ GENERAL INSTALLATION
9) Set up automated recurring tasks (cronjobs):
+ Depending on your configuration, RT stores sessions in the database
+ or on the file system. In either case, sessions are only needed until
+ a user logs out, so old sessions should be cleaned up with this utility:
+
+ perldoc /opt/rt5/sbin/rt-clean-sessions
+
To generate email digest messages, you must arrange for the provided
utility to be run once daily, and once weekly. You may also want
- to arrange for the rt-email-dashboards utility to be run hourly. If
- you choose to use the external storage feature, that must process
- new attachments on a regular basis.
+ to arrange for the rt-email-dashboards utility to be run hourly.
If your task scheduler is cron, you can configure it by
adding the following lines as /etc/cron.d/rt:
+ 0 0 * * * root /opt/rt5/sbin/rt-clean-sessions
0 0 * * * root /opt/rt5/sbin/rt-email-digest -m daily
0 0 * * 0 root /opt/rt5/sbin/rt-email-digest -m weekly
0 * * * * root /opt/rt5/sbin/rt-email-dashboards
- 0 0 * * * root /opt/rt5/sbin/rt-externalize-attachments
+
+ Other optional features like full text search indexes, external
+ attachments, etc., may also have recurring jobs to schedule in cron.
+ Follow the documentation for these features when you enable them.
10) Configure the RT email gateway. To let email flow to your RT
server, you need to add a few lines of configuration to your mail
@@ -236,7 +250,8 @@ GETTING HELP
If RT is mission-critical for you or if you use it heavily, we recommend
that you purchase a commercial support contract. Details on support
contracts are available at http://www.bestpractical.com or by writing to
-<sales at bestpractical.com>.
+<sales at bestpractical.com>. We also offer managed hosting plans if you
+prefer to have someone else manage the RT server.
If you're interested in having RT extended or customized or would like
more information about commercial support options, please send email to
@@ -281,6 +296,9 @@ bugs. In the exceedingly unlikely event that you hit a bug in RT, please
report it! We'd love to hear about problems you have with RT, so we can
fix them. To report a bug, send email to <rt-bugs at bestpractical.com>.
+Note that this sends email to our public RT instance. Do not include any
+information in your email that you don't want shown publicly, including
+contact information in your email signature.
# BEGIN BPS TAGGED BLOCK {{{
#
commit 92423216c5345412157da329be766308400afe76
Author: Jim Brandt <jbrandt at bestpractical.com>
Date: Mon May 4 13:45:42 2020 -0400
Remove references to end-of-life versions and software
FastCGI is no longer supported and Apache 2.2 has reached
end of life:
https://httpd.apache.org/#apache-httpd-22-end-of-life-2018-01-01
diff --git a/docs/web_deployment.pod b/docs/web_deployment.pod
index 010e4af34f..779401f985 100644
--- a/docs/web_deployment.pod
+++ b/docs/web_deployment.pod
@@ -32,40 +32,6 @@ spontaneously logged in as other users in the system.
See also L<authentication/Apache configuration>, in case you intend to
use Apache to provide authentication.
-=head3 mod_fastcgi
-
- # Tell FastCGI to put its temporary files somewhere sane; this may
- # be necessary if your distribution doesn't already set it
- #FastCgiIpcDir /tmp
-
- FastCgiServer /opt/rt5/sbin/rt-server.fcgi -processes 5 -idle-timeout 300
-
- <VirtualHost rt.example.com>
- ### Optional apache logs for RT
- # Ensure that your log rotation scripts know about these files
- # ErrorLog /opt/rt5/var/log/apache2.error
- # TransferLog /opt/rt5/var/log/apache2.access
- # LogLevel debug
-
- AddDefaultCharset UTF-8
-
- ScriptAlias / /opt/rt5/sbin/rt-server.fcgi/
-
- DocumentRoot "/opt/rt5/share/html"
- <Location />
- <IfVersion >= 2.4> # For Apache 2.4
- Require all granted
- </IfVersion>
- <IfVersion < 2.4> # For Apache 2.2
- Order allow,deny
- Allow from all
- </IfVersion>
-
- Options +ExecCGI
- AddHandler fastcgi-script fcgi
- </Location>
- </VirtualHost>
-
=head3 mod_fcgid
B<WARNING>: Before mod_fcgid 2.3.6, the maximum request size was 1GB.
@@ -94,14 +60,7 @@ to return to the old default.
DocumentRoot "/opt/rt5/share/html"
<Location />
- <IfVersion >= 2.4> # For Apache 2.4
- Require all granted
- </IfVersion>
- <IfVersion < 2.4> # For Apache 2.2
- Order allow,deny
- Allow from all
- </IfVersion>
-
+ Require all granted
Options +ExecCGI
AddHandler fcgid-script fcgi
</Location>
@@ -133,14 +92,7 @@ C<SetHandler modperl>, as the example below uses.
DocumentRoot "/opt/rt5/share/html"
<Location />
- <IfVersion >= 2.4> # For Apache 2.4
- Require all granted
- </IfVersion>
- <IfVersion < 2.4> # For Apache 2.2
- Order allow,deny
- Allow from all
- </IfVersion>
-
+ Require all granted
SetHandler modperl
PerlResponseHandler Plack::Handler::Apache2
PerlSetVar psgi_app /opt/rt5/sbin/rt-server
@@ -151,14 +103,6 @@ C<SetHandler modperl>, as the example below uses.
</Perl>
</VirtualHost>
-=head3 mod_perl 1.xx
-
-B<WARNING: mod_perl 1.99_xx is not supported.>
-
-To run RT using mod_perl 1.xx please see L<Plack::Handler::Apache1> for
-configuration examples.
-
-
=head2 nginx
C<nginx> requires that you start RT's fastcgi process externally, for
-----------------------------------------------------------------------
More information about the rt-commit
mailing list