Installation Guide Linux Operating Systems
Installation Guide Linux Operating Systems
Disclaimer
The content of this manual is covered by a specific limited warranty and exclusions and limit of liability under the
applicable License Agreement as supplemented by the special terms and conditions for Adobe® Flash® File Format
(SWF). Please refer to the License Agreement and to those special terms and conditions for details.
The content of this manual is the property of Toon Boom Animation Inc. and is copyrighted. Any reproduction in whole
or in part is strictly prohibited.
For additional copies of this manual, please contact Toon Boom Animation Inc. at the Corporate Headquarters
address.
Copyright © 2009 by Toon Boom Animation Inc. All rights reserved.
Trademarks
Toon Boom Harmony is a trademark owned by Toon Boom Animation Inc. All other trademarks are the property of
their respective owners.
Credits
Documentation Development: Toon Boom Animation Inc.
Content Development: Marie-Eve Chartrand, Anouk Whissell
Publication Date
November 2009
Contents
Installing on Linux ....................................................................................................................................................... 3
Pre-installation ............................................................................................................................................................ 4
Check Your Minimum Requirements ...................................................................................................................... 4
Product Code .......................................................................................................................................................... 4
Check Your Pre-installation Configuration ............................................................................................................. 4
Fedora Installation .............................................................................................................................................. 4
Update NVIDIA Drivers ....................................................................................................................................... 4
Update the Configuration File for New Video Drivers ....................................................................................... 5
Resolve Keyboard Shortcut Conflicts and Tweak KDE ....................................................................................... 5
Get the License File ............................................................................................................................................ 6
Harmony Installation ................................................................................................................................................... 7
Upgrading a Previous Installation ........................................................................................................................... 7
Install Harmony 7.8 ............................................................................................................................................. 8
Configuring the Harmony database ................................................................................................................... 8
Configuring the License Server .......................................................................................................................... 9
Restore backed-up data ................................................................................................................................... 12
Linux upgrade of a Harmony from v7.3 ................................................................................................................ 12
Restore the files that were backed-up earlier .................................................................................................. 14
Edit usabatch’s .cshrc ....................................................................................................................................... 14
Edit other users .cshrc ...................................................................................................................................... 15
Edit the /etc/skel/.cshrc .................................................................................................................................... 15
Configuring the License Server ........................................................................................................................ 15
Restart the Harmony services ........................................................................................................................... 18
Updating the nfs export ................................................................................................................................... 18
Updating the smb.conf ..................................................................................................................................... 19
Verify the parameters required in the smb.conf ............................................................................................... 20
Create the usabatch User ..................................................................................................................................... 21
Modifying Existing Users .................................................................................................................................. 22
Install Harmony ..................................................................................................................................................... 22
Configuration ............................................................................................................................................................ 24
Configure Supporting Software and Hardware .................................................................................................... 24
Set Up Licensing ............................................................................................................................................... 24
Configure Harmony .............................................................................................................................................. 27
Set Up the Database Server ............................................................................................................................. 27
Create the Toon Boom Harmony File System .................................................................................................. 28
Configuring Harmony to Share Scene Data ............................................................................................................. 29
Export Harmony Directories for Mac OS X and Linux Clients .............................................................................. 29
Configure the Link Server ..................................................................................................................................... 29
Configure Samba .................................................................................................................................................. 30
Configure the Samba Service to Start at Boot Time ........................................................................................ 31
Configure the server.ini File ............................................................................................................................. 31
Reboot .............................................................................................................................................................. 31
Set Up Linux Clients. ......................................................................................................................................... 31
Install Start Application Menu Entries and Batch Processing on Clients ......................................................... 33
Troubleshooting ........................................................................................................................................................ 34
Problem: License Error When Starting Any Toon Boom Harmony Module ......................................................... 34
Problem: Unable to Import Sample Scene (Errors with the Dbserver) ................................................................. 34
Problem: Unable to Open Sample Scene on Linux Clients .................................................................................. 35
Problem: Stage Module Will Not Open or Crashes on Startup ........................................................................... 35
Problem: Unable to Display Images in Stage Module .......................................................................................... 35
Problem: Exported Directories Not Mounting on Clients .................................................................................... 36
1
Harmony Installation Guide - Linux Operating Systems
2
Installing on Linux
This document explains how to install Toon Boom Harmony 7.8 on Linux (Fedora).
This document assumes that you are familiar with Linux and are capable of working in a command shell.
Throughout this document, we will ask you to create files using a text editor. The console text editor vi is commonly
used and is part of the Fedora package. Another text editor you can use is nano. To launch them just type their name
on the command line.
NEdit is a graphical, user-friendly text editor, which may not be installed by default. You can download it from
http://www.nedit.org/. Other graphical text editors, such as kedit and gedit can also be used.
There are three stages required to install Harmony, which are covered in the following topics:
1. Pre-installation, on page 4
2. Harmony Installation, on page 7
3. Configuration, on page 24
After completing these stages, you can verify the integrity of the installation and resolve any configuration issues.
• Troubleshooting, on page 34
3
Harmony Installation Guide - Linux Operating Systems
Pre-installation
Before installing Harmony, you must perform the following task:
• Check Your Pre-installation Configuration, on page 4
Product Code
• You must have your Harmony Product Code at hand before you begin the installation.
Fedora Installation
Following are some considerations for Fedora Linux installation. Explaining how to install Fedora Linux is beyond the
scope of this document. For detailed information on how to install Fedora Linux, see the Fedora documentation.
Installing Fedora Linux:
• Download the Fedora Linux documentation from:
http://docs.fedoraproject.org/
• When installing Fedora Linux, perform a Custom installation and select to install Everything to ensure that
you get all packages necessary to run Harmony.
• When asked, select Firewall as disabled. Your file server should be behind a firewall, but should not be
configured as one.
• When asked, select SELiux as disabled.
• Harmony has been tested and certified for use on the KDE windows manager.
• Harmony works best with a minimum screen resolution of:
1280 pixels x1024 pixels x 24 bits.
If Fedora cannot detect your monitor, configure the monitor as a generic CRT or an LCD with this resolution
and a 60 Hz refresh rate. Alternatively, consult your monitor manufacturer’s documentation.
• If you’re new to Linux, we recommend that you create a boot disk to facilitate recovery.
4
Installing on Linux
5
Harmony Installation Guide - Linux Operating Systems
4. In the Inner window, titlebar and frame section, do one of the following:
Change your keyboard layout to choose Meta key from the Modifier Key option. The Meta key is the
Windows Start button on a 104-key keyboard. You must have this type of keyboard to use this option.
D You must enable the 104-key layout for the Meta key to work. This is set in Control Center > Regional
and Accessibility > Keyboard Layout (in earlier versions, open the Control Center > Peripherals >
Keyboard menu). Select the Enable keyboard layouts option and then select a Keyboard Model that
includes 104 keys.
D Go to Desktop > Window Behavior (in earlier versions, open the Look & Feel > Window Behavior
menu). Click the Actions tab. In the Inner window, titlebar and frame section, select Meta as the
Modifier Key.
Set all of the Modifier Key + options to Nothing.
5. There are a few KDE preferences that you should update to optimize Toon Boom Harmony.
In the KDE menu, select Settings > Desktop > Window Behavior. Click the Moving tab to disable these
two options. Harmony reacts better and faster when they are disabled:
D Display content in moving windows
D Display content in resizing windows
In the KDE menu, select Settings > Desktop > Window Behavior and select the Colors menu, disable the
following option:
D Apply colours to non-KDE applications
NOTE: This option may cause Toon Boom Harmony to display incorrect colours in some of the interface
controls.
After you have completed all Fedora Linux configurations, you are ready to install Toon Boom Harmony.
6
Installing on Linux
Harmony Installation
Now that you have verified your minimum requirements, and configured your hardware and software, you are ready
to install Toon Boom Harmony.
You will perform the following tasks:
1. Upgrading a Previous Installation, on page 7
2. Install Harmony, on page 22
7
Harmony Installation Guide - Linux Operating Systems
Using the KDE Menu Editor that can be started from the KDE menu. The location will vary depending on the
version of Linux installed.
By deleting them from the command line. Change to /usr/share/applnk/
$ cd /usr/share/applnk/
Delete the old shortcuts:
$ rm USAnimation-*
The shortcuts will be removed from the KDE menu the next time you log in.
6. Uncompress the distribution file.
tar xvfz [path_to_distribution_file]/[filename].tar.gz
7. Change to the directory that was extracted from the tar.gz file.
8. While logged in as the root user, run the install script with the following options:
./install_usa -b -kde
9. After the installation process is complete, re-start all services. Depending on the services you have running, type
the following commands, in the order presented, in a shell while logged in as the root user:
/sbin/service USAnimation_flexlm start
/sbin/service USAnimation_dbserver start
/sbin/service USAnimation_link_srv start
/sbin/service USAnimation_queues start
8
Installing on Linux
9
Harmony Installation Guide - Linux Operating Systems
14. Type or copy/paste the Product Code and type in the number of licenses this product code grants you.
NOTE: Once activated, server license cannot be returned to the activation server. Make sure you are activating
the license on the correct computer with the proper license count.
15. Click on Next.
10
Installing on Linux
11
Harmony Installation Guide - Linux Operating Systems
Also it is good practice to verify that the license service it properly running by going in the Server Status tab and
clicking Perform Status Enquiry.
12
Installing on Linux
13
Harmony Installation Guide - Linux Operating Systems
if ( -f /usa/etc/usa_cshrc ) then
source /usa/etc/usa_cshrc
endif
14
Installing on Linux
umask 0
if ( -f /usr/local/ToonBoomAnimation/harmony_7.8/etc/usa_cshrc ) then
source /usr/local/ToonBoomAnimation/harmony_7.8/etc/usa_cshrc
endif
umask 0
15
Harmony Installation Guide - Linux Operating Systems
16
Installing on Linux
9. Type or copy/paste the Product Code and type in the number of licenses this product code grants you.
NOTE: Once activated, server license cannot be returned to the activation server. Make sure you are activating
the license on the correct computer with the proper license count.
10. Click on Next.
The Install License Server screen appears:
To start the license server manually, type the following as the root user:
$ /etc/init.d/USAnimation_flexlm restart
17
Harmony Installation Guide - Linux Operating Systems
$ /etc/init.d/USAnimation_link_srv restart
$ /etc/init.d/USAnimation_queues restart
15. Once the services are started, check the logs to make sure that they have been started properly. Check all the
logs to see if the services are running properly. Logs are located in /tmp.
/tmp/lmgrd.log
/tmp/tbdbserver.log
/tmp/tbprocess.log
/tmp/Link_srv.log
16. Start Harmony and open a scene to see if the server works properly.
18
Installing on Linux
19
Harmony Installation Guide - Linux Operating Systems
4. To get rid of this error, you need to add the level2 oplocks = No parameter in the global section.
See the next section for all the parameters that are required in the smb.conf.
5. Then, restart smb:
$/etc/init.d/smb restart
[usa]
comment = Harmony binaries & stuff
browseable = yes
read only = no
guest ok = no
create mask = 0777
directory mask = 0777
path = /usr/local/ToonBoomAnimation/harmony_7.8
[usadata000]
comment = Harmony data 000
browseable = yes
read only = no
guest ok = no
create mask = 0777
directory mask = 0777
20
Installing on Linux
path = /usadata000
2. Remember to always perform a testparm after making changes to the smb.conf
$ testparm
3. Restart the smb service.
$ /sbin/service smb restart
4. Reboot the server
If possible, reboot the server to verify that all the services are properly started.
5. Once the server is booted, check all the logs to see if the services are running properly. Logs are located in /tmp
/tmp/lmgrd.log
/tmp/tbdbserver.log
/tmp/tbprocess.log
/tmp/Link_srv.log
21
Harmony Installation Guide - Linux Operating Systems
6. Once logged in, open the .cshrc file in usabatch’s home using a text editor add the following lines:
if ( -f /usr/local/ToonBoomAnimation/harmony_7.8/etc/usa_cshrc ) then
source /usr/local/ToonBoomAnimation/harmony_7.8/etc/usa_cshrc
endif
The .cshrc file should now contain the following:
if ( -f /usr/local/ToonBoomAnimation/harmony_7.8/etc/usa_cshrc ) then
source /usr/local/ToonBoomAnimation/harmony_7.8/etc/usa_cshrc
endif
umask 0
7. Save and quit.
8. Log out of usabatch to return to the root user.
Install Harmony
In a client-server network or in a stand-alone set up, you must install Harmony binaries as well as the following services:
• Dbserver: Controls access to the Harmony database.
• License service: Controls the number of licenses and features available to Harmony users.
• Batch Processing: If you are setting up the machine for batch processing this controls batch vectorizing and
rendering queues.
• Link Server: If you are installing Harmony on a Linux server that will support Windows clients.
To install Harmony binaries and services, you must run the installation script.
With the product code file and the product code from the licenser, you are ready to begin installing Harmony.
To run the installation script:
1. Change to the directory that contains the Linux installation files.
cd /tmp/linux/dist
22
Installing on Linux
If your Linux server will be serving Windows clients, you must add the -l option.
If you are setting up the server or the clients for the batch render, you would add the -p parameter:
Here is a description of all the installation options:
-dbserver Inactive Installs the dbserver as a daemon. This is the Harmony database server
-d daemon. It processes data requests from clients on the network.
This option also creates a fresh database when there is no /USA_DB
directory.
You must use this option when installing Harmony on the server and on
the stand-alone machine.
-binaries Inactive Installs binaries and configuration files required to run Harmony
-b applications.
You must include this option when doing a fresh install or when you
upgrade Harmony.
You must use this option when installing Harmony on the server.
-target_dir Root directory Directory where the installer will install the /usa tree.
<DIRECTORY>
-t <DIRECTORY>
-udatedict Inactive Updates the dict files in the database. Needs to be specified when
-u upgrading from a previous version.
23
Harmony Installation Guide - Linux Operating Systems
Configuration
After installing Harmony, configure database parameters depending on your machine’s setup, and configure third-
party software.
1. Configure Supporting Software and Hardware, on page 24
2. Configure Harmony, on page 27
Set Up Licensing
Now that you have installed Harmony, you must set up the licensing so that it can run on the server and client
machines.
24
Installing on Linux
25
Harmony Installation Guide - Linux Operating Systems
5. Type or copy/paste the Product Code and type in the number of licenses this product code grants you.
NOTE: Once activated, server license cannot be returned to the activation server. Make sure you are activating
the license on the correct computer.
6. Click on Next.
The Install License Server screen appears:
26
Installing on Linux
NOTE: Both these steps can be done manually if need be. To configure the License Server service to start
automatically at boot, use the following command:
$ /sbin/chkconfig USAnimation_flexlm on
8. To start the license server manually, type the following as the root user:
$ /etc/init.d/USAnimation_flexlm restart
The Activation Successful screen appears:
Configure Harmony
After installation, you must set up the database configuration for computers running Harmony.
1. Set Up the Database Server, on page 27
2. Create the Toon Boom Harmony File System, on page 28
3. Set Up Linux Clients., on page 31
4. Install Start Application Menu Entries and Batch Processing on Clients, on page 33
27
Harmony Installation Guide - Linux Operating Systems
/usr/local/ToonBoomAnimation/harmony_7.8/lnx86/bin/create_usa_db /USA_DB
Next you need to create and edit the Dbserver.conf file to set up the Dbserver. Then you have to run a script that
will start the Dbserver.
To set up the Dbserver:
1. Using a text editor, create the file Dbserver.conf in /USA_DB/.
2. Type the following in the Dbserver.conf file:
Assuming the machine name of the Dbserver is “harmonyserver”, the lines in Dbserver.conf would look like
this:
hostname harmonyserver
port 5678
debug_port 5680
Note: You can find the example of Dbserver.conf in /usr/local/ToonBoomAnimation/harmony_7.8/
resources/samples. You can copy and paste it from there and change it accordingly.
3. Save and close the Dbserver.conf file.
4. Change the permissions on the Dbserver.conf file to 644.
In a shell, type the following:
chmod 644 Dbserver.conf
5. You must now start the Dbserver service. In a shell, type the following command:
/sbin/service USAnimation_flexlm start
/sbin/service USAnimation_dbserver start
/sbin/service USAnimation_link_srv start
/sbin/service USAnimation_queues start
A message will appear in the shell indicating that the script has been successful.
6. A log file will be generated in /tmp/tbdbserver.log. Check this file to make sure there are no errors written
to the log.
28
Installing on Linux
29
Harmony Installation Guide - Linux Operating Systems
4. A log file will be generated in /tmp/Link_srv.log. Check this file to make sure there are no errors written to
this file.
Configure Samba
Finally, you must modify the /etc/samba/smb.conf file. To do this, add entries for each database directory you
want to share with Windows clients in the /etc/samba/smb.conf file. Then, you must add options to the [Global]
section of the file.
Following is an example of entries in the smb.conf file. You can add these to the end of the smb.conf file.
[USA_DB]
comment = Toon Boom Harmony Database
browseable = yes
read only = no
guest ok = no
create mask = 0777
directory mask = 0777
path = /USA_DB
[usa]
comment = Toon Boom Harmony binaries & stuff
browseable = yes
read only = no
guest ok = no
create mask = 0777
directory mask = 0777
path = /usa/local/ToonBoomAnimation/harmony7.8
[usadata000]
comment = Toon Boom Harmony data 000
browseable = yes
read only = no
guest ok = no
create mask = 0777
directory mask = 0777
path = /usadata000
[usadata001]
comment = Toon Boom Harmony data 001
browseable = yes
read only = no
guest ok = no
create mask = 0777
directory mask = 0777
path = /usadata001/
You must also either add or modify the following entries to the [Global] section of smb.conf:
[global]
blocking locks = false
30
Installing on Linux
oplocks = false
encrypt passwords = no
level2 oplocks = no
Once you have done all the changes and saved the smb.conf file, run the testparm command to validate the
smb.conf configuration file for internal correctness.
testparm
Reboot
At this point, you should reboot the Toon Boom Harmony server so that all of the services you just configured will start
up.
31
Harmony Installation Guide - Linux Operating Systems
/etc/init.d/nfs restart
/sbin/chkconfig nfs on
2. The NFS lock manager must run on all Linux stations on your network. Without this service, they will not be able
to access the database without receiving numerous “read lock” error messages. Type the following in a shell:
/etc/init.d/nfslock restart
/sbin/chkconfig nfslock on
Now you are ready to mount the directories from the server.
3. On each client computer, create directories for:
• /usr/local/ToonBoomAnimation/harmony_7.8
• /USA_DB
• /usadata000.
The directory names must match the names on the Toon Boom Harmony server.
mkdir /usr/local/ToonBoomAnimation/harmony_7.8
mkdir /USA_DB
mkdir /usadata000
4. To mount the directories on the client machine edit the /etc/fstab file.
In the following example, the server is the machine name of the database server.
server:/USA_DB /USA_DB nfs rw,soft,intr,bg 0 0
server:/usadata000 /usadata000 nfs rw,soft,intr,bg 0 0
server:/usr/local/ToonBoomAnimation/harmony_7.8 /usr/local/ToonBoomAnimation/
harmony_7.8 nfs rw,soft,intr,bg 0 0
This will cause the Toon Boom Harmony directories to mount with the default version of NFS on your system.
If you encounter errors, you should try using NFS version 2. In this case, you should modify the fstab file to
match the following:
server:/USA_DB /USA_DB nfs rw,soft,intr,bg,vers=2 0 0
server:/usadata000 /usadata000 nfs rw,soft,intr,bg,vers=2 0 0
server:/usr/local/ToonBoomAnimation/harmony_7.8 /usr/local/ToonBoomAnimation/
harmony_7.8 nfs rw,soft,intr,bg,vers=2 0 0
5. At a command line, type the mount all command.
mount -av
To verify that all of the shares are mounted, type the following in a shell:
mount
A report appears listing all of the shares mounted on the client.
6. To test that the mount has worked, you can open one of the mounted directories and list the contents. You can
also open the sample scene in the Stage Module.
a To list the contents of the mounted directories, type the following in a shell:
cd /usr/local/ToonBoomAnimation/harmony_7.8
ls
A list appears of the directories in /usa. They are:
etc help lang lnx86 resources
b To open the sample scene in the Stage Module type the following in a shell:
Stage
c Select the Connect to Database radio button and login using the usabatch user name.
d Open the sample scene.
If you have any problems opening the sample scene on a Linux client, see Troubleshooting, on page 34.
32
Installing on Linux
33
Harmony Installation Guide - Linux Operating Systems
Troubleshooting
If you have any problems running Harmony after installation, review the installation and configuration instructions to
make sure you have followed them completely. If you continue to have problems, consult the following list to
troubleshoot common installation and configuration problems.
• Problem: License Error When Starting Any Toon Boom Harmony Module, on page 34
• Problem: Unable to Import Sample Scene (Errors with the Dbserver), on page 34
• Problem: Unable to Open Sample Scene on Linux Clients, on page 35
• Problem: Stage Module Will Not Open or Crashes on Startup, on page 35
• Problem: Unable to Display Images in Stage Module, on page 35
• Problem: Exported Directories Not Mounting on Clients, on page 36
34
Installing on Linux
35
Harmony Installation Guide - Linux Operating Systems
36