Management commands

atfinity supports a list of management commands to make administrating your installation easier.

They are executed via ./atfinity.sh COMMAND.

Command

Description

display_version [-c TENANT_ID]

Display the current version of the software. If tenant_id is also provided, the current version of that tenants configuration is also displayed.

createtenant [-t TENANT_TITLE] [-s TENANT_SUBDOMAIN]

Create a new tenant.

createuser -u USER_EMAIL -p PASSWORD -t TENANT_ID [--meta_admin]

Create a new user within the given tenant or (if user exists) reset password and update meta_admin status.

createtenantanduser -s TENANT_SUBDOMAIN [-u USER_EMAIL] [-p PASSWORD] [-t TENANT_TITLE]

Create a new tenant with an attached meta admin user.

changepassword USER_EMAIL

Reset a user's password (will ask for a new password).

showtenants

List all tenants of the system.

showusers

List all users of all tenants in the system.

zip_import ZIP_FILE_TO_IMPORT

Clear the current database and import a .zip with data and files. The .zip will first be copied into a shared folder with the docker container and then imported.

zip_export -o /import/data_and_files_export.zip

Export all current data and files to a .zip. The .zip will appear in the /import folder as data_and_files_export.zip.

removeoldtasks

Remove celery tasks (and their attachments) older than a week. We recommend running this periodically.

delete_all_data

Delete all case and instance data.

delete_tenant TENANT_ID1 [TENANT_ID2 ... TENANT_IDN]

Delete the tenants with the given ids.