Installing Harmony on GNU/Linux

To install Harmony on GNU/Linux, you must extract the package from the .tar.gz archive you downloaded, then run the installation script it contains.

You can choose to run the installation script interactively or with command line parameters to automate most of the process.

NOTES
  • If you want to run the installation script interactively, your operating system must have the whiptail command line tool, which is provided with the newt application package.
  • Even if you install Harmony non-interactively, you must still interactively review and agree to the license agreement on each installation.

  1. Verify that whiptail is present on your system, to allow the installer to use interactive mode:

    $ sudo yum install newt

  1. In a terminal, navigate to the directory where you downloaded the installation package.

    $ cd ~/Downloads

  1. Extract the package's contents in the directory.

    $ tar -xvzf ./name-of-package.tar.gz

  1. Switch to the directory in which the package's contents were extracted.

    $ cd name-of-package

  1. Run the install script.

    $ sudo ./install

    The interactive setup launches in the terminal.

  1. Do one of the following:
    • If you are working in a Harmony Server environment, whether your machine is going to be a client workstation or a server, select SERVER and press Enter.
    • If you are working in a fully standalone environment or if you only intend to connect to a Harmony database using WebCC, select STANDALONE and press Enter.
  1. In the components dialog, for each component you want to install, use the Up and Down keys to highlight the component, and the Spacebar key to check or uncheck the component:
    • APPLICATION: Installs the application files: binaries, libraries, resources, configuration files, etc. This is required to be able to launch Harmony. You should only omit this option if you are using the installer to add components to an existing installation. .
    • DESKTOP: Creates a directory in the Applications menu of your desktop environment and adds a shortcut for each Harmony application inside it. This option also allows you to open a scene in Harmony by double-clicking on an .xstage file in a file browser.
    • PATH: Adds the path to the Harmony binaries to your $PATH environment variable, allowing you to launch Harmony applications from a terminal by typing their name instead of their full path.
    • URL: Registers the harmony:// URL scheme so that such URLs launch Harmony. This allows WebCC clients to launch Harmony directly from the web browser.

    If you selected to install Harmony Server, these options will also be available:

    • PROCESS: Enables the batch processing daemon and adds the current machine to the database's list of machines available for batch processing.

      NOTE Further configuration is required to make this machine a working batch processing node.
    • DATABASE: Enables the database server daemon and, if no database is present on the machine, creates an empty database file system on the local machine.
    • LINK: Enables and configures the link server daemon. This is required if the current machine is meant to be a database server for Windows clients.
    • WEBCC: Enables and configures the WebCC daemon. This will make this machine a WebCC server.
    • OPENH264: Downloads and installs the Cisco OpenH264 library. This allows a WebCC server to create preview videos for the database scenes which can be played in a web browser. An Internet connection is required.
    • UPDATEDB: Replaces the dictionary (.dict) files in this machine's database with this package's dictionary files. This is useful if your machine is a database server, and you are currently upgrading its version of Harmony.
  1. Press the Tab key to switch to the Ok button at the bottom, then press Enter.
  1. In the Installation Directory dialog, you can choose to type a custom installation path, or to use the default one. Then, press Enter.
  1. In the License Agreement dialog, take the time to carefully review the license agreement. Use the Up and Down keys to scroll through the text in the agreement and read it until the end.
  1. Press Tab to switch to the AGREE and DISAGREE buttons. You can use the Left and Right keys to switch between selecting the AGREE or the DISAGREE button:
    • If you agree with the license agreement, select the AGREE button and press Enter.
    • If you disagree with the license agreement, select the DISAGREE button and press Enter.
  1. A dialog will prompt you to confirm each component that you elected to install. If a lot of components are listed, you can use the Up and Down keys to scroll through the list. You can use the Left and Right keys to select Yes or No. If you want to proceed, select Yes and press Enter.
  1. The installation begins. Each step of the installation is explained in detail until the installation is over.

  1. If your product is not activated, do one of the following to launch the License Wizard:

    • In the terminal, type the following command:

      $ sudo /usr/local/ToonBoomAnimation/harmonyAdvanced_22/lnx86_64/bin/LicenseWizard

    • In the GNOME top menu, select Applications > Harmony 22 Advanced > License Wizard.

      A terminal will open, prompting you to enter your user password. This terminal is attempting to launch License Wizard with sudo, as it requires elevated privileges. Type in your password and press Enter.

    For information on how to use the License Wizard to activate Harmony, see the Toon Boom License Activation Documentation at the following address:

    https://docs.toonboom.com/help/activation

  1. Once Harmony is installed and activated, you can start using it. However, if you elected to add the path to Harmony's binaries to your $PATH environment variable, you will need to reboot your machine before you can benefit from this feature.

  1. In a terminal, navigate to the directory where you downloaded the installation package.

    $ cd ~/Downloads

  1. Extract the package's contents in the directory.

    $ tar -xvzf ./name-of-package.tar.gz

  1. Switch to the directory in which the package's contents were extracted.

    $ cd name-of-package

  1. Start typing the command to run the installer with all the parameters you want for your installation:

    $ sudo ./install <parameters>

    NOTE Each parameter must be specified separately. For example: -a -p will work, but not -ap.
    Parameter Description
    Installation modes
    -server

    Installs the application with shortcuts to the server applications and with daemon files for database servers and clients.

    NOTE If no installation mode is specified, this one is implied by default.
    -standalone

    Installs the application without the shortcuts to the server applications and without the daemon files for database servers and clients. Only use this option if you intend to use Harmony on this machine without relying on a Harmony Server database.

    -uninstall Uninstalls the specified components instead of installing them. If specified alone, this launches the uninstaller in interactive mode.
    Optional components

    -a

    -application

    		 Installs the application files: binaries, libraries, resources, configuration files, etc. This is required to be able to launch Harmony. You should only omit this option if you are using the installer to add components to an existing installation. .

    -b

    -binaries

    		 For backward compatibility with older versions of the installer, this installs the application files and adds the path to the Harmony binaries to the $PATH environment variable. It is equivalent to -a -e.

    -de

    -desktop

    -kde

    		 Creates a directory in the Applications menu of your desktop environment and adds a shortcut for each Harmony application inside it. This option also allows you to open a scene in Harmony by double-clicking on an .xstage file in a file browser.

    -d

    -dbserver

    		 Enables the database server daemon and, if no database is present on the machine, creates an empty database file system on the local machine.

    -l

    -linkserver

    		 Enables and configures the link server daemon. This is required if the current machine is meant to be a database server for Windows clients.

    -p

    -process

    Enables the batch processing daemon and adds the current machine to the database's list of machines available for batch processing.

    NOTE Further configuration is required to make this machine a working batch processing node.

    -w

    -webccserver

    		 Enables and configures the WebCC daemon. This will make this machine a WebCC server.

    -oh

    -openh264

    		 Downloads and installs the Cisco OpenH264 library. This allows a WebCC server to create preview videos for the database scenes which can be played in a web browser. An Internet connection is required.
    Configuration switches

    -e

    -env

    		 Adds the path to the Harmony binaries to your $PATH environment variable, allowing you to launch Harmony applications from a terminal by typing their name instead of their full path.

    -s

    -schemeregister

    		 Registers the harmony:// URL scheme so that such URLs launch Harmony. This allows WebCC clients to launch Harmony directly from the web browser.

    -u

    -updatedict

    		 Replaces the dictionary (.dict) files in this machine's database with this package's dictionary files. This is useful if your machine is a database server, and you are currently upgrading its version of Harmony.
    Other options

    -h

    -help

    		 Displays information about how to use the install script.
    -target <PATH> Specifies the directory in which to install the application. If not specified, Harmony will be installed in /usr/local/ToonBoomAnimation/harmonyAdvanced_22
    -dbpath <PATH> Specifies the location of the database on this machine's file system. This option is only relevant if installing a database server with the -d option, installing a WebCC server with the -w option or updating dictionary (.dict) files with the -u option. If not specified, the installer will presume that the database is located in /USA_DB.

    -own

    -own <USER>

    -own <USER:GROUP>

    		 Makes the application files owned by the specified user or by the specified user:group. If no user or user:group is specified, this will make the application files owned by the user running the script. If this option is not specified, application files will be owned by the root user.

    -q

    -quiet

    		 Do not output information during the installation process.

    -v

    -verbose

    		 Output detailed information on each step of the installation process, including every file copied.
    -output <PATH> Writes the installation log to the specified file instead of outputting it to the terminal.
    -nodialog

    Disables the use of the whiptail utility to display dialogs and interactive prompts. This mode is compatible with dumb-type terminals, which do not support scrolling or erasing the screen.

    NOTE This option is automatically enabled if the whiptail utility is not found on the machine or if the installer detects that the terminal is unable to scroll or erase the screen.
    -force

    By default, installing over an existing installation will simply overwrites existing files, except for configuration files in the etc directory of the installed application, which the installer preserves. This option will cause the existing installation to be completely deleted before installing.

    IMPORTANT Enabling this option will cause your Harmony configuration files to be erased permanently.

    -y

    -assumeyes

    		 Assumes yes on all prompts, except for the license agreement.

  1. Press Enter.

    The install script launches and, if the parameters are valid, the License Agreement prompt appears.

  1. In the License Agreement dialog, take the time to carefully review the license agreement. Use the Up and Down keys to scroll through the text in the agreement and read it until the end.
  1. Press Tab to switch to the AGREE and DISAGREE buttons. You can use the Left and Right keys to switch between selecting the AGREE or the DISAGREE button:
    • If you agree with the license agreement, select the AGREE button and press Enter.
    • If you disagree with the license agreement, select the DISAGREE button and press Enter.
  1. A dialog will prompt you to confirm each component that you elected to install. If a lot of components are listed, you can use the Up and Down keys to scroll through the list. You can use the Left and Right keys to select Yes or No. If you want to proceed, select Yes and press Enter.
  1. The installation begins. Each step of the installation is explained in detail until the installation is over.

  1. If your product is not activated, do one of the following to launch the License Wizard:

    • In the terminal, type the following command:

      $ sudo /usr/local/ToonBoomAnimation/harmonyAdvanced_22/lnx86_64/bin/LicenseWizard

    • In the GNOME top menu, select Applications > Harmony 22 Advanced > License Wizard.

      A terminal will open, prompting you to enter your user password. This terminal is attempting to launch License Wizard with sudo, as it requires elevated privileges. Type in your password and press Enter.

    For information on how to use the License Wizard to activate Harmony, see the Toon Boom License Activation Documentation at the following address:

    https://docs.toonboom.com/help/activation

  1. Once Harmony is installed and activated, you can start using it. However, if you elected to add the path to Harmony's binaries to your $PATH environment variable, you will need to reboot your machine before you can benefit from this feature.