Custom domains_

The appwrite_proxy_rule resource attaches a custom domain to an Appwrite site or function. Appwrite verifies the domain and issues a certificate for it, so most of the rule's state is read-only. You declare the domain and the target, then read back verification progress.

See the Terraform Registry for the full schema: proxy_rule.

Resource

This resource uses a standard project API key with rules.read and rules.write scopes.

Example

resource "appwrite_site" "example" {
  name          = "example-site"
  framework     = "other"
  build_runtime = "node-22"
}

resource "appwrite_proxy_rule" "example" {
  domain      = "www.example.com"
  type        = "site"
  resource_id = appwrite_site.example.id
}

type is site or function, and resource_id is the ID of the target. Set branch to have a VCS branch update the rule automatically.

Point the domain's DNS at Appwrite before or shortly after applying. Verification stays pending until the domain resolves.

Reading verification state

status reports domain verification. logs carries the verification and certificate generation output, which is the first place to look when a domain does not come up. renew_at is when the certificate auto-renews.

output "domain_status" {
  value = appwrite_proxy_rule.example.status
}

output "domain_logs" {
  value = appwrite_proxy_rule.example.logs
}

Importing

terraform import appwrite_proxy_rule.example <project-id>/<rule-id>
terraform import appwrite_proxy_rule.example <rule-id>

The second form works when project_id is configured on the provider.

Some installations derive the rule ID as md5(lower(domain)), and others use generated IDs. Use the ID the API returns rather than computing one.

Related

• Sites: sites you can put behind a domain
• Functions: functions you can put behind a domain
• Configuration: authentication and endpoints