The SITMUN Proxy Middleware is a reverse proxy and middleware that facilitates the access of the SITMUN Map Viewer to protected services and databases.
These protected services or databases can have various restrictions or requirements, such as:
Before you begin, ensure you have met the following requirements:
Windows/Linux/Mac
machine.[sitmun-backend-core](https://github.com/sitmun/sitmun-backend-core)
to make requests (e.g. http://localhost:9001/api/config/proxy
).SITMUN_BACKEND_CONFIG_SECRET
(e.g. abcd
)To install the SITMUN Proxy Middleware, follow these steps:
Clone the repository:
git clone https://github.com/sitmun/sitmun-proxy-middleware.git
Change to the directory of the repository:
cd sitmun-proxy-middleware
Create a new file named .env
inside the directory.
Open the .env
file in a text editor and add in the following format:
SITMUN_BACKEND_CONFIG_URL=the_location_of_the_sitmun_backend_configuration_endpoint
SITMUN_BACKEND_CONFIG_SECRET=the_shared_secret
Start the SITMUN Middleware proxy:
docker compose up
This command will build and start all the services defined in the docker-compose.yml
file.
Access the SITMUN Middleware Proxy at http://localhost:9002/actuator/health and expect:
{"status":"UP"}
See SITMUN Application Stack as an example of how to deploy and run the proxy as parte of the SITMUN stack.
The following environment variables are required:
SITMUN_BACKEND_CONFIG_URL
: The URL to the backend service that provides the configuration for the proxy.SITMUN_BACKEND_CONFIG_SECRET
: The secret key to access the configuration service. It must be the same as the one used in the backend service.Additional information is available at https://sitmun.github.io/architecture/.
To stop and remove all services, volumes, and networks defined in the docker-compose.yml
file, use:
docker compose down -v
To contribute to SITMUN Application Stack, follow these steps:
Alternatively, see the GitHub documentation on creating a pull request.
This project uses the following license: European Union Public Licence V. 1.2.