The directory is available as Docker Images as well as binaries for various architectures.

Run the latest build of Thing Directory with the default configuration file:

docker run -p 8081:8081 ghcr.io/tinyiot/thing-directory

The index of the HTTP API should now be accessible at: https://localhost:8081

To run a stable version of the directory, use tagged images. The tags are listed here and are similar to those on the repository.

The server configurations can be changed using environment variables or by replacing the entire configuration file by mounting a directory/file and providing the path as CLI argument. For more information about the CLI arguments, set --help flag.

The Docker image includes default JSON Schema for input validation. The path to these default files are set in server configuration.

1. Download the binary distribution and configuration file from releases
2. Run, e.g. in Linux/AMD64:

./thing-directory-linux-amd64 --conf ./thing-directory.json

For more information about the CLI arguments, set --help flag.

Refer to configurations for details on the configuration parameters.

By default, the inputs are not validated. Validation should be enabled explicitly as part of server configuration.

Refer to the Snap Store and follow the installation instructions: https://snapcraft.io/thing-directory