# immugw
immugw is a REST proxy that connects to immudb and provides a RESTful interface for applications. We recommend running immudb and immugw on separate machines to enhance security.
You may download the immugw binary from the latest releases on Github (opens new window). Once you have downloaded immugw, rename it to immugw, make sure to mark it as executable, then run it. The following example shows how to obtain v1.3.0 for linux amd64:
$ wget https://github.com/codenotary/immugw/releases/download/v1.3.0/immugw-v1.3.0-linux-amd64
$ mv immugw-v1.3.0-linux-amd64 immugw
$ chmod +x immugw
# run help to find out about possible arguments
$ ./immugw help
# and run immugw in the background
$ ./immugw -d --immudb-address {immudb-server-address}
Alternatively, you may pull immudb docker image from DockerHub (opens new window) and run it in a ready-to-use container:
$ docker run -it -d -p 3323:3323 --name immugw --env IMMUGW_IMMUDB_ADDRESS={immudb-server-address} codenotary/immugw:latest
# Build from sources
Building binaries requires a Linux operating system.
To build the binaries yourself, simply clone immugw repository (opens new window) and run:
$ make all
immugw can be cross compiled for different systems and architectures by setting GOOS and GOARCH variables, i.e.:
GOOS=windows GOARCH=amd64 make all
To build immugw docker container locally:
docker build -t myown/immugw:latest -f Dockerfile .
# Installing with immuadmin
# install immugw service
$ ./immugw service install
# check current immugw service status
$ ./immugw service status
# stop immugw service
$ ./immugw service stop
# start immugw service
$ ./immugw service start
The Linux service is using the following defaults:
| File or configuration | location |
|---|---|
| all configuration files | /etc/immudb |
| pid file | /var/lib/immudb/immugw.pid |
| log files | /var/log/immudb |
# Configuration
immugw can be configured using environment variables, flags or a config file.
immugw --helpshows you all available flags and environment variables./etc/immudb/immugw.tomlis used as a default configuration file
# RESTful API reference
You can find the swagger schema here:
swagger immugw (opens new window)
If you want to run the Swagger UI, simply run the following Docker command after you cloned this repo:
$ wget https://github.com/codenotary/immugw/blob/master/swagger.json
$ docker run -d -it -p 8081:8080 --name swagger-immugw -v ${PWD}/swagger.json:/openapi.json -e SWAGGER_JSON=/openapi.json swaggerapi/swagger-ui
# immugw as auditor
immugw can be also run as auditor.
$ ./immugw --audit
If you are running immugw as a service, you need to edit /etc/immudb/immugw.toml and add the following section:
audit = true # false is default
audit-interval = "5m" # suffixes: "s", "m", "h", examples: 10s, 5m 1h
audit-username = "" # when immudb authentication is enabled, use read-only user credentials here
audit-password = "" # and the password
