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!).

$ docker compose run --rm zammad-railsserver bundle exec 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.

$ docker compose run --rm zammad-railsserver bundle exec rails c

Tip

If you use Portainer to manage your Docker containers, you can even use a console via Portainer’s GUI.

Hint

Starting Rails Console in Safe Mode

Normally, starting a Rails console requires certain third party services to be up and running. You may receive errors and console will refuse to start in case they are not available.

However, it’s possible to start Rails console in safe mode by setting the environment variable ZAMMAD_SAFE_MODE=1. With this setting enabled, the availability of these services will be ignored.

Set variable and run Rails console:

$ ZAMMAD_SAFE_MODE=1 zammad run rails c

This gives you a response like this:

Zammad is running in safe mode. Any third party services like Redis are ignored.

There was an error trying to connect to Redis via redis://localhost:6379.
Please provide a Redis instance at localhost:6379 or set REDIS_URL to point to a different location.
＃<Redis::CannotConnectError: Error connecting to Redis on localhost:6379 (Errno::ECONNREFUSED)>
Loading production environment (Rails 6.1.7.3)
3.1.3 :001 >