Deployment Policy¶

deployment.json is a single, versioned file that describes the client-facing settings of a GeoLibre deployment: which capabilities users have, which interface elements are visible, which plugins may load, the curated service library, sharing endpoints, and branding.

Example¶

{
  "version": 1,
  "capabilities": ["project:edit", "data:add", "processing:run", "export:data", "plugins:install", "settings:manage"],
  "interface": {
    "enabled": true,
    "level": "intermediate",
    "lock": true,
    "hiddenDataSources": ["arcgis"],
    "hiddenPlugins": ["plugin-a"],
    "hiddenMenus": ["help"],
    "hiddenMenuItems": ["file.print"]
  },
  "plugins": {
    "registryUrl": "https://plugins.example.com/registry.json",
    "allowed": ["acme-tools"],
    "blocked": ["bad-plugin"],
    "sideload": false,
    "defaultActive": ["acme-tools"]
  },
  "services": {
    "builtins": true,
    "catalog": [
      {
        "id": "city-wms",
        "name": "City WMS",
        "kind": "wms",
        "category": "Municipal",
        "fields": { "url": "https://maps.example.com/wms", "version": "1.3.0", "opacity": 0.8, "transparent": true }
      }
    ]
  },
  "sharing": {
    "shareUrl": "https://projects.example.com",
    "collabUrl": "wss://relay.example.com",
    "embedOrigins": ["https://portal.example.com"]
  },
  "geolens": { "url": "same-origin" },
  "ai": { "enabled": true, "model": "gpt-5-mini" },
  "branding": { "appName": "Acme Maps", "welcome": false }
}

Point your editor at the schema for completion and validation by adding "$schema": "https://raw.githubusercontent.com/opengeos/GeoLibre/main/schema/deployment.schema.json". GeoLibre ignores $schema.

Field reference¶

Every section and every field is optional except version. An absent section means "not specified": the next source in the precedence chain applies.

Top level¶

capabilities¶

An array of the capability names from Deployment Capabilities: project:edit, data:add, processing:run, export:data, plugins:install, settings:manage. Omit it to grant all capabilities; [] grants none.

interface¶

plugins¶

services¶

sharing¶

geolens¶

ai¶

branding¶

Omitted versus empty¶

For capabilities and plugins.allowed, leaving the field out and writing [] mean opposite things. Omitted means "no restriction from this file"; [] means "nothing is granted/allowed".

Plugin precedence¶

An id in blocked is never loaded, even if it is also in allowed; when allowed is present, any id not in it is not loaded.

Precedence between sources¶

When the policy is loaded, the intended order, highest first, is:

1. deployment.json
2. runtime environment (window.__GEOLIBRE_DEPLOYMENT_ENV__)
3. build-time environment

admin-profile.json is still honoured for the interface when deployment.json has no interface section.

Versioning¶

New fields are additive and keep version: 1. A document with any other version is ignored with a console warning.

Validation¶

The client parser is lenient and works section by section:

• A section with any invalid field, or any unknown key inside it, is dropped whole with a console warning. The other sections still apply.
• An unknown capability name drops the entire capabilities section, so the deployment falls back to environment settings or defaults (it does not grant nothing). Check the console if a restriction seems missing.
• Unknown top-level keys are ignored with one warning.
• Non-JSON content or a non-object is ignored silently.

A stricter container-side validator is planned. The schema cannot express some rules that the parser enforces: duplicate service ids after trimming, and numeric service field values beyond the safe-integer range.