Before You Begin

Replacing the License Key When You Move the Server

When you move ManualWorks to another server, the server ID changes, so you must replace the license key. Note the following.

Reissuing a license key is a service for customers within the free maintenance period or with a maintenance contract. If the free maintenance period has ended and you have no maintenance contract, moving the server incurs a fee.
You can get a new license key only after you start ManualWorks on the new server and check the new server ID.

Checking Network Connections

If you use a database other than the default one, such as Oracle, the new server must also be able to connect to it. Check firewalls and other settings for the following.

External database
Mail server (if you configured a mail server)
LDAP server (if you configured LDAP)
OAuth 2.0 authorization server (if you configured OAuth 2.0)

Moving the Server

3RABBITZ_HOME refers to the directory where ManualWorks is installed.

Updating to the Latest Version

Before you move the server, update ManualWorks to the latest version of its major version. For details, see Software Update.

Copying ManualWorks

If the old and new servers run the same operating system, copy ManualWorks from the old server to the new server. If they run different operating systems, install ManualWorks fresh on the new server.

Same Operating System

If you move ManualWorks from Linux to Linux (or UNIX) or from Windows to Windows, do the following.

Stop ManualWorks on the old server.
Copy the entire 3RABBITZ_HOME directory to the new server.
- It does not have to be in the same location.

Different Operating Systems

If you move ManualWorks from Linux to Windows or from Windows to Linux, do the following.

Install ManualWorks for the operating system on the new server. For details, see the ManualWorks 6.0 Installation Guide.
Stop the newly installed ManualWorks.
Stop ManualWorks on the old server.

Copy the following files from the old server to the new server, into the same directories relative to 3RABBITZ_HOME.

3RABBITZ_HOME/preference.properties
3RABBITZ_HOME/crawler.properties (if it exists)
3RABBITZ_HOME/tomcat/conf/logging.properties
3RABBITZ_HOME/tomcat/conf/server.xml
3RABBITZ_HOME/tomcat/conf/web.xml
3RABBITZ_HOME/web/WEB-INF/web.xml
The 3RABBITZ_HOME/web/WEB-INF/lib directory

Copying the Data and Backup Directories

Check the locations of the data and backup directories in the 3RABBITZ_HOME/preference.properties file.

If the old and new servers run the same operating system and the data and backup directories are under 3RABBITZ_HOME, you can skip this step.

DB_DIR: The data directory location
BACKUP_DIR: The backup directory location

Relative paths start from the 3RABBITZ_HOME/bin directory.

If the data and backup directory locations differ between the old and new servers, update them in the 3RABBITZ_HOME/preference.properties file on the new server.

On Linux (UNIX), check that the operating system account that runs ManualWorks has write permission on the data and backup directories.

Copying Log Files

The default directory for log files is 3RABBITZ_HOME/logs. If you changed it, apply the change on the new server too.

If the old and new servers run the same operating system and the log directory is under 3RABBITZ_HOME, you can skip this step.

Check the log directory location in the 3RABBITZ_HOME/tomcat/conf/logging.properties file.
If the log directory does not exist on the new server, create it.
On Linux (UNIX), check that the operating system account that runs ManualWorks has write permission on the log directory.
If you changed the log directory location, also change the LOG_DIRECTORY setting to the new location so that you can see log files in the <Admin | Servers | Log> menu. Run set-preference -name LOG_DIRECTORY -value LOG_DIRECTORY_PATH in the Console.

If you need to see past logs, copy the log files from the old server to the log directory on the new server.

Copying HTTPS Certificate Files

If you set up HTTPS in ManualWorks rather than in a separate web server, copy the certificate files to the new server, referring to the following file.

3RABBITZ_HOME/tomcat/conf/server.xml

Starting ManualWorks

Start ManualWorks on the new server. For details, see this guide.

Replacing the License Key

When you start ManualWorks on the new server, the old license key is not valid, so menus and documents do not appear. Replace it with a license key for the new server.

If you installed ManualWorks fresh because the operating systems differ, you might not need to replace the license key.

Check the server ID of ManualWorks on the new server. Log in as a user with the “Administrator” role and check it in the <Preferences | License> menu.
Get a new license key. For details, see How to Get a License Key (in Korean).
Change the license key. For details, see Changing the License Key.

Changing the Base URL

If the domain or IP address changed, change the base URL. See Changing the Base URL.