Skip to content

Latest commit

 

History

History
49 lines (38 loc) · 1.99 KB

README.md

File metadata and controls

49 lines (38 loc) · 1.99 KB

Service Catalog

GoDoc Docker Pulls GitHub release (latest SemVer) Build Status

LinkSmart Service Catalog is a registry enabling discovery of other web services via a RESTful API or through an MQTT broker.

Getting Started

Deployment

Configuration

The configuration is possible using a JSON file or by setting environment variables. It is described here.

Docker

The following command runs the latest release of service catalog with the default configurations:

docker run -p 8082:8082 linksmart/sc

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

To run on other architectures (e.g. arm32, arm64), clone this repo and build the image locally first by running:

docker build -t linksmart/sc .

Binary Distributions

These are available for released versions and for several platforms here.

Download and run:

./service-catalog-<os-arch> --help

Development

The dependencies of this package are managed by Go Modules.

To compile from source:

git clone https://github.com/linksmart/service-catalog.git
cd service-catalog
go build -mod=vendor

Contributing

Contributions are welcome.

Please fork, make your changes, and submit a pull request. For major changes, please open an issue first and discuss it with the other authors.