Installation Setup | Documentation

View production requirements in Preparation documentation before continuing.

Directory Structure

Logment
├── compose.yml
└── config.json

Compose File

File Setup

Use the following for the compose.yml file:

services:
    logment:
        image: oci.registry.sudovanilla.org/ubikute-relay:amd64 # or arm64
        ports:
            - 7590:8085
            - 7600:4500
        volumes:
            - ./config.json:/relay/config.json
            - ./database:/deno-dir/location_data
        environment:
            - API=http://localhost:4500
            - STATUS=http://localhost:7440
            - API_KEY=RANDOM_KEY_HERE

Choice of Architecture

The OCI images available for Docker and other container software are available for both amd64 and arm64 system architecture. By default, amd64 is already selected in the compose.yml file as it’s more common to see in servers. This is shown at the end of the OCI image name in the image section.

If your server does not run on either of the architecture, then you’ll need to build the OCI image on the server itself, if that is the case please continue to Building OCI Image.

Architecture	OCI Image
`amd64`	`oci.registry.sudovanilla.org/ubikute-relay:amd64`
`arm64`	`oci.registry.sudovanilla.org/ubikute-relay:arm64`

Configuration

Use the following for the config.json file:

{
    "api_key": "RANDOM_KEY_HERE",
    "login": {
        "username": "Username",
        "password": "Password"
    },
    "instances": {
        "api": "http://localhost:4500",
        "status": "http://localhost:4321"
    }
}

Make sure that all configurations between both files match.

Launch

Retrieve the OCI image:

docker compose pull

Then launch:

docker compose up -d

Within a few moments, Logment will be able on http://localhost:7590.

If it still not available yet at the port 7590, then it may still be building or something was mis-configured resulting in error. To check the status, run the log command:
docker compose logs --follow

Init Setup

Go to the url http://localhost:7590/init and login with the username and password you setup in the config.json file. Then fill out the fields to apply your settings to your status page.

Settings are applied automatically during first boot, so using /init is required or the status page won’t work.

Source Code