Setup
Download
You can download the application from OpenKM Download center.
To run the application on your computer you will need Java 11 installed.
Linux configuration
Unzip de Import-station-3.x. zip file at /home/openkm/
The name of the zip document might be changed.
$ cd /home/openkm
$ unzip Import-station-3.x.zip
In the /home/openkm/import-station/ folder you will have the following content:
- war file of the import-station application.
- plugins folder: what contains the list of plugins availables.
- import-station.cfg: configuration file.
- translations.sql: contains the translation terms of the application.
Register translations
You must register the import station translation in your OpenKM. The application is used for storing the import-station translations.
- Go to your OpenKM at Administration > Tools > Database Query.
- Copy all the SQL contents into the text area.
- Choose JDBC option from the bottom right.
- Click on the "Execute" Button.
Configure connection
Edit the import-station.cfg file with the following values:
| Property | Description |
|---|---|
|
okm.url |
OpenKM url http://localhost:8080/openkm/ |
|
okm.import.plugins.directory |
Path of the /home/openkm/import-station/plugins |
|
okm.login.token.expiration (optional) |
Token expiration time in days. By default has an expiration time of 24h. |
Launch the application
To launch the application use this command:
$ java -jar import-station.war
This will deploy a web application in the port 3000.
The application running opening the URL http://YOUR_SERVER_IP:/3000 in a browser ( for example http://localhost:3000/ ).
The first time you login into the application a file called import-station.db will be created into the /home/openkm/import-station/ folder.
The import-station.db file is an embeded database file, used by the application, which contains relevant information. Do not delete it!
Launch with custom cfg file
You can launch the app with your custom config file. For it, just set the absolute route to the configuration file as a parameter:
$ java -jar import-station.war /home/user/my-config.cfg
Application command line help
Running the application with the command help will print information about all available command line application options.
$ java -jar import-station.war help
Windows configuration
Unzip de Import-station-3.x. zip file at c:\openkm\
The name of the zip document might be changed.
In the c:\openkm\import-station\ folder you will have the following content:
- jar file of the import-station application.
- plugins folder: which contains the list of plugins available.
- import-station.cfg: configuration file.
- translations.sql: contains the translation terms of the application.
Register translations
You must register the import station translation in your OpenKM. The application is used for storing the import-station translations.
- Go to your OpenKM at Administration > Tools > Database Query.
- Copy all the SQL contents into the text area.
- Choose JDBC option from the bottom right.
- Click on the "Execute" Button.
Configure connection
Edit the import-station.cfg file with the following values:
| Property | Description |
|---|---|
|
okm.url |
OpenKM url http://localhost:8080/openkm/ |
|
okm.import.folder |
OpenKM default import path. /okm:root/import By default documents are imported to /okm:root/import |
|
okm.import.plugins.directory |
Path of the c:/openkm/import-station/plugins |
|
okm.login.token.expiration (optional) |
Token expiration time in days. By default, it has an expiration time of 24h. |
Launch the application
To launch the application use this command:
C:\> java -Dfile.encoding=UTF-8 -Dsun.jnu.encoding=UTF-8 -jar import-station.war
This will deploy a web application in the port 3000.
Access the application from the URL http://YOUR_SERVER_IP:/3000 in a browser ( for example http://localhost:3000/ ).
The first time you login into the application a file called import-station.db will be created into the c:\openkm\import-station\ folder.
The import-station.db file is an embeded database file, used by the application, which contains relevant information. Do not delete it!
Launch with custom cfg file
You can launch the app with your custom config file. For it, just set the absolute route to the configuration file as a parameter:
C:\> java -Dfile.encoding=UTF-8 -Dsun.jnu.encoding=UTF-8 -jar import-station.war c:/my-config.cfg
Application command line help
Running the application with the command help will print information about all available command line application options.
C:\> java -jar import-station.war help
