mesh-catalog/modules/baserow/module.json

{
  "module": "baserow",
  "version": "1",
  "capabilities": [
    "container-runtime"
  ],
  "requires": [
    "postgres-database",
    "route"
  ],
  "contributes": {
    "postgres-database": {
      "name": "baserow"
    },
    "route": {
      "label": "baserow",
      "endpoint": "web"
    }
  },
  "binds": {
    "postgres-database": "${dir:state}/database.json",
    "route": "${dir:state}/route.json"
  },
  "secrets": {
    "postgres-database": "${dir:state}/database.secret"
  },
  "own-secrets": {
    "admin": "${dir:state}/admin.secret"
  },
  "listens": [
    {
      "name": "web",
      "port": 80,
      "protocol": "tcp",
      "from": "mesh",
      "why": "the Baserow web UI and REST API, served by the image's own Caddy; a public name is the route's"
    }
  ],
  "data": {
    "own": [
      {
        "id": "data",
        "path": "${dir:data}",
        "class": "valuable",
        "why": "uploaded files and media; the tables are in the database"
      }
    ]
  },
  "config": {
    "host": {
      "type": "string",
      "description": "The Host header the module's tools send to Baserow, a host name; the file's default is the name the module's route was given.",
      "trusted": true,
      "default": "${bound:route:name}"
    },
    "email": {
      "type": "string",
      "description": "The email address of the Baserow account the module's tools sign in as; unset, the code falls back to its environment.",
      "trusted": true,
      "default": ""
    },
    "url": {
      "type": "string",
      "description": "The address the module's tools reach Baserow at, as a URL; unset, the code falls back to its environment, else this machine's Baserow on port 80.",
      "trusted": true,
      "default": ""
    }
  },
  "resources": [
    {
      "id": "mesh-state",
      "type": "directory",
      "mode": "0700",
      "place": "mesh",
      "unknown": "program"
    },
    {
      "id": "state",
      "type": "directory",
      "mode": "0700",
      "place": ".",
      "unknown": "program"
    },
    {
      "id": "data",
      "type": "directory",
      "mode": "0755",
      "owner": "9999:9999",
      "unknown": "program"
    },
    {
      "id": "server-env",
      "type": "file",
      "path": "${dir:state}/server.env",
      "mode": "0600",
      "template": "files/server.env"
    },
    {
      "id": "net",
      "type": "network",
      "name": "baserow"
    },
    {
      "id": "server",
      "type": "container",
      "name": "baserow",
      "image": "baserow/baserow@sha256:263ea6c4b72c9eccabcd975ffe9fdebf23913a293a514bec6a3897a5e0a5a080",
      "health": {
        "kind": "runtime"
      },
      "network": "baserow",
      "env-file": [
        "${dir:state}/server.env"
      ],
      "ports": [
        "80"
      ],
      "volumes": [
        "${dir:data}:/baserow/data",
        "${dir:state}/database.secret:/run/secrets/database:ro"
      ]
    },
    {
      "id": "runtime-config",
      "type": "file",
      "path": "${dir:mesh-state}/config.json",
      "mode": "0600",
      "template": "files/config.json",
      "merge": "json",
      "takes-config": ["host", "email", "url"],
      "protected": ["password"]
    }
  ],
  "build": {
    "artifacts": [
      {
        "name": "tools",
        "kind": "bundle",
        "language": "typescript",
        "entrypoints": [
          "tools/index.js"
        ],
        "loads": [
          "tools/index.js"
        ],
        "env": {
          "MESH_BASEROW_URL": "http://127.0.0.1:${port:80}",
          "MESH_BASEROW_CONFIG_FILE": "${dir:mesh-state}/config.json"
        }
      },
      {
        "name": "files",
        "kind": "archive",
        "from": "files"
      }
    ]
  }
}