This page describes the tasks necessary to deploy Curiefense using Docker Compose. The tasks are described sequentially below:
During this process, you might find it helpful to read the descriptions (which include the purpose, secrets, and network/port details) of the services and their containers: Services and Container Images
If during this process you need to rebuild an image, see the instructions here: Building/Rebuilding an Image.
Clone the repository, if you have not already done so:
git clone https://github.com/curiefense/curiefense.git
This documentation assumes it has been cloned to
A Docker Compose deployment can use TLS for communication with Curiefense's UI server and also for the protected service, but this is optional. (If you do not choose to set it up, HTTPS will be disabled.)
If you do not want Curiefense to use TLS, then skip this step and proceed to the next section. Otherwise, generate the certificate(s) and key(s) now.
To enable TLS for the protected site/application, go to
curiefense/deploy/compose/curiesecrets/curieproxy_ssl/ and do the following:
site.crt and add the certificate.
site.key and add the key.
To enable TLS for the nginx server that is used by
uiserver, go to
curiefense/deploy/compose/curiesecrets/uiserver_ssl/and do the following:
ui.crt and add the certificate.
ui.key and add the key.
Docker Compose deployments can be configured in two ways:
By setting values for variables in
Or by setting OS environment variables (which will override any variables set in
These variables are described below.
Curiefense uses the storage defined here for synchronizing configuration changes between
confserver and the Curiefense sidecars.
By default, this points to the
local_bucket Docker volume:
$ grep CURIE_BUCKET_LINK .envCURIE_BUCKET_LINK=file:///bucket/prod/manifest.json
For multi-node deployments, or to use S3 for a single node, replace this value with the URL of an S3 bucket:
In that case, you will need to supply AWS credentials in
deploy/compose/curiesecrets/s3cfg, following this template:
[default]access_key = AAAAAAAAAAAAAAAAAAAAsecret_key = AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
The address of the destination service for which Curiefense acts as a reverse proxy. By default, this points to the
echo container, which simply echoes the HTTP requests it receives.
main (the latest stable image, automatically built from the
main branch). To run a version that matches the contents of your working directory, use the following command:
DOCKER_TAG="$(git describe --tag --long --dirty)-$(git rev-parse --short=12 HEAD:curiefense)"
Once the tasks above are completed, run these commands:
cd curiefense/deploy/compose/docker-compose up
After deployment, the Echo service should be running and protected behind Curiefense. You can test the success of the deployment by querying it:
$ curl http://localhost:30081/Request served by echoHTTP/1.1 GET /Host: localhost:30081X-Envoy-Internal: trueX-Request-Id: 57dd8be5-6040-491a-903e-7ef3734ab9dbX-Envoy-Expected-Rq-Timeout-Ms: 15000User-Agent: curl/7.74.0Accept: */*X-Forwarded-For: 172.18.0.1X-Forwarded-Proto: http
Also verify the following:
The UIServer is now available at http://localhost:30080
Grafana is now available at http://localhost:30300
confserver is now available at http://localhost:30000/api/v1/
To stop all containers and remove any persistent data stored in volumes, run the following commands:
docker-compose rm -f && docker volume prune -f