About This Guide
This Administration Guide explains how to administer ManualWorks, organized into parts. You can go directly to the part you need.
To learn how to install ManualWorks, see the ManualWorks 6.0 Installation Guide. To learn how to use ManualWorks, see the ManualWorks 6.0 User Guide.
The screenshots in this guide still show the Korean user interface. English screenshots will be added in a future update. Menu and button names in the text follow the English user interface.
This guide is organized as follows.
UI Settings: Explains how to set up the UI, including the logo, colors, icons, and date formats.
Menus: Explains the structure of the Admin menu.
Default UI Font: Explains how to set the default UI font.
Applying Custom CSS to the Entire UI: Explains how to apply CSS created as a web page to the entire UI.
Applying Custom JavaScript to the Entire UI: Explains how to apply JavaScript created as a web page to the entire UI.
Changing Labels and Messages: Explains how to override labels and messages.
Language Settings: Explains how to set the default language and how to use Japanese and Chinese.
Managing Users: Explains how to create users and set their permissions.
Managing Groups: Explains how to create groups and assign users to them.
Login: Explains login-related topics.
Two-Factor Authentication: Explains how to use two-factor authentication.
Handling User Login with JSP: Explains how to handle user login with JSP.
Viewing All Documents: Explains how to view the list of all documents.
Encrypting User Names and Email Addresses in the Database: Explains how to store user names and email addresses encrypted in the database.
General Settings: Explains the general settings.
Document Options: Explains how to set the default options for new documents.
Configuring Mail: Explains how to configure the mail server.
Changing the License Key: Explains how to change the license key.
Setting the Network Interface: Explains how to fix the network interface used to generate the server ID.
Logging In with Google: External users sometimes need to log in, for example to write comments. Explains how to let them log in with a Google account.
Logging In with Facebook: External users sometimes need to log in, for example to write comments. Explains how to let them log in with a Facebook account.
Logging In with Naver: External users sometimes need to log in, for example to write comments. Explains how to let them log in with a Naver account.
Logging In with LDAP: Explains how to log in with LDAP.
Managing Users with OAuth 2.0: Explains how to log in with OAuth 2.0.
Web Crawlers: Explains how to set and test web crawler patterns.
Controlling Access by IP Address: Explains how to control access by IP address.
Starting and Stopping ManualWorks: Explains how to start and stop ManualWorks.
Log Files: Explains log files.
Scheduler: Explains how to set up the scheduler.
Managing Work: Explains how to manage Work.
System Statistics and Monitor: Explains how to view system statistics and monitor the system.
Console: Explains how to use the console.
Backup and Restore: Explains how to back up and restore data.
Data Directory: Explains the ManualWorks data directory.
Changing the Data and Backup Directory Locations: Explains how to move the data and backup directories.
Encrypting Database Connection Information: Explains how to encrypt the database connection information in the
server.xmlfile.Moving the Server: Explains how to move ManualWorks to another server.
Migrating the Database: Explains how to migrate the database to another database. Currently, only migration to MySQL is supported.
Changing Port Numbers: Explains how to change the port numbers.
Setting Up HTTPS: Explains how to set up HTTPS.
Redirecting HTTP Requests to HTTPS: Explains how to redirect HTTP requests to HTTPS.
Using Port 80 with iptables: Explains how to use port 80 with iptables on Linux.
Setting Startup Script Options: Explains how to set startup script options.
Applying gzip Compression: Explains how to compress HTTP responses with gzip to reduce network traffic.
Server Redundancy: Explains how to set up redundant servers.
Setting the HTTP Session Timeout: Explains how to set the HTTP session timeout.
Server Timing API: Explains how to check server processing time with the Server Timing API.
Handling File Uploads: Explains topics related to file uploads.
Deleting Unused Uploaded Files: Explains how to find and delete uploaded files that are no longer used.
Changing the Java Heap Size: Explains how to change the Java heap size.
Clearing the Java Heap Memory Cache: Explains how to use the scheduler to clear objects that stay in the Java heap, to optimize heap memory.
Changing Java for the Windows Service: Explains how to change Java when ManualWorks is registered as a Windows service.
Configuring JMX: Explains how to set up the JMX menu.
Software Update: Explains how to update the software.
Updating the Software Manually: Explains how to update the software manually.
Conventions
This guide uses the following formatting conventions.
Item | Description | Example |
|---|---|---|
Emphasis | Words and sentences that need emphasis are shown in bold. | Emphasis |
Menus and links | Menus, links, and similar items are enclosed in < and >. | <Delete> |
Keyboard shortcuts | Keys that you press at the same time are joined with + and shown in a monospace font. | Ctrl + I |
Code and file names | Code, commands, file names, and similar items are shown in a monospace font. |
|
This guide provides notes, tips, and cautions as follows.
A note provides a short explanation, reference, or comment that supplements the text.
A tip provides helpful hints.
A caution calls your attention to something important.
Reporting Errors and Questions
If you find a technical error or a typo, or if there is anything you would like us to correct or add, please email us at support@3rabbitz.com.
In the web viewer, when you select text with the mouse, the <Send Change Request> button appears. You can also click this button to send a change request.