SCROTT - The Secure Centralized Robust Online Ticketing Tool
============================================================

This is the alpha version of Scrott, which is currently only a very simplistic
and generic issue tracker, supporting multiple users and project boards (called
'pads').

Development on the beta version has begun.  I have planned a full rewrite and
will be introducing some design changes to a few core components of Scrott.
Follow development on the 'dev' source branch.

In the meantime, expect the alpha to receive no more than bug fixes and, perhaps,
only small features as updates.


INSTALLATION
------------

Scrott requires PHP 7.2, with the mysqli and gd extensions.  Scrott also
requires a MySQL or MariaDB database.  The recommended server platform is Nginx.

Use the supplied file 'srvs/nginx.conf' as a baseline for your server
configuration.  The web-root should be the 'app/' directory; however, Scrott
can handle being placed in some sub-directory tree of your web as well.
Internal hyperlinks will adjust.

Execute the supplied file 'srvs/mysql.sql' in the MySQL client to initialize an
empty database for Scrott.

Make sure to make the 'app/dynmic/' directory writable by your web server.
Uploaded files are placed here.  You should *ABSOLUTELY* deny access to this
directory through your web server, the file 'app/df.php' is used to safely
serve these files instead.

Arrange for the file 'app/cron.php' to be run periodically.  It performs
tasks such as cleaning up old database objects.

Navigate to your installation in a web browser.  You should be presented with a
page stating "Welcome to Scrott"!  Enter your database parameters here.  The next
page allows you to register the first administrator user.

Once a single administrator user exists, installation is complete.  Navigating
to the site signed-out should show only the login page.  Additional account
registration can be enabled via the admin general settings tab.


CONTRIBUTING
------------

I am currently accepting patches for the alpha series only.  Send your patches
via email to the maintainer.  Alternatively, a pull request (formatted with
the 'git request-pull' command) may be sent.

In either case, if your patches form a series, a separate message should be
present summarizing the changes and _why_ they are needed.