Components Update Server (CUS)

The Components Update Server (CUS) is a web service delivering to WIKINDX installations (since WIKINDX v5.9.1) a list of compatible components with detailled informations and downloading location.

It is very basic and can be installed to mount multiple public mirrors or private mirrors. It is up to WIKINDX administrators to choose their preferred mirror in the software configuration.

The web service itself is the index.php file. It constructs dynamically responses from a database of files in JSON format. These files are generated by the WIKINDX packaging script.

During a release, the maintainer must manually populate the database with the files generated by the packager.

WARNING: the source code archive of a component will have a unique signature at each generation.

The files in the “core” directory give the correspondence between a version of WIKINDX and the expected compatibility versions of each type of component.

Examples of 6.4.3.json config file:

{
    "plugin": 9,
    "style": 5,
    "template": 1,
    "vendor": "6.4.3"
}

The files in the “components” directory describe each component that was published. The format is specified by on the page component.json format. Files are subclassified by type code (plugin, style…) then by compatibility version (27, 30, 6.1.3…). The format of its subfolders MUST respect the scheme <component_type>/<compatibility_version>/.

Server Folder Layout

Internal

  • cus
    • core:
    • components:
    • index.php: the web service itself since WIKINDX 6.3.6
  • downloads
    • components_server.php: the web service itself before WIKINDX 6.3.6

External of the primary official mirror

History

v2

CUS moved from https://wikindx.sourceforge.io/downloads/components_server.php to https://wikindx.sourceforge.io/cus/index.php since WIKINDX 6.3.6.

v1

CUS was first released alongside WIKINDX v5.9.1.