Share

The Igniter Command-Line Tool

The igniter command-line tool is provided with Flame Family products to perform advanced database management tasks. The tool is located in /opt/Autodesk/bin and needs to be executed as the flame_db user (with some exceptions).

To get detailed help on the operations and options offered by igniter, do:

/opt/Autodesk/bin/igniter --help

To become the flame_db user which must be used for most igniter commands, do the following (administrator privileges required):

sudo -u flame_db -i

The previous step can be skipped by running the commands this way:

sudo -u flame_db -i /opt/Autodesk/bin/igniter <command>

Below are examples of common tasks performed with igniter. All examples assume the current directory is /opt/Autodesk/bin and the flame_db user is performing the operations.




Creating a Certificate Authority

Studios with workgroups can create a Certificate Authority on a shared location and use it when providing access to users:

flame_db$ ./igniter --new-ca



Creating a new database

flame_db$ ./igniter --init 

The authentication mode (trust or cert) can be specified with option -a <mode>. cert is used by default.




Destroying a database

flame_db$ ./igniter --destroy
You are about to unrecoverably DELETE ALL DATABASES.
The medatata and the media files of <n> projects will need to be manually deleted afterward.
Continue? ("DeLeTe" to confirm, anything + Enter to abort)
Note: Only the database (that is, the relevant metadata for all projects) is destroyed; other project metadata and media need to be manually deleted afterwards. Using the application or Wiretap remains the recommended way to properly delete media.



Managing users and groups

For a database created in trust authentication mode, user management is not required; all users connect to the database through a shared, generic user.

For a database created in certificate authentication mode however, users created at the database level will determine who can connect to the database, and combined with groups will determine what projects they can access.

Important: Database users must not be confused with operating system-level users (the username you use to log in to your workstation); they are different, even though they should be named the same (for example, if your login username is john, a database user named john should be created as described below). The same goes for groups.

Creating a database user with igniter will automatically create an SSL certificate for that user. If the local super user has the required privileges to update the user's home directory, the certificate will be written directly in their ~/.postgresql folder. Otherwise, igniter will write the certificate in a temporary location and the certificate will need to be manually moved to its final location. The igniter output in the shell will give detailed instructions in that case.

When creating the user, it is important to use the same Certificate Authority used when creating the database, specified with the -k option.

For example, to authorize a user whose system username is john and who is part of the finishing group, the following user and group must be created in the database with igniter:

flame_db$ ./igniter --group-new finishing
flame_db$ ./igniter --user-new john -k <CA keydir> -g finishing

As usual with igniter, commands can be chained and will be executed from left to right:

flame_db$ ./igniter --group-new finishing --user-new john -k <CA keydir> -g finishing

igniter offers many more options to manage databases, users, groups and certificates; refer to the command-line help for all the details:

flame_db$ ./igniter --help

Was this information helpful?