Skip to content

Get started

This path gets you from zero to a working Nona setup quickly.

It is designed for the smallest successful first run:

  • one self-hosted Nona instance
  • one project
  • one environment
  • one parameter or feature flag
  • one API key
  • one successful read

If you are evaluating the product, this path is the fastest way to understand the Nona model in practice.

  1. Deploy with Docker
  2. Create your first project
  3. Add your first parameter
  4. Create an API key
  5. Fetch your first config value
  6. Add a kill switch

If you want the shortest possible path:

  1. start Nona with Docker
  2. run nona init --yes --base-url http://localhost:18080 --email admin@example.com --password <password> --project storefront --print-key
  3. paste the printed values into your app .env
  4. run the printed verification curl

That is enough to prove the whole runtime model end to end.

By the end of this flow, you will have touched the core Nona concepts:

  • projects
  • environments
  • typed config entries
  • scopes
  • API keys
  • runtime reads

That makes it the best starting point before you go deeper into:

  • feature flags
  • remote config architecture
  • migration
  • deployment topologies

After the first successful setup, most teams continue into one of these:

  • Feature flags if the main use case is boolean release control
  • Remote config if the main use case is runtime values and settings
  • Migration if you are moving from Firebase Remote Config
  • Deployment if you are preparing a real production rollout
  • one running Nona instance
  • one project
  • one environment
  • one config entry
  • one API key
  • one successful read from an app or terminal

After the instance is running, bootstrap the first project, environment, flag, and key:

Terminal window
nona init \
--yes \
--base-url https://nona.example.com \
--email admin@example.com \
--password <password> \
--project storefront \
--print-key

What is the shortest path to a working Nona setup?

Section titled “What is the shortest path to a working Nona setup?”

Deploy the container, create one project, add one boolean parameter, create one API key, and verify one read.

Do I need to understand the whole product before starting?

Section titled “Do I need to understand the whole product before starting?”

No.

The get-started path is designed to teach the core model while you are using it.

Should I start with feature flags or remote config first?

Section titled “Should I start with feature flags or remote config first?”

Either is fine, but many teams start with one boolean flag because it is the easiest thing to verify quickly.

What should I read after the first successful setup?

Section titled “What should I read after the first successful setup?”

Most teams continue into feature flags, remote config, migration, or deployment depending on what they are trying to do next.