1. Install required software
- 1.1) Install the Java 6 JDK or Java 7 JDK (you don't need NetBeans or Java EE). Asset Bank requires Java 6 or higher (on the server). We recommend that you use the Server JVM which means that you should download the JDK instead of the JRE, because the JRE only comes with the Client JVM.
- 1.2) Install Tomcat version 6.0.26 (Please do not install Tomcat 7). On Red Hat distributions we recommend installing a standard binary distribution instead of a packaged managed version of tomcat. See points 3 and 8 for notes about configuring Tomcat.
- 1.3) If you do not already have a database, install the latest version of MySql. Currently we recommend MySQL 5.0 Community Edition.
- 1.4) Make sure that the image libraries are installed for the formats you want to support. For example, commonly required libraries are:
- liblcms-devel (http://www.littlecms.com)
- If you want to convert EPS files, install Ghostscript (http://www.ghostscript.com). We currently recommend installing GhostScript version 9.0.6.
On Red Hat-based distributions you may be able to install the headers and libraries required to compile ImageMagick and GhostScript from source with the commands:
Similarly on Debian you may be able to install these headers and libraries with:
apt-get build-dep imagemagick
apt-get build-dep ghostscript
- 1.5) Install ImageMagick (http://www.imagemagick.org/). We currently recommend installing ImageMagick version 18.104.22.168.
- 1.6) Install ExifTool.
If you need to install from source then follow the above link or download version 8.68 and install as follows:
gzip -dc Image-ExifTool-#.##.tar.gz | tar -xf -
sudo make install
- Exiftool will be installed to /usr/local/bin by default. Make sure this is in the PATH for the user running Tomcat.
- 1.7) If you want Asset Bank to support RAW formats, install DCRAW. This is a single C file, which should be compiled (e.g. using gcc -o dcraw -O4 dcraw.c -lm -ljpeg -llcms) and placed in the PATH. (e.g. /usr/bin). On Red Hat you can use the package manager to install it (i.e. yum install dcraw).
- 1.8) If you want to convert video files, install FFmpeg (http://ffmpeg.mplayerhq.hu/download.html). Step-by-step instructions for building and installing Ffmpeg on Linux.
- 1.9) After installing software make sure that any services that are critical to Asset Bank running (Tomcat, MySQL, SMTP etc.) are set to automatically startup if they stop. This will make sure Asset Bank doesn't require manual intervention to get back up and running if the server ever goes down unexpectedly. If the application is considered business critical then you could also set up URL monitoring.
2. Install the webapp
- 2.1) Download the Asset Bank zip: asset-bank.zip
- 2.2) Unzip the installation package to a convenient location on your hard drive. This will create a directory called 'asset-bank'.
- 2.3) Shutdown Tomcat (if it is running).
- 2.3) Move the directory 'asset-bank' into [Tomcat]/webapps.
3. Configure Tomcat
- 3.1) For security reasons, don't run Tomcat as root. For example, create a user called 'tomcat' and run as that.
- 3.2) Ensure that the user that will be running Tomcat (usually called ‘tomcat’) has recursive read/write permissions on the following directories. For example, set tomcat to be the owner recursively.
- 3.3) Copy the file [tomcat]/asset-bank/WEB-INF/manager-config/tomcat/setenv.sh into [tomcat]/bin.
Edit this file to ensure that the memory settings for Tomcat are suitable for your server. This step is necessary as by default Tomcat will not be given optimal memory to run as a production server.
- 3.4) Turn off automatic deployment and reloading of the Asset Bank application by Tomcat.
- Open the file [Tomcat]\conf\server.xml in a text editor.
- Search for the string "autoDeploy". You should see something similar to
<Host name="localhost" appBase="webapps" unpackWARs="true" autoDeploy="true" xmlValidation="false" xmlNamespaceAware="false">
- If there are multiple host entries look for the one which applies to your Asset Bank application.
- Set autoDeploy="false"
- When Tomcat is installed auto reloading of applications is turned off by default. If for any reason you have changed this please ensure that reloadable is set to false for the Asset Bank application. See http://tomcat.apache.org/tomcat-4.1-doc/config/context.html for details.
- 3.5) ONLY use this section (3.5) if you want Tomcat to access the application on port 80 and do not want to use a separate web server. If you want to use a separate web server ignore this part and move on to 3.6! (see section 8, below), Tomcat has a production-quality web server built in - you just need to change the port it listens on from 8080 to 80.
To do this:
- - Open the file [Tomcat]\conf\server.xml in a text editor.
- Search for the string <Connector port="8080" and replace 8080 with 80.
3.6) Open the file [Tomcat]\conf\server.xml in a text editor and add the attribute URIEncoding="UTF-8" to the “Connector” element, as shown here:
<Connector port="8080" protocol="HTTP/1.1"
4. Edit ApplicationSettings.properties
The settings file is in [tomcat]/asset-bank/WEB-INF/classes
Most of the settings in this file can stay as they are. Settings that you must change:
- imagemagick-path - this should point to the directory containing the image magick executables (e.g. 'convert'). This is usually /usr/local/bin or /usr/bin.
- The FTP properties (beginning 'ftp') - see below for more information about FTP.
- emailSMTP - set to the URL of your SMTP mail server.
If you are installing an Enterprise version of Asset Bank that has Multi-Language enabled, please refer to this knowledge base article.
5. Install license
You will have received a license file license.lic by email. This is valid for 30 days (for evaluation) or indefinitely (for production).
Copy the license file license.lic to
6. Set up the database
Follow the database setup instructions in Database & Advanced Setup
7. Logging settingsPlease ensure that you set the log level to 'info' in the top line of both files mentioned below.
8. (Optional) Set up FTP for Bulk Upload
By default, users can upload files for 'Bulk Upload' using a Flash control or Java applet, which is shown on the first page of the Bulk Upload process.
If you do not want your users to use Flash or the applet for bulk upload, users can upload their files for Bulk Uploading using FTP. To enable this you need to install or enable an FTP server. If you don't have a preference, we recommend VSFTP.
You then need to create an FTP user, for example called assetbank-ftp. For security reasons this user should be jailed in their home directory.
The property 'bulk-upload-directory' in the ApplicationSettings.properties file should point to the home directory of the FTP user. The easiest way to do this is to create a symbolic link in [tomcat]/asset-bank called 'bulk-upload', pointing to the FTP user's home directory. If you do this then you don't need to change the value of the setting as it is that by default.
Both the FTP user and Tomcat need to be able to read and write to this 'bulk-upload' directory. The easiest way to do this is by ensuring that the Tomcat user and the FTP user are in the same group and giving group read/write permissions on the directory.
To use FTP rather than the applet, ensure that the setting 'bulk-upload-use-applet' is set to false.
9. Tomcat memory tuning
Tomcat's default memory allocation is not optimal for a production server. If you have 1GB or more of RAM, you should change the amount of memory that is available to Tomcat.
- Copy the file [Tomcat]\webapps\image-bank\WEB-INF\manager-config\tomcat\setenv.sh into the directory [Tomcat]\binand adjust the numbers within (see the comment at the top of the file).
- You should restart Tomcat after changing these settings.
10. Start the Application
- 9.1) Start or restart Tomcat.
- 9.2) Ready to run - you should be able to access the Asset Bank on http://localhost/asset-bank/ from a browser on the server, or http://[server ip address]/asset-bank/
- from any other computer on your network.
Note: If you did not follow step (3.5) or (11) then you will need to specify port 8080, e.g. http://[server ip address]:8080/asset-bank/
- 9.3) The application will start with a “Setup Wizard” which will allow you to easily set up your Asset Bank.
Note: On first run the “Setup Wizard” will ask you for a password to prevent access from non-admin users. This password can be changed using the setting setup-wizard-password in the ApplicationSettings file.
- 9.4) Login as the default admin user:
- Username: admin
- 9.4) Change the password of the default admin user ‘admin’ by going to the 'Your Profile' link in the top right. This is important as it is easy to forget that this user exists once you start adding your own, and it is especially important, for obvious security reasons, if your Asset Bank is available online. Alternatively, remember to delete this user as soon as you have added one or more other admin users.
11. Upgrade to the latest version
The installer may not contain the most recent version of Asset Bank (although it should be close!) To upgrade your Asset Bank to the latest version (assuming you have a license that allows it), then please follow these instructions.
12. Integrate Tomcat with Apache (optional)
13. Backup procedure
You need to ensure that the database and files are backed up regularly (we advise nightly). For information on backing up and restoring Asset Bank please read our knowledge base article.
If you want to uninstall Asset Bank
Please proceed to uninstall all of the pre-requisite software - as mentioned in step 1 - and drop the database that was generated during step 6. To complete the uninstall, stop Tomcat, delete the Tomcat]\webapps\asset-bank folder and restart Tomcat. You may also wish to revert changes to your Tomcat installation as mentioned in step 8 and changes made to your web server in step 11.