The OTRS framework.
Perl JavaScript CSS PLSQL Perl6 HTML
Latest commit 16a1cce Jan 24, 2017 Florian Liebe Follow-up fix for bug#12529: fixed selenium test.
Permalink
Failed to load latest commit information.
.tx Disabled transifex connection for master branch to avoid wrong pushes. Sep 7, 2015
Custom Changed dtl block to tt style, updated some old dtl text references. Mar 21, 2015
Kernel Follow-up fix for bug#12529: fixed selenium test. Jan 24, 2017
bin Updated copyright. Jan 1, 2017
development Updated copyright. Jan 1, 2017
doc Reorganized development and doc folders a bit. Oct 16, 2014
i18n/otrs Updated translation files. Jul 19, 2016
scripts Follow-up fix for bug#12529: fixed selenium test. Jan 24, 2017
var Follow-up fix for bug#12528. Jan 20, 2017
.bash_completion Updated copyright. Jan 1, 2017
.fetchmailrc.dist Updated copyright. Jan 1, 2017
.gitignore Updated .gitingore; Added check if OTRSBusiness is installed (example… Sep 22, 2016
.mailfilter.dist Updated copyright. Jan 1, 2017
.mailmap Updated contributors list based on git information. Aug 21, 2015
.procmailrc.dist Updated copyright. Jan 1, 2017
.travis.yml Simplified fixed time handling in unit test helper and removed DateTi… Sep 21, 2016
AUTHORS.md Add Balazs Ur to contributors list. Jan 7, 2016
CHANGES.md Fixed: Notifications break AgentTicketBulk (bug#12529). Jan 24, 2017
CONTRIBUTING.md Added contributing instructions. Oct 21, 2014
COPYING Change GPL2 to AGPL3. Feb 26, 2009
COPYING-Third-Party Tidied COPYING-Third-Party. Nov 7, 2016
INSTALL.md Updated version. Sep 15, 2015
README.md Update the minimum Perl version for OTRS 6 to 5.16. Sep 19, 2016
RELEASE Updated version. Sep 15, 2015
UPGRADING.md Updated version. Sep 15, 2015

README.md

Build Status

What is OTRS?

OTRS (the former Open Ticket Request System now stands for Open Technology – Real Service) is an open source ticket request system with many features to manage customer telephone calls and e-mails. It is distributed under the GNU AFFERO General Public License (AGPL) and tested on various Linux platforms. Do you receive many e-mails and want to answer them with a team of agents? You're going to love OTRS!

You can find a list of features in the online documentation.

License

It is distributed under the AFFERO GNU General Public License - see the accompanying COPYING file for more details.

Documentation

You can find quick documentation in README.* and the long version online. The source code of OTRS and its public extension modules is available on github.

Professional Services

Whether you need help in configuring or customizing OTRS or you want to be on the safe side, don't hesitate to contact us: We offer a wide range of professional services such as world-wide enterprise support, consulting and engineering including process design, implementation, customization, application support, and fully managed service.

Our Service Contracts guarantee instant help and professional support as well as support assessment and last but not least free access to OTRS Feature Add-ons - useful additional features for your OTRS.

The OTRS Group offers specific training programs in different countries. You can either participate in one of our public OTRS Administrator trainings which take place regularly, or benefit from an inhouse training that covers all the specific needs of your company.

Software requirements

Perl

  • Perl 5.16.0 or higher

Webserver

  • Webserver with CGI support (CGI is not recommended)
  • Apache2 + mod_perl2 or higher (recommended)

Databases

  • MySQL 5.0 or higher
  • MariaDB
  • PostgreSQL 8.4 or higher
  • Oracle 10g or higher

Browsers

  • Use a modern web browser.
  • These browsers are not supported:
    • Internet Explorer before version 11
    • Firefox before version 31
    • Safari before version 6

Directories & Files

$HOME (e. g. /opt/otrs/)
|
|  (all executables)
|--/bin/             (all system programs)
|   |--/otrs.PostMaster.pl      (email2db)
|   |--/otrs.PostMasterMail.pl  (email2db)
|   |--/cgi-bin/
|   |   |----- /index.pl        (Global Agent & Admin handle)
|   |   |----- /customer.pl     (Global Customer handle)
|   |   |----- /public.pl       (Global Public handle)
|   |   |----- /installer.pl    (Global Installer handle)
|   |   |----- /nph-genericinterface.pl (Global GenericInterface handle)
|   |--/fcgi-bin/               (If you're using FastCGI)
|
|  (all modules)
|--/Kernel/
|   |-----/Config.pm      (main configuration file)
|   |---- /Config/        (Configuration files)
|   |      |---- /Files/  (System generated, don't touch...)
|   |
|   |---- /Output/        (all output generating modules)
|   |      |---- /HTML/
|   |             |---- /Templates/
|   |                    |--- /Standard/*.tt (all tt files for Standard theme)
|   |
|   |--- /GenericInterface (GenericInterface framework)
|          |--- /Invoker/ (invoker backends)
|          |--- /Mapping/ (data mapping backends)
|          |--- /Operation/ (operation backends)
|          |--- /Transport/ (network transport backends)
|   |
|   |---- /Language/      (all translation files)
|   |
|   |---- /Modules/        (all action modules e. g. QueueView, Move, ...)
|   |      |----- /Admin*      (all modules for the admin interface)
|   |      |----- /Agent*      (all modules for the agent interface)
|   |      |----- /Customer*   (all modules for the customer interface)
|   |
|   |---- /System/         (back-end API modules, selection below)
|           |--- /Auth.pm        (authentication module)
|           |--- /AuthSession.pm (session authentication module)
|           |--- /Daemon         (all daemon files)
|                 |--- /DaemonModules    (all daemon modules)
|                       |---SchdulerTaskWorker    (all scheduler worker daemon task handlers)
|           |--- /DB.pm          (central DB interface)
|           |--- /DB/*.pm        (DB drivers)
|           |--- /DynamicField.pm (Interface to the DynamicField configuration)
|           |--- /DynamicField
|                 |--- /Backend.pm (Interface for using the dynamic fields)
|                 |--- /Backend/*.pm (DynamicField backend implementations)
|                 |--- /ObjectType/*.pm (DynamicField object type implementations)
|           |--- /Email.pm       (create and send e-mail)
|           |--- /EmailParser.pm (parsing e-mail)
|           |--- /GenericInterface/*.pm (all DB related GenericInterface modules)
|           |--- /Group.pm       (group module)
|           |--- /Log.pm         (log module)
|           |--- /Queue.pm       (information about queues. e. g. response templates, ...)
|           |--- /Ticket.pm      (ticket and article functions)
|           |--- /User.pm        (user module)
|           |--- /Web/*.pm       (core interface modules)
|                 |--- /Request.pm    (HTTP/CGI abstraction module)
|
|  (data stuff)
|--/var/
|   |--/article/               (all incoming e-mails, plain 1/1 and all attachments ...
|   |                            ... separately (different files), if you want to store on disk)
|   |--/cron/                  (all cron jobs for escalations and such)
|   |
|   |--/fonts/                 (true type fonts for PDF generation)
|   |
|   |--/httpd/                 (all static files served by HTTP)
|   |   |--- /htdocs/
|   |         |--- /js/        (javascript files for OTRS)
|   |               |--- /js-cache/        (auto-generated minified JS files)
|   |               |--- /thirdparty/      (contains jQuery, CKEditor and other external JS libraries)
|   |         |--- /skins/     (CSS and images for front end)
|   |               |--- /Agent/        (Agent skins)
|   |                     |--- /default/ (default skin)
|   |                           |--- /css/ (stylesheets)
|   |                           |--- /css-cache/ (auto-generated minified CSS files)
|   |                           |--- /img/ (images)
|   |                     |--- /slim/    (additional skin)
|   |                           |--- /.../ (files)
|   |                     |--- /ivory/   (additional skin)
|   |                           |--- /.../ (files)
|   |               |--- /Customer/     (Customer skins)
|   |                     |--- /default/ (default skin)
|   |                           |--- /.../ (files)
|   |                     |--- /ivory/
|   |                           |--- /.../ (files)
|   |
|   |--/log/                   (log files)
|   |   |--/TicketCounter.log  (ticket counter)
|   |
|   |--/sessions/              (session info)
|   |
|   |--/spool/                 (spool files)
|   |
|   |--/stats/                 (statistics)
|   |
|   |--/tmp/                   (temporary files, such as cache)
|
|  (tools stuff)
|--/scripts/
    |----  /database/
            |--- /otrs-schema.(mysql|postgresql|*).sql (create database script)
            |--- /otrs-initial_insert.(mysql|postgresql|*).sql (all initial sql data - e. g.
            |                                                   root user, queues, ...)
            |--- /otrs-schema-post.(mysql|postgresql|*).sql (create foreign keys script)