1

Feature flags setup guide

On-Premises – Docker

Configure local feature flags (Docker on‑prem)

On‑prem Docker deployments can load feature flags from a local JSON file.

1. Create the feature flag file on the host

  1. On the Docker host, create a working directory for Ninox config, for example:

    /opt/ninox/
  2. Copy the feature flag template from the server release into that directory and name it feature-flags.json

    (For example, from template.feature-flags.json → feature-flags.json.)
  3. Edit feature-flags.json and configure your flags, for example:

    { "SomeFeature": { "enabled": true } }

    Always use the template from the same Ninox server version, because available flags may change between releases.

2. Mount the file into the container and update server-config.json

  1. Ensure your server-config.json (on the host) contains:

    "featureFlags": { "source": "local", "file": "/usr/local/nxdb/feature-flags.json" }
  2. When starting the container, mount both server-config.json and feature-flags.json, for example:

    docker container run -d \
    --name nxdb \
    -v NX-DATA:/var/nxdb \
    -v /opt/ninox/server-config.json:/usr/local/nxdb/server-config.json:rw \
    -v /opt/ninox/feature-flags.json:/usr/local/nxdb/feature-flags.json:rw \
    -p 80:8080 ninoxdatabase/ninox-on-premise

    Key points:

    • Host file: /opt/ninox/feature-flags.json

    • In-container path: /usr/local/nxdb/feature-flags.json

    • This path must match the file value in server-config.json.

3. Restart and verify flags are loaded

Whenever you change feature-flags.json or server-config.json:

  1. Restart the container:

    docker compose restart nxdb

    or, if using plain Docker:

    docker container restart nxdb

 


On-Premises – Windows

Configure local feature flags (Windows on‑prem)

On‑prem installations can read feature flags from a local JSON file.

1. Create the feature flag file

  1. Open the Ninox installation folder, for example:

    C:\Program Files\Ninox
  2. Copy the file template.feature-flags.json and rename the copy to feature-flags.json

  3. Edit feature-flags.json and set your flags, for example:

    { "SomeFeature": { "enabled": true } }

    Always use the template from the same Ninox server version, because flags can be added or removed between releases.

2. Point the server to the local file

  1. In the same folder, open server-config.json.

  2. Add or update the featureFlags block, for example:

    "featureFlags": { "source": "local", "file": "feature-flags.json" }

    The file value can be an absolute path (for example C:\\Program Files\\Ninox\\feature-flags.json) or a path relative to the Ninox server working directory.

3. Restart and verify

  1. After saving feature-flags.json and server-config.json, open Task Manager.

  2. Go to the Services tab, right‑click the Ninox service, and select Restart.

ℹ️ Note: JSON feature flag support is available in Ninox On‑Premises version 3.18.17 and later.

Reply

null