Topincs

Administrative tasks for Topincs are performed on the command line. This guide is written for a UNIX system, but all information can be applied with little or no changes to Windows systems.

The shell script TOPINCS_HOME/bin/topincs accepts two forms of commands. Store commands apply to a specific store, e.g. create-user or create-class. They must be run in the store directory which is located in TOPINCS_HOME/stores. General commands may be run from anywhere.

You can get instructions on a COMMAND by calling topincs help COMMAND. Running topincs without parameters will display the list of commands.

Any command can be abbreviated to your own liking, as long as the starting letter is used and the abbreviation is unique, e.g. you can write topincs crst instead of topincs create-store.

Prior Topincs 5 shell scripts were used instead of commands. These are now deprecated and should not be used anymore. If you add TOPINCS_HOME/bin to your path, only the topincs script can be used from any location. All other scripts must be called from TOPINCS_HOME/bin.

The behavior of Topincs can be influenced by setting configuration parameters. The general configuration file is TOPINCS_HOME/conf/topincs.ini. It applies to the Topincs installation and affects the behavior of all stores. The behavior of an individual store can be controlled by the parameters in the store configuration TOPINCS_HOME/stores/SOME_STORE/conf/store.ini.