Skip to content

How to create SiriKali custom backend

mhogomchungu edited this page Jul 31, 2019 · 5 revisions

An extension template looks like below.

To create a custom backend for SiriKali, take this template and then fill up all the options you need and place the file in ~/.config/SiriKali/backends or in $INSTALL_PREFIX/share/SiriKali/backends.

In Microsoft Windows operating system, the extension file can be placed in $SIRIKALI_BINARY_FOLDER/backends and extension programs can be stored in $SIRIKALI_BINARY_FOLDER/bin

The extension file name must have .json extension.

{
        "autoMountsOnVolumeCreation": false,
        "configFileArgument": "--config",
        "configFileNames": [],
        "createControlStructure": "%{createOptions} %{cipherFolder} %{mountPoint}",
        "executableName": "",
        "failedToMountTextList": [],
        "fileExtensions": [],
        "fuseNames": [],
        "idleString": "",
        "mountControlStructure": "%{mountOptions} %{cipherFolder} %{mountPoint} %{fuseOpts}",
        "names": [],
        "passwordFormat": "%{password}",
        "requiresAPassword": false,
        "reverseString": "",
        "successfullyMountedList": [],
        "supportsMountPointPaths": false,
        "unMountCommand": "",
        "version": 1.0,
        "volumePropertiesCommands": [],
        "windowsInstallPathRegistryKey": "",
        "windowsInstallPathRegistryValue": "",
        "windowsUnMountCommand": "",
        "wrongPasswordErrorCode": "",
        "wrongPasswordText": ""
}

Explanation for each option is below:

names

  • This option is required and fuseNames

fileExtensions

  • If the extension deals with files, then this option should be used to specify file extensions the backend can handle.
Clone this wiki locally