User guide v4.x
Encryption Tool allows you to encrypt several documents and upload them to the OpenKM repository, as well as download and decrypt them locally.
Server configuration
Choose File / Configuration menu option to show the configuration popup.
The available configuration parameters are:
Property | Type | Description |
---|---|---|
Language |
Select |
User interface language. |
User |
String |
User id for accessing OpenKM. user1 |
Password |
String |
The password of the user. pass1 |
Host |
String |
OpenKM URL. http://localhost:8080/openkm/ |
Use personal token |
Bool |
The authentication will be done with the access token. |
Personal token | String |
The personal access token okmpat-Ky1t16O2Rwx4ttPmOK0R |
To accept configuration parameters changes, click Accept button.
Encrypt and upload documents
- Select one or more documents and drag and drop them on the main application window.
- Go to the "File" menu and select the "Encrypt and upload" option.
- Enter the password required to encrypt.
- Select the path within OpenKM to upload the encrypted documents.
Download and decrypt documents
- Go to the "File" menu and select the "Download and decrypt" option.
- Search and select one or more encrypted documents from the OpenKM repository.
- Enter the password required to decrypt the document.
- The decrypted documents are in the path:
C:\Users\[you_user]\Documents\OpenKM\OKMEncryption\decrypt
Encrypt or decrypt documents in OpenKM
- Go to the "File" menu and select the "Encrypt a file in OpenKM" or "Decrypt a file in OpenKM" option.
- Search and select one or more documents from the OpenKM repository.
- Enter the password required to be encrypted or decripted.
Alternative configuration of the main file folder
To configure a custom path for storing key application files such as:
- The log file (openkm.log)
- The configuration file (openkm.xml)
- Temporary files generated during runtime
This configuration is done using the okm.folder.path property, located in the app.properties file within the installation directory.
Example:
okm.folder.path=C:\\New_folder_path
When to Use This Configuration:
This option is especially useful when there are issues using the default file paths, such as:
-
Insufficient file system permissions
-
Limited disk space or access restrictions in the default location
-
Need to separate system files from configuration and data
-
IT infrastructure policies or organization requirements
After making the changes, you must restart the app.
Log
In My Documents/OpenKM there's a file log called OKMEncryption.log with a complete log trace.