Xitmer Documentation

Note: This documentation is of the latest version of the Xitmer client software. If you find any information in this documentation to be not working, then please ensure you have the latest version of the software (v0.5.2) installed on your system.

Configuration

Some aspects of the Xitmer client are configurable using config files. The main config file for the Xitmer client is xitmer.json which you will have to create in the installation directory if you would like to make configuration changes as described in the document.

Changing data directory location

Xitmer uses a data directory to store configuration and runtime files. It is created in the installation location by deafult during the time of installation.

However, you may move the data directory to some other location on your system from the default installation directory if you like. If you do so, then please update the xitmer.json configuration file to specify the new location as shown in the below example:

{
    "data_dir":"D:\\Data\\Xitmer_Data"
}

Changing modules directory location

Xitmer stores all its modules in a modules directory which is created in the installation location by deafult during the time of installation.

However, you may move the modules directory to some other location on your system from the default installation directory if you like. If you do so, then please update the xitmer configuration file to specify the new location as shown in the below example:

{
    "modules_dir":"D:\\Data\\Xitmer_Modules"
}

Setting default SCM provider

After you have installed the Xitmer client on your system, you will need to configure it if you wish to work with remote code repositories like GitHub and GitLab.

The default SCM provider and its access information is set in the config.json file which is located in the configs folder of the Xitmer data directory. You can change the default settings set in the file during installation as per your requirement. A default example settings is given below:

{
    "scm_remotes":{
        "gitlab":{
            "domain": "gitlab.com",
            "url": "https://gitlab.com",
            "ssh_key_path": "D:\\Credentials\\GitLab\\id_ed25519"
        },
        "github":{
            "domain": "github.com",
            "url": "https://github.com",
            "ssh_key_path": "D:\\Credentials\\GitHub\\id_ed25519"
        }
    },
    "default_remote_scm": "gitlab"    
}

You can sepecify multiple SCM remotes as shown in the above example and set one as the default. Once defined here you can use the SCM keys in this file while defining the SCM remotes for your application that you will run through Xitmer.