flagshipio/self-hosted-api repository overview

⁠Bring your features to life

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

⁠⛔️ DEPRECATED.

⁠Please use https://hub.docker.com/r/flagshipio/decision-api⁠ instead (Early Adopter)

⁠Docs

⁠Running the app

⁠Running from build

Download the latest release on github and then simply run:

ENV_ID={your_environment_id} API_KEY={your_api_key} ./app

The server will run on the port 8080

⁠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/self-hosted-api

⁠Configuration

You can configure the self-hosted Decision API using 2 ways:

• YAML configuration file
• Environment Variables

⁠Using a configuration file

Create a config.yaml along your app file, or mount it in docker in location /config.yaml:

docker run -p 8080:8080 -v ./config.yaml:/config.yaml flagshipio/self-hosted-api

The configuration file should look like this:

env_id: "env_id" # Your Flagship Environment ID
api_key: "api_key" # Your Flagship API Key

# Cache
cache:
  type: local # or 'redis' or 'none' (if you do not want to using visitor cache)
  options:
    dbPath: ./data
    #redisHost: 'localhost:6379' # for redis storage
    #redisUsername: username     # (Optional) for redis storage
    #redisPassword: password     # (Optional) for redis storage

⁠Using environment variables

You can override each configuration variables from the configuration file using environment variables. Just name your env variables the same as the config file, but with the following rules:

• Env variable name should be UPPERCASE Example: ENV_ID
• Sub configuration level are defined using a _ sign Example: CACHE_TYPE Example: CACHE_OPTIONS_DBPATH

Here is a Docker example using environment variables to setup local caching:

docker run -p 8080:8080 -e ENV_ID={your_env_id} -e API_KEY={your_api_key} -e CACHE_TYPE=local -e CACHE_OPTIONS_DBPATH=./data -v ./config.yaml:/config.yaml flagshipio/self-hosted-api

Here is a Docker Compose example of using Redis as a visitor cache engine:

version: "3"
services:
  decision:
    build: .
    ports:
      - 8080:8080
    environment:
      ENV_ID: "env_id"
      API_KEY: "api_key"
      CACHE_TYPE: redis
      CACHE_OPTIONS_REDISHOST: "redis:6379"
    depends_on:
      - redis

  redis:
    image: redis

⁠Configuration parameters

You can use the following parameters to customize the Self Hosted API. Each parameter is named as in the config.yaml file, and the matching environment variable is parenthesis.

⁠Usage

You can find the Swagger API doc at the /swagger/index.html URL when running the application.

⁠Contribute

⁠Requirements

You need Go 1.12+ to build the app

⁠Building

Run the following command to build CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -installsuffix cgo -o app

⁠Generate swagger files

Install swaggo/swag to build swagger files: go get -u github.com/swaggo/swag/cmd/swag

Then run the init command with parseDependency option: swag init --parseDependency