config-server-schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$id": "https://github.com/superzanti/ServerSync/server-config.json",
  "type": "object",
  "title": "The server configuration schema",
  "description": "The root schema comprises the entire JSON document.",
  "default": {},
  "required": [
    "general",
    "connection",
    "rules",
    "misc"
  ],
  "additionalProperties": true,
  "properties": {
    "general": {
      "$id": "#/properties/general",
      "type": "object",
      "title": "The general schema",
      "description": "General configuration of the servers behavior",
      "default": {},
      "examples": [
        {
          "sync_mode": 2,
          "push_client_mods": false
        }
      ],
      "required": [
        "push_client_mods",
        "sync_mode"
      ],
      "additionalProperties": true,
      "properties": {
        "push_client_mods": {
          "$id": "#/properties/general/properties/push_client_mods",
          "type": "boolean",
          "title": "The push_client_mods schema",
          "description": "Should clientmods be used for suggesting client side only mods",
          "default": false,
          "examples": [
            false
          ]
        },
        "sync_mode": {
          "$id": "#/properties/general/properties/sync_mode",
          "type": "integer",
          "minimum": 1,
          "maximum": 2,
          "title": "The sync_mode schema",
          "description": "The type of file transfer that the server uses",
          "default": 2,
          "examples": [
            2
          ]
        }
      }
    },
    "connection": {
      "$id": "#/properties/connection",
      "type": "object",
      "title": "The connection schema",
      "description": "Details about where your server communicates from",
      "default": {},
      "examples": [
        {
          "port": 38067
        }
      ],
      "required": [
        "port"
      ],
      "additionalProperties": true,
      "properties": {
        "port": {
          "$id": "#/properties/connection/properties/port",
          "type": "integer",
          "title": "The port schema",
          "description": "The port the server is serving on",
          "default": 38067,
          "examples": [
            38067
          ]
        }
      }
    },
    "rules": {
      "$id": "#/properties/rules",
      "type": "object",
      "title": "The rules schema",
      "description": "Rules about what files to transfer and how",
      "default": {},
      "examples": [
        {
          "files": {
            "ignore": [
              {
                "pattern": "\\*\\*/*.jar"
              }
            ]
          },
          "directories": [
            {
              "name": "test-mirror",
              "mode": "mirror"
            },
            {
              "name": "test-push",
              "mode": "push"
            }
          ]
        }
      ],
      "required": [
        "directories",
        "files"
      ],
      "additionalProperties": true,
      "properties": {
        "directories": {
          "$id": "#/properties/rules/properties/directories",
          "type": "array",
          "title": "The directories schema",
          "description": "The directories that will be scanned for files to sync",
          "default": [],
          "examples": [
            [
              {
                "path": "test-mirror",
                "mode": "mirror"
              },
              {
                "path": "test-push",
                "mode": "push"
              }
            ]
          ],
          "additionalItems": true,
          "items": {
            "$id": "#/properties/rules/properties/directories/items",
            "anyOf": [
              {
                "$id": "#/properties/rules/properties/directories/items/anyOf/0",
                "type": "object",
                "title": "Object style included directory",
                "description": "Sync directory with details about how",
                "default": {},
                "examples": [
                  {
                    "path": "mirror",
                    "name": "test-mirror"
                  }
                ],
                "required": [
                  "path"
                ],
                "additionalProperties": true,
                "properties": {
                  "path": {
                    "$id": "#/properties/rules/properties/directories/items/anyOf/0/properties/name",
                    "type": "string",
                    "title": "The name schema",
                    "description": "The name of the directory",
                    "default": "",
                    "examples": [
                      "test-mirror"
                    ]
                  },
                  "mode": {
                    "$id": "#/properties/rules/properties/directories/items/anyOf/0/properties/mode",
                    "type": "string",
                    "pattern": "push|mirror",
                    "title": "The mode schema",
                    "description": "What style of sync is being used, mostly affects file deletion client side",
                    "default": "",
                    "examples": [
                      "mirror"
                    ]
                  }
                }
              },
              {
                "$id": "#/properties/rules/properties/directories/items/anyOf/1",
                "type": "string",
                "title": "Named default mode",
                "description": "Default sync mode for named directory",
                "default": "",
                "examples": [
                  "test-directory"
                ]
              }
            ]
          }
        },
        "files": {
          "$id": "#/properties/rules/properties/files",
          "type": "object",
          "title": "The files schema",
          "description": "Configuration of what gets synced.",
          "default": {},
          "examples": [
            {
              "include": [
                "**/serversync-*.jar",
                {
                  "pattern": "\\*\\*/serversync-\\*.cfg",
                  "description": "foobar"
                }
              ],
              "ignore": [
                "**/serversync-*.jar",
                {
                  "pattern": "\\*\\*/serversync-\\*.cfg",
                  "description": "foobar"
                }
              ]
            }
          ],
          "required": [
            "include"
          ],
          "properties": {
            "include": {
              "$id": "#/properties/rules/properties/files/properties/include",
              "type": "array",
              "title": "The include schema",
              "description": "Glob patterns of files that will be included during sync.",
              "default": [],
              "examples": [
                [
                  "**/serversync-*.jar",
                  {
                    "pattern": "\\*\\*/serversync-\\*.cfg",
                    "description": "I like this file!"
                  }
                ]
              ],
              "additionalItems": true,
              "items": {
                "$id": "#/properties/rules/properties/files/properties/include/items",
                "anyOf": [
                  {
                    "$id": "#/properties/rules/properties/files/properties/include/items/anyOf/0",
                    "type": "string",
                    "title": "The first anyOf schema",
                    "description": "A naked include glob pattern.",
                    "default": "",
                    "examples": [
                      "**/serversync-*.jar"
                    ]
                  },
                  {
                    "$id": "#/properties/rules/properties/files/properties/include/items/anyOf/1",
                    "type": "object",
                    "title": "The second anyOf schema",
                    "description": "A description of an include glob pattern.",
                    "default": {},
                    "examples": [
                      {
                        "pattern": "\\*\\*/serversync-\\*.cfg",
                        "description": "I like this file!"
                      }
                    ],
                    "required": [
                      "pattern"
                    ],
                    "properties": {
                      "pattern": {
                        "$id": "#/properties/rules/properties/files/properties/include/items/anyOf/1/properties/pattern",
                        "type": "string",
                        "title": "The pattern schema",
                        "description": "A glob pattern to match against.",
                        "default": "",
                        "examples": [
                          "**/serversync-*.cfg"
                        ]
                      },
                      "description": {
                        "$id": "#/properties/rules/properties/files/properties/include/items/anyOf/1/properties/description",
                        "type": "string",
                        "title": "The description schema",
                        "description": "A description of the reason for this pattern.",
                        "default": "",
                        "examples": [
                          "I like this file!"
                        ]
                      }
                    },
                    "additionalProperties": true
                  }
                ]
              }
            },
            "ignore": {
              "$id": "#/properties/rules/properties/files/properties/ignore",
              "type": "array",
              "title": "The ignore schema",
              "description": "Glob patterns of files that will not be sent to clients.",
              "default": [],
              "examples": [
                [
                  "**/serversync-*.jar",
                  {
                    "pattern": "\\*\\*/serversync-\\*.cfg",
                    "description": "I don't like these files!"
                  }
                ]
              ],
              "additionalItems": true,
              "items": {
                "$id": "#/properties/rules/properties/files/properties/ignore/items",
                "anyOf": [
                  {
                    "$id": "#/properties/rules/properties/files/properties/ignore/items/anyOf/0",
                    "type": "string",
                    "title": "The first anyOf schema",
                    "description": "A naked ignore glob pattern.",
                    "default": "",
                    "examples": [
                      "**/serversync-*.jar",
                      "config/serversync/*"
                    ]
                  },
                  {
                    "$id": "#/properties/rules/properties/files/properties/ignore/items/anyOf/1",
                    "type": "object",
                    "title": "The second anyOf schema",
                    "description": "A description of an ignore pattern.",
                    "default": {},
                    "examples": [
                      {
                        "pattern": "\\*\\*/serversync-\\*.cfg",
                        "description": "I don't like these files!"
                      }
                    ],
                    "required": [
                      "pattern"
                    ],
                    "properties": {
                      "pattern": {
                        "$id": "#/properties/rules/properties/files/properties/ignore/items/anyOf/1/properties/pattern",
                        "type": "string",
                        "title": "The pattern schema",
                        "description": "A glob pattern to match against.",
                        "default": "",
                        "examples": [
                          "**/serversync-*.cfg"
                        ]
                      },
                      "description": {
                        "$id": "#/properties/rules/properties/files/properties/ignore/items/anyOf/1/properties/description",
                        "type": "string",
                        "title": "The description schema",
                        "description": "A description of why this pattern is here.",
                        "default": "",
                        "examples": [
                          "I don't like these files!"
                        ]
                      }
                    },
                    "additionalProperties": true
                  }
                ]
              }
            },
            "redirect": {
              "$id": "#/properties/rules/properties/files/properties/redirect",
              "type": "array",
              "title": "The redirect schema",
              "description": "Glob patterns of files to redirect to another location on the client.",
              "default": [],
              "examples": [
                [
                  {
                    "pattern": "mods/test-redirect-file.txt",
                    "redirectTo": "redirected-files"
                  }
                ]
              ],
              "additionalItems": true,
              "items": {
                "$id": "#/properties/rules/properties/files/properties/redirect/items",
                "anyOf": [
                  {
                    "$id": "#/properties/rules/properties/files/properties/redirect/items/anyOf/0",
                    "type": "object",
                    "title": "The first anyOf schema",
                    "description": "A description of the redirect.",
                    "default": {},
                    "examples": [
                      {
                        "pattern": "mods/test-redirect-file.txt",
                        "redirectTo": "redirected-files"
                      }
                    ],
                    "required": [
                      "pattern",
                      "redirectTo"
                    ],
                    "properties": {
                      "pattern": {
                        "$id": "#/properties/rules/properties/files/properties/redirect/items/anyOf/0/properties/pattern",
                        "type": "string",
                        "title": "The pattern schema",
                        "description": "The glob of files to redirect.",
                        "default": "",
                        "examples": [
                          "mods/test-redirect-file.txt"
                        ]
                      },
                      "redirectTo": {
                        "$id": "#/properties/rules/properties/files/properties/redirect/items/anyOf/0/properties/redirectTo",
                        "type": "string",
                        "title": "The redirectTo schema",
                        "description": "The location to redirect the files to.",
                        "default": "",
                        "examples": [
                          "redirected-files"
                        ]
                      }
                    },
                    "additionalProperties": true
                  }
                ]
              }
            }
          },
          "additionalProperties": true
        },
        "redirect_files": {
          "$id": "#/properties/rules/properties/redirect_files",
          "type": "array",
          "description": "A list of patterns for redirecting files to a different location on the client",
          "default": [],
          "examples": [
            {
              "pattern": "\\*\\*/\\*.jar",
              "redirectTo": "ignored-mods"
            }
          ],
          "additionalItems": true,
          "items": {
            "$id": "#/properties/rules/properties/redirect_files/items",
            "anyOf": [
              {
                "$id": "#/properties/rules/properties/redirect_files/items/anyOf/0",
                "type": "object",
                "title": "Detailed configuration",
                "description": "Used to specify extra information about a pattern",
                "default": {},
                "examples": [
                  {
                    "pattern": "\\*\\*/\\*.jar",
                    "redirectTo": "ignored-mods"
                  }
                ],
                "required": [
                  "pattern",
                  "redirectTo"
                ],
                "additionalProperties": true,
                "properties": {
                  "redirectTo": {
                    "$id": "#/properties/rules/properties/file_ignore_list/items/anyOf/0/properties/redirectTo",
                    "type": "string",
                    "title": "Where to redirect the file on the client",
                    "description": "This is where the file should end up on the client relative to the 'rootDir'",
                    "default": "",
                    "examples": [
                      "some-place"
                    ]
                  },
                  "pattern": {
                    "$id": "#/properties/rules/properties/file_ignore_list/items/anyOf/0/properties/pattern",
                    "type": "string",
                    "title": "The pattern to match against",
                    "description": "Matches using GLOB patterns",
                    "default": "",
                    "examples": [
                      "**/*.jar"
                    ]
                  }
                }
              }
            ]
          }
        }
      }
    },
    "misc": {
      "$id": "#/properties/misc",
      "type": "object",
      "title": "The misc schema",
      "description": "Unspecified other settings",
      "default": {},
      "examples": [
        {
          "locale": "en_NZ"
        }
      ],
      "required": [
        "locale"
      ],
      "additionalProperties": true,
      "properties": {
        "locale": {
          "$id": "#/properties/misc/properties/locale",
          "type": "string",
          "title": "The locale",
          "description": "What language should serversync load in",
          "default": "",
          "examples": [
            "en_NZ"
          ]
        }
      }
    }
  }
}