schema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "/schemas/central",
  "title": "Config",
  "description": "The config file schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "django_setup": {
      "description": "Config keys related to Django setup",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "SECRET_KEY": {
          "description": "Django Secret Key to be used. Keep this value secret",
          "type": "string"
        },
        "DEBUG": {
          "description": "Turns on/off debug mode.",
          "type": "boolean"
        },
        "ALLOWED_HOSTS": {
          "description": "A list of strings representing the host/domain names that can be served.",
          "type": "array"
        },
        "CSRF_TRUSTED_ORIGINS": {
          "description": "A list of string represnting the urls that are CSRT trusted origins",
          "type": "array"
        }
      }
    },
    "sso": {
      "description": "Config keys related to SSO",
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "googleapi": {
          "description": "Config keys related to Google SSO",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "SOCIAL_AUTH_GOOGLE_OAUTH2_KEY": {
              "description": "Google OAuth2 Key",
              "type": "string"
            },
            "SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET": {
              "description": "Google OAuth2 secret",
              "type": "string"
            }
          }
        }
      }
    },
    "database": {
      "type": "object",
      "properties": {
        "engine": {
          "type": "string",
          "enum": [
            "sqlite3",
            "mysql"
          ]
        },
        "dbname": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "password": {
          "type": "string"
        },
        "host": {
          "type": "string"
        },
        "port": {
          "type": "integer"
        }
      },
      "required": [
        "engine"
      ]
    },
    "celery": {
      "description": "Celery configuration",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "broker": {
          "description": "Celery broker url",
          "type": "string"
        },
        "backend": {
          "description": "Celery backend url",
          "type": "string"
        }
      }
    },
    "access_modules": {
      "description": "List of access modules attached to this tool",
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "git_urls": {
          "description": "List of git URLs of access modules",
          "type": "array"
        },
        "RETRY_LIMIT": {
          "description": "Number of retries before raising cloning failure exception",
          "type": "integer",
          "minimum": 1
        }
      }
    },
    "enigmaGroup": {
      "description": "Config related to enigma groups",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "MAIL_APPROVER_GROUPS": {
          "description": "List of mail approvers",
          "type": "array"
        }
      }
    },
    "emails": {
      "description": "List of emails used across the repo",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "access-approve": {
          "description": "Access approve email",
          "type": "string"
        },
        "EMAIL_HOST": {
          "description": "The host to use for sending email.",
          "type": "string"
        },
        "EMAIL_PORT": {
          "description": "Port to use for the SMTP server.",
          "type": "string"
        },
        "EMAIL_HOST_USER": {
          "description": "Username to use for the SMTP server.",
          "type": "string"
        },
        "EMAIL_HOST_PASSWORD": {
          "description": "Password to use for the SMTP server.",
          "type": "string"
        },
        "EMAIL_USE_TLS": {
          "description": "Whether to use a TLS (secure) connection when talking to the SMTP server: port 587",
          "type": "boolean"
        },
        "EMAIL_USE_SSL": {
          "description": "Whether to use an implicit TLS (secure) connection when talking to the SMTP server: port 465",
          "type": "boolean"
        },
        "DEFAULT_FROM_EMAIL": {
          "description": "Default email address to use for correspondence from the site manager(s)",
          "type": "string"
        }
      }
    },
    "background_task_manager": {
      "description": "Config for background task managment",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Currently it can be celery or threading",
          "type": "string"
        },
        "config": {
          "description": "if celery is selected, config for the same",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "broker": {
              "description": "celery broker url, broker can be redis / mqtt",
              "type": "string"
            },
            "backend": {
              "description": "backed to store data for celery, can be redis / sql db url",
              "type": "string"
            },
            "need_monitoring": {
              "description": "true/false, if true, monitoring apps will be started",
              "type": "boolean"
            },
            "monitoring_apps": {
              "description": "app which will monitor celery tasks. django_celery_results / django_celery_monitor / django_celery_beat",
              "type": "string"
            }
          }
        }
      }
    }
  },
  "required": [
    "sso"
  ]
}