Data Directory

3RABBITZ_HOME refers to the directory (folder on Windows) where ManualWorks is installed.

ManualWorks stores all its data in the 3RABBITZ_HOME/data directory.

If you changed the data directory during installation, check its location in the DB_DIR property of the 3RABBITZ_HOME/preference.properties file.

The main subdirectories are as follows.

backup

The backup directory. If you changed the backup directory during installation, check its location in the BACKUP_DIR property of the 3RABBITZ_HOME/preference.properties file.

If the database is H2 or Apache Derby, the database is backed up regularly. For H2, the backup files are daily_yyyy-MM-dd.zip. For Apache Derby, they are base_yyyy-MM-dd.jar and daily_yyyy-MM-dd.jar.

If the database is H2 or Apache Derby, the transaction logs are in the transaction directory.

Copies of uploaded files are kept in the upload directory.

branch

Stores branch data.

content

Stores index files for search.

database

Stores the database files when the database is Apache Derby.

epub

Stores created EPUB files, in subdirectories by date.

font

Stores font files for creating PDFs.

h2

Stores the database file (database.mv.db) when the database is H2.

html

Stores created HTML files, in subdirectories by date.

monitor

Stores monitor data.

ngram

Stores index files used for document search.

pdf

Stores created PDF files, in subdirectories by date.

quarantine

Keeps files quarantined in the <Admin | Servers | Unused Uploads> menu.

static

Stores the content of static documents.

statistics

Keeps saved system statistics.

tex

Contains tex files for PDF hyphenation.

theme_preview

Stores preview image files used by PDF themes and PDF page layouts.

update

Stores software update files.

upload

Stores uploaded files, in subdirectories by date.

vector_store

Stores vector store data.

visit

Stores visit statistics data.

word

Stores created Word files, in subdirectories by date.

If the database is Oracle, MS SQL, or MySQL, there are no database and h2 directories.

The .key.json file in the data directory is the key file used to encrypt user names, email addresses, and the API keys of AI providers. This file is not included in ManualWorks backups. If you lose it, encrypted data cannot be read, so be sure to back it up separately.

Directories such as content and theme_preview are recreated automatically when their files are missing, so you do not need to back them up.

Backing Up the Data Directory Manually

If you back up manually, back up all directories except backup. Depending on your situation, you can skip some directories.

The epub, html, pdf, upload, and word directories contain subdirectories by date. Back up only the directories created after the last backup.
- Starting with ManualWorks 6.0, data is stored hierarchically in year/month/day directories.
If you do not use tags, or the files created when tagging are not important, you can skip the epub, html, pdf, and word directories.
If you have not added new fonts, you do not need to back up the font directory.
If you do not use PDF hyphenation patterns, you do not need to back up the tex directory.
Always back up the .key.json file.
If the database is Oracle, MS SQL, or MySQL, use the backup features of that database.
With Apache Derby, instead of the database directory, you can back up only the base_yyyy-MM-dd.jar or daily_yyyy-MM-dd.jar files and the transaction directory in the backup directory. With H2, instead of the h2 directory, you can back up the daily_yyyy-MM-dd.zip files and the transaction directory in the backup directory. For details, see Backup and Restore.

Cleaning Up Unused Directories and Database Tables

When ManualWorks is updated, tables and columns are added, but existing tables and columns are not deleted. As a result, storage space is wasted over long use. This feature cleans them up.

Go to the <Admin | Servers | File System> menu.
Click the <1Clear Files> link.
Click the <2Inspect> link.
Select a directory or table in the list, and click the 3 button to delete it.