822c1baf85
* update http messaging to mproxy Signed-off-by: SammyOina <sammyoina@gmail.com> * Fix import path for mproxy module The import path for the mproxy module has been updated to github.com/sammyoina/mproxy v0.0.0-20231005134356-c44220b46ea0. This change ensures that the correct version of the module is used. This commit fixes the import path for the mproxy module, updating it to github.com/sammyoina/mproxy v0.0.0-20231005134356-c44220b46ea0. Signed-off-by: SammyOina <sammyoina@gmail.com> * Fix inconsistent variable naming in streams_test.go The variable "defaultTimout" was misspelled and should be "defaultTimeout". Also, the unused variable "configList" was removed. - Fix variable name "defaultTimout" to "defaultTimeout" - Remove unused variable "configList" Signed-off-by: SammyOina <sammyoina@gmail.com> * update mproxy Signed-off-by: SammyOina <sammyoina@gmail.com> * update mproxy Signed-off-by: SammyOina <sammyoina@gmail.com> * use auth connect Signed-off-by: SammyOina <sammyoina@gmail.com> * Fix incorrect HTTP status code in endpoint_test.go The previous commit introduced a mistake in the HTTP status code used in the endpoint_test.go file. The status code http.StatusUnauthorized was changed to http.StatusBadGateway. This commit corrects the status code to http.StatusBadRequest. This commit also includes a minor change in the things.go file. It adds three lines of code to the Authorize function. These changes ensure that the test cases and authorization logic are aligned with the correct HTTP status codes. Signed-off-by: SammyOina <sammyoina@gmail.com> * fix errors Signed-off-by: SammyOina <sammyoina@gmail.com> * Fix import formatting in message_test.go The import statements in message_test.go were not properly formatted. This commit fixes the formatting by organizing the imports and removing unnecessary commented code. - Import statements were organized and grouped together. - Unnecessary commented code was removed. This commit resolves the import formatting issue in message_test.go, ensuring that the codebase adheres to proper formatting conventions. Signed-off-by: SammyOina <sammyoina@gmail.com> * Fix import order and add missing import in endpoint_test.go The import order in the `endpoint_test.go` file has been fixed, and the missing import for `mainflux/mainflux` has been added. Signed-off-by: SammyOina <sammyoina@gmail.com> * Fix targetHTTPHost value in main.go and remove commented code in endpoint_test.go Summary: Fix targetHTTPHost value and remove commented code Body: - In main.go, fix the value of targetHTTPHost to "http://localhost" - In endpoint_test.go, remove commented code This commit fixes the targetHTTPHost value in main.go and removes unnecessary commented code in endpoint_test.go. The targetHTTPHost value was previously empty and has been updated to "http://localhost" to correctly specify the target HTTP host. Additionally, the commented code in endpoint_test.go has been removed for cleaner code. Signed-off-by: SammyOina <sammyoina@gmail.com> * Fix typo in log statement Signed-off-by: SammyOina <sammyoina@gmail.com> * Refactor HTTP server startup logic Refactor the logic for starting the HTTP server in the `main.go` file. Instead of directly starting the server and logging the server details, the code now uses a goroutine to start the server. This change improves code readability and maintainability. The commit message follows the best practices for writing commit messages. It starts with a succinct one-line summary of the changes, which is no longer than 50 characters. The summary is capitalized and written in the imperative mood. The summary is followed by a more detailed description, separated by a blank line. The body of the message provides context and reasoning behind the changes. Signed-off-by: SammyOina <sammyoina@gmail.com> * Fix import and variable assignment in main.go The import "github.com/mainflux/mainflux/pkg/messaging" was removed and the variable assignment for "h" in main() was updated to remove the unnecessary slice brackets. This commit fixes the import and variable assignment in main.go to ensure proper functionality. Signed-off-by: SammyOina <sammyoina@gmail.com> * Fix typo in function name The function name "newProxyHTPPServer" was misspelled and has been corrected to "newProxyHTTPServer". This commit fixes the typo in the function name. Signed-off-by: SammyOina <sammyoina@gmail.com> * Fix Docker clean command in Makefile The Docker clean command in the Makefile has been fixed to include the Docker profile and project name. This ensures that all containers, networks, volumes, and images created by the "up" command are properly removed. Signed-off-by: SammyOina <sammyoina@gmail.com> * Fix proxy address bug in main.go The proxy address was not being set correctly in the main.go file, resulting in incorrect routing of HTTP requests. This commit fixes the bug by correctly setting the proxy address. Additionally, it registers the proxy handler for all incoming requests. Fixes: #123 Signed-off-by: SammyOina <sammyoina@gmail.com> * Refactor main.go to simplify HTTP server setup The previous implementation of the main.go file had unnecessary complexity in setting up the HTTP server. This commit simplifies the code by removing the unnecessary switch statement and consolidating the server setup logic. The main changes include: - Removing the switch statement that handled HTTPS server setup - Consolidating the server setup logic into a single goroutine - Removing the unnecessary goroutine for starting the server These changes make the code more readable and maintainable by reducing unnecessary complexity and improving the overall structure of the code. Signed-off-by: SammyOina <sammyoina@gmail.com> --------- Signed-off-by: SammyOina <sammyoina@gmail.com> |
||
|---|---|---|
| .. | ||
| api | ||
| mocks | ||
| README.md | ||
| doc.go | ||
| handler.go | ||
README.md
HTTP adapter
HTTP adapter provides an HTTP API for sending messages through the platform.
Configuration
The service is configured using the environment variables presented in the following table. Note that any unset variables will be replaced with their default values.
| Variable | Description | Default |
|---|---|---|
| MF_HTTP_ADAPTER_LOG_LEVEL | Log level for the HTTP Adapter | debug |
| MF_HTTP_ADAPTER_HOST | HTTP adapter listening host | |
| MF_HTTP_ADAPTER_PORT | Service HTTP port | 80 |
| MF_HTTP_ADAPTER_SERVER_CERT | Service server certificate | |
| MF_HTTP_ADAPTER_SERVER_KEY | Service server key | |
| MF_THINGS_AUTH_GRPC_URL | Things service Auth gRPC URL | localhost:7000 |
| MF_THINGS_AUTH_GRPC_TIMEOUT | Things service Auth gRPC request timeout in seconds | 1s |
| MF_THINGS_AUTH_GRPC_CLIENT_TLS | Flag that indicates if TLS should be turned on | false |
| MF_THINGS_AUTH_GRPC_CA_CERTS | Path to trusted CAs in PEM format | |
| MF_MESSAGE_BROKER_URL | Message broker instance URL | nats://localhost:4222 |
| MF_JAEGER_URL | Jaeger server URL | http://jaeger:14268/api/traces |
| MF_SEND_TELEMETRY | Send telemetry to mainflux call home server | true |
| MF_HTTP_ADAPTER_INSTANCE_ID | HTTP Adapter instance ID |
Deployment
The service itself is distributed as Docker container. Check the http-adapter service section in
docker-compose to see how service is deployed.
To start the service outside of the container, execute the following shell script:
# download the latest version of the service
git clone https://github.com/mainflux/mainflux
cd mainflux
# compile the http
make http
# copy binary to bin
make install
# set the environment variables and run the service
MF_HTTP_ADAPTER_LOG_LEVEL=[HTTP Adapter Log Level] \
MF_HTTP_ADAPTER_HOST=[Service HTTP host] \
MF_HTTP_ADAPTER_PORT=[Service HTTP port] \
MF_HTTP_ADAPTER_SERVER_CERT=[Path to server certificate] \
MF_HTTP_ADAPTER_SERVER_KEY=[Path to server key] \
MF_THINGS_AUTH_GRPC_URL=[Things service Auth gRPC URL] \
MF_THINGS_AUTH_GRPC_TIMEOUT=[Things service Auth gRPC request timeout in seconds] \
MF_THINGS_AUTH_GRPC_CLIENT_TLS=[Flag that indicates if TLS should be turned on] \
MF_THINGS_AUTH_GRPC_CA_CERTS=[Path to trusted CAs in PEM format] \
MF_MESSAGE_BROKER_URL=[Message broker instance URL] \
MF_JAEGER_URL=[Jaeger server URL] \
MF_SEND_TELEMETRY=[Send telemetry to mainflux call home server] \
MF_HTTP_ADAPTER_INSTANCE_ID=[HTTP Adapter instance ID] \
$GOBIN/mainflux-http
Setting MF_HTTP_ADAPTER_CA_CERTS expects a file in PEM format of trusted CAs. This will enable TLS against the Things gRPC endpoint trusting only those CAs that are provided.
Usage
HTTP Authorization request header contains the credentials to authenticate a Thing. The authorization header can be a plain Thing key or a Thing key encoded as a password for Basic Authentication. In case the Basic Authentication schema is used, the username is ignored. For more information about service capabilities and its usage, please check out the API documentation.