decision-api

README

Bring your features to life

Visit https://docs.developers.flagship.io/ to get started with Flagship.

Disclaimer

⚠ Early adoption phase

This project is in early adopter phase. Use at your own risk.

Contact the flagship team for more information.

⚠ Consent Management

Consent management and verification must be handled on your side.

Note that it is mandatory to collect visitor consent before tracking them and collecting their data. This is why you must not call Flagship and the Self Hosted API until user consent has been given.

Docs

Installation

The Flagship Decision API can be installed and deployed in your infrastructure either by downloading and running the binary, or pulling and running the docker image in your orchestration system.

Using a binary

You can download the latest binary here: https://github.com/flagship-io/decision-api/releases

Using a Docker image

You can pull the latest docker image from docker hub: docker pull flagshipio/decision-api

Running

Using a binary Download the latest release on github and then simply run:

ENV_ID={your_environment_id} API_KEY={your_api_key} ./decision-api

The server will run on the port 8080 by default. You can override this configuration (see Configuration)

Running with Docker Run the following command to start the server with Docker

docker run -p 8080:8080 -e ENV_ID={your_env_id} -e API_KEY={your_api_key} flagshipio/decision-api

Configuration

Full configuration and API options available here:

https://docs.developers.flagship.io/docs/run-on-premise

Licence

Apache License.