Global Config

The smallweb config is located at $SMALLWEB_DIR/.smallweb/config.json.

If SMALLWEB_DIR is not set, it defaults to ~/smallweb.

Only the domain field is required. The rest are optional.

If you sync the smallweb dir between multiple servers, but want to set different config value depending on the server, you can use env variables to set config value.

# run smallweb with a different domain that the one set in the config
SMALlWEB_DOMAIN=localhost smallweb up

Available Fields

domain

The domain field defines the apex domain used for routing. By default, it is localhost.

{
  "domain": "example.com"
}

See the Routing guide for more information.

customDomains

The customDomains field is an object that maps custom domains to apps.

{
  "customDomains": {
    "example.com": "example",
  }
}

Admin Apps

The list of admin apps. More info about admin apps can be found in the Admin Apps guide.

{
  "adminApps": [
    "vscode"
  ]
}