Skip to content
Web of Things (WoT) Thing Directory
Go Dockerfile
Branch: master
Clone or download

README.md

Web of Things (WoT) Thing Directory

Docker Pulls GitHub tag (latest pre-release) Build Status

This is an implementation of the Web of Things (WoT) Thing Directory which provides a RESTful API to maintain Thing Descriptions.

This is currently under development.

Getting Started

API Documentation: OpenAPI Specification

Installation

Binary Distribution

  1. Download the binary distribution and configuration file from releases
  2. Download the WoT Thing Description JSON Schema document. E.g. wot_td_schema.json
  3. Run, e.g. in Linux/AMD64:
./thing-directory-linux-amd64 --conf ./thing-directory.json --schema ./wot_td_schema.json

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

Docker

Run the latest build of Thing Directory with the default configuration file (/conf/thing-directory.json):

docker run -p 8081:8081 linksmart/td

The index of the RESTful API should now be accessible at: http://localhost:8081

The configurations can be changes by mounting a directory and providing the paths in CLI arguments. For more information about the CLI arguments, set --help flag.

Please refer to the API Documentation to learn about the different endpoints.

Development

The dependencies of this package are managed by Go Modules.

To Compile from source:

git clone https://github.com/linksmart/thing-directory.git
cd thing-directory
go build
You can’t perform that action at this time.