Realm Application Configuration

Every component of a MongoDB Realm application is fully defined and configured using structured JSON configuration and JavaScript source code files.

  • .json files define and configure specific components in your app. Every JSON configuration file conforms to a specific schema for the type of component it configures.
  • .js files define serverless application logic used in functions, triggers, webhooks, and custom resolvers.

You'll work directly with configuration files if you prefer to develop and deploy locally instead of through the Realm UI. They're especially useful if you want to version control your app or run multiple copies of an app based on a single configuration.

Broadly, you can:

  • Export an app's current configuration and source code files as a single configuration directory.
  • Import configuration files to create an app or configure the components of an existing app.
  • Deploy your app based on a configuration directory that you host on GitHub.

A complete directory of configuration files has the following root-level files and directories:

├── realm_config.json
├── auth/
├── data_sources/
├── environments/
├── functions/
├── graphql/
├── hosting/
├── http_endpoints/
├── sync/
├── triggers/
└── values/

For detailed descriptions and examples of each component type's configuration and source code files, refer to the type's page in this section:

Give Feedback