Maloja

Setup a Maloja server if you have not already done this.

Maloja Setup Intructions

Using Maloja’s example docker-compose.yml:

~/malojaData/docker-compose.yml

services:
  maloja:
    # from dockerhub
    image: "krateng/maloja:latest"
    # or built locally
    #build:
    #  context: .
    #  dockerfile: ./Containerfile
    ports:
    - "42010:42010"
    # different directories for configuration, state and logs
    volumes:
    - "$PWD/config:/etc/maloja"
    - "$PWD/data:/var/lib/maloja"
    - "$PWD/logs:/var/log/maloja"
    #you can also have everything together instead:
    #volumes:
    #- "$PWD/data:/data"
    #environment:
    #- "MALOJA_DATA_DIRECTORY=/data"

View on GitHub

Uncomment environment and add MALOJA_FORCE_PASSWORD=CHANGE_ME to set an admin password

Start the container:

~/malojaData

docker compose up -d

• Navigate to the Admin Panel (Cog in upper-right corner) -> API Keys (or at http://myMalojaServerIP/admin_apikeys)
  • Create a New Key and then copy the generated key value

Finally, add the Maloja server URL and API Key to the configuration type you choose to use, below.

Configuration

ENV

Configuration Type

This is configuration for the ENV Config Type.

Environmental Variable	Type	Default	Description
MALOJA_ID	string		A globally unique ID EX myComponentId
MALOJA_NAME	string	Value of MALOJA_ID	A vanity name EX My Cool Component
MALOJA_ENABLE	boolean	true	Should this component be used?
MALOJA_URL	string		URL for maloja server
MALOJA_API_KEY	string		API Key for Maloja server

Bold/Italic = Required

File

Config Structure

This displays the structure of the File Configuration for a maloja type Client with all possible properties, their shape, and descriptions/types. Use this to understand how to write a valid config.

Config Example

This displays an example config file of a maloja Client File Configuration that adheres to the shown Config Structure.

• text mode lets you edit the JSON directly.
• tree mode gives you a guided point-and-click editing experience that always keeps the JSON syntax valid.

Both modes validate that the configuration is correct. Any errors show up as squiggly lines.

Important

Only client maloja configs will validate correctly in the editor but both source and client maloja configs are allowed in the real CONFIG/maloja.json

After you finish editing, switch to text and then copy all text to get a completed config.

Config Example Mobile Experience

This displays an example config file of a maloja Client File Configuration that adheres to the shown Config Structure.

The example config file editor is meant for a larger screen experience so only the read-only example is shown. Please use this site on a tablet/laptop/desktop to enable file editor features.

CONFIG/maloja.json

[
  {
    "id": "myMalojaClient",
    "name": "Maloja Client",
    "data": {
      "url": "http://localhost:42010",
      "apiKey": "myMalojaKey"
    },
    "configureAs": "client",
    "enable": true
  }
]

AIO

Config Structure

This displays the structure of the all-in-one (config.json) configuration with all possible properties, their shape, and descriptions/types. Use this to understand how to write a valid config.

Select the maloja type from the respective clients node below, then expand it.

Config Example

This displays an example config file of a all-in-one (config.json) configuration that includes a maloja Client that adheres to the shown Config Structure.

• text mode lets you edit the JSON directly.
• tree mode gives you a guided point-and-click editing experience that always keeps the JSON syntax valid.

Both modes validate that the configuraion is correct. Any errors show up as squiggly lines.

After you finish editing, switch to text and then copy all text to get a completed config.

Config Example Mobile Experience

This displays an example config file of a all-in-one (config.json) configuration that includes a maloja Client that adheres to the shown Config Structure.

The example config file editor is meant for a larger screen experience so only the read-only example is shown. Please use this site on a tablet/laptop/desktop to enable file editor features.

CONFIG/config.json

{
  "clients": [
    {
      "type": "maloja",
      "id": "myMalojaClient",
      "name": "Maloja Client",
      "data": {
        "url": "http://localhost:42010",
        "apiKey": "myMalojaKey"
      },
      "configureAs": "client",
      "enable": true
    }
  ]
}