Console¶
Zammad uses Ruby on Rails so you can make use of the rails console.
Warning
Please double check your commands before running, as some of those commands might cause data loss or damaged tickets! If you’re unsure, use a test system first!
To open the rails console on the shell you have to enter the following commands.
Start Zammad’s Rails console¶
Running a single command¶
The following command will allow you to run a single command, without running a shell (e.g. for automation).
Note
Replace {COMMAND}
with your command you want to run.
Tip
If you enter a p
in front of your command
(e.g. like rails r 'p Delayed::Job.count'
),
you’ll actually receive a printed output (without you won’t!).
# package installation
$ zammad run rails r '{COMMAND}'
# source installation
$ rails r '{COMMAND}'
Running several commands in a shell¶
The following command will provide you a rails console. It allows you to run several commands inside it.
This reduces loading times greatly.
# package installation
$ zammad run rails c
# source installation
$ rails c
Working on the console¶
Here’s a topic list for quick jumping and better overview.
- Query and set / update Zammad settings
- Advanced customization settings
- Send all outgoing E-Mails to a BCC-Mailbox
- Activate counter on grouped overviews
- Default ticket type on creation
- Adding a warning to the ticket creation process
- Adding a warning to the article reply process
- Show Email address of customer on customer selection (ticket creation)
- Change font settings for outgoing HTML mails
- Highlight customer’s open ticket count
- Working on user information
- Working with ticket information
- Working with ticket articles
- Working with groups
- Working with chat logs
- Other useful commands
- Deleting records