Before you start
Before starting the system, please ensure that at least 85% of your disk space is available. Rosette Identity relies on Elasticsearch as its primary data store. Whenever the available disk space drops below 85% of the total hard drive, Elasticsearch will go into read-only mode and the system will no longer function properly.
Rosette Identity is resource intensive on CPU, memory, disk, and network (making calls to Rosette API). In order to run it properly, make sure there are no other processes consuming memory and cpu and that you have an internet connection.
Verify your Configuration
Verify that your license is in place. From the Rosette Identity installation folder, run the following command:
ls -l bt_roots/licenses/
rlp-license.xml is listed, your license is in the correct location.
Verify that your ROSETTE_API_KEY is set:
If a key (such as e02a6de57b62123c16c00263812e8c59) is returned, your API key is set properly.
if you are using external Elasticsearch and DGraph services for the KB, they must be running before you start Identity.
Stop all applications other than Docker. Docker should be installed and running.
identity directory, start the application (this could take a few minutes):
When using the full Wikidata KB, the first time you run the system it will take about 20 minutes to prepare the ES data folder.
To start with the full Wikidata KB (the first start up takes time!)
To start with a pruned Wikidata KB
To start with no Wikidata KB
To start with an external Wikidata KB
ELASTIC_HOST=xxx.xxx.xxx.xxx DGRAPH_HOST=xxx.xxx.xxx.xxx ./startup.sh --ext-wiki
where xxx.xxx.xxx.xxx are the IP addresses of the external services
From a Chrome browser, open the application:
If running on a remote machine, replace
localhost with the IP address of the deployment machine.
If you run into issues getting the system up and running, the Docker
--verbose flag may provide useful debugging information:
docker-compose --verbose up
The shutdown flags must correspond to the flag used for startup. For example, if you started the system with a
--full-wiki flag, you must call the shutdown script with the
--full-wiki flag as well.
-v flag deletes all the data folders, clearing out all data loaded into the system. Do not use the
-v flag with the external KB.
To shutdown the application after starting with the full Wikidata KB
./shutdown.sh --full-wiki -v
To shutdown the application after starting with a pruned Wikidata KB
./shutdown.sh --pruned-wiki -v
To shutdown the application after starting with no Wikidata KB
./shutdown.sh --no-wiki -v
To shutdown the application after starting with an external Wikidata KB
The KB and all ingested and created entities are only retained when using an external KB. No data is saved when using the other KB types.
In the UI, on the bottom of the Upload Index window, there are two options to reset
Reset System: Returns the system to its original state. All processed text files, in addition to any uploaded custom KBs, are deleted. The built-in Wikidata KB is not deleted.
Clear Data: Deletes only the processed text files, leaving the built-in Wikidata KB in addition to the user loaded custom KB.