Webhook
In this section, you will find information about Horusec-Webhook service.
What is it?
Horusec-webhook is a microservice that triggers the data to third party services when the broker is enabled.
Requisites
To locally run this service, you will need:
- PostgreSQL (with migration applied);
- Horusec-Auth;
- Golang.
Installation
Step 1: Install dependencies:
go get ./...
Step 2: Run the service with the command below:
go run ./webhook/cmd/app/main.go
It will return this log:
service running on port :8004
swagger running on url: http://localhost:8004/swagger/index.html
Environment variables
These are the environment variables you can configure in this service:
| Environment Name | Default Value | Description |
|---|---|---|
| HORUSEC_SWAGGER_HOST | localhost | This environment variable gets which swagger host will be available. |
| HORUSEC_DATABASE_SQL_DIALECT | postgres | This environment variable gets the dialect to connet POSTGRES database. |
| HORUSEC_DATABASE_SQL_URI | postgresql://root:root@localhost:5432/horusec_db?sslmode=disable | This environment variable gets the URI to connect to POSTGRES database. |
| HORUSEC_DATABASE_SQL_LOG_MODE | false | This environment variable gets the value to enable POSTGREs logs. |
| HORUSEC_PORT | 8008 | This environment variable gets the port the service will start. |
| HORUSEC_BROKER_HOST | 127.0.0.1 | This environment variable gets a host to connect to RABBITMQ broker. |
| HORUSEC_BROKER_PORT | 5672 | This environment variable gets the port to connect to RABBITMQ broker. |
| HORUSEC_BROKER_USERNAME | guest | This environment variable gets the user name to connect to RABBITMQ broker. |
| HORUSEC_BROKER_PASSWORD | guest | This environment variable gets the password to connect to RABBITMQ broker. |
| HORUSEC_HTTP_TIMEOUT | 60 | This environment variable gets time in seconds to wait for a response after a HTTP request. |
| HORUSEC_GRPC_AUTH_URL | localhost:8007 | It gets the horusec-auth URL from the GRPC connection. |
| HORUSEC_GRPC_USE_CERTS | false | It validates the usage of GRCP certificate is enabled or not. |
| HORUSEC_GRPC_CERT_PATH | It gets the path of GRPC certificate. |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.
Last modified May 20, 2021: Horusec v2 (#59) (8b86c28f)