README
¶
Service Catalog
LinkSmart Service Catalog is a registry enabling discovery of other web services via a RESTful API or through an MQTT broker.
Getting Started
- Read the Wiki
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.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package catalog contains the core functionalities of service catalog and exposes functions and structs for service representation, processing, and storage
|
Package catalog contains the core functionalities of service catalog and exposes functions and structs for service representation, processing, and storage |
|
Package client offers utility functions for service registration
|
Package client offers utility functions for service registration |
|
Package discovery contains utility functions, which help to implement various use-cases of executing some logic as a result of DNS-SD service lookup
|
Package discovery contains utility functions, which help to implement various use-cases of executing some logic as a result of DNS-SD service lookup |
|
Package utils offers utility functions for http requests, pagination, and filtering
|
Package utils offers utility functions for http requests, pagination, and filtering |