Command Line Tools

The "crossbox" CLI Command

 This is the CrossBox command line utility. Use it to view status, restart services, view logs, trigger updates, and a lot more.

You need to be a root user to run the command.

Monitoring

crossbox stop|start|restart|status

Easily stop, start, restart or output the status of a CrossBox Server.

Updating

crossbox update

Perform a manual update check and update the application if possible.

crossbox update-slaves

Perform a manual update of CrossBox slave servers, provided that the command is run from the master server.

Logs

crossbox log [--paths --lines]

Displays all logs in real time. If it's too verbose, try using crossbox <service> log.

--paths
displays locations of log files on the system
--lines
defines a number of "last lines" to display for each log file

Service Specific

crossbox <service> stop|start|restart|status|log

You can also specify several <services> by separating multiple services from the list below with a comma:

  • redis
  • mysqld
  • exim
  • dovecot
  • opendkim
  • rspamd
  • freshclam
  • clamd
  • turnserver
  • uwsgi
  • webserver
Medic

crossbox medic

CrossBox Medic will collect all the relevant CrossBox logs from your server, send them to us and give you a unique key which you can reference when requesting support.

Utility

crossbox info

Will tell you general information about your CrossBox installation.

crossbox websocket|taskqueue info

Allows you to view WebSocket and task queue statuses. This will also show you how many users are connected to the server.

crossbox change-admin-password

Allows you to reset admin's password.

crossbox change-admin-email

Allows you to reset admin's e-mail address.

crossbox extra migrate-roundcube-contacts

Imports cPanel RoundCube contacts to CrossBox (useful for users migrating away from Roundcube).

crossbox changelog

Shows latest update messages.

Debugging

You can enable the debug mode if you are faced with a bug and you want to find out more about what the application is doing.

crossbox debug disable|normal|unsafe

Use unsafe mode only when you don't see anything indicating a problem. When using the unsafe debug mode the application may leak information, so use it with care.

NOTE: Changing the debug mode will restart all CrossBox services.