-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
068e98e
commit e204cc5
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,29 @@ | ||
# Impervious Releases | ||
|
||
This is the repository for impervious releases and supporting files and documentation. | ||
|
||
## Binaries | ||
TODO | ||
|
||
## Docs | ||
|
||
Markdown docs for the API's may be viewable in `/dbcs` for each service. There is a nice format of these docs imported into https://docs.impervious.ai as well. | ||
|
||
You may also see the docs on your Imp deamon by accessing it through the http proxy. By default: `localhost:8882/docs` | ||
|
||
## GRPC | ||
|
||
The Imp daemon API's can be accessible with both GRPC and HTTP. For accessing via GRPC, you may utilize the proto files located at `/proto/` of this repo. We have also generated a few client libraries so you can get started much faster by using them in your project. For now we support: `go` & `js` but if there's another language you'd like generated client libraries for, please let us know. | ||
|
||
## OpenAPI | ||
|
||
We also supply OpenAPIv2 files so that you may import them into your own tools, whether that's postman or something like https://editor.swagger.io | ||
|
||
These files are split up by service and can be accessible at `/openapiv2/` | ||
|
||
## Sample Config | ||
|
||
We have a base config file you may build off of to run with your Imp deamon. Copy `config.yml` to a location next to your deamon, fill in the blanks, and you can run with `impd --config=config.yml`. | ||
|
||
More info on the config can be found here: https://docs.impervious.ai/#impervious-node-configuration | ||
|