Provider reference

Overview

A provider is a local or remote website hosting destination.

Example

Providers are configured on a per-website basis in the website configuration file (site.yaml or site.json).

 1---
 2base_url: https://hypertemplates.net
 3title: HyperTemplates
 4description: the pure-HTML templating system for the modern web.
 5...: ... # other website settings
 6provider:
 7    kind: s3
 8    endpoint: https://xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.r2.cloudflarestorage.com
 9    store: hypertemplates-production
10    secrets:
11        - name: access_key_id
12          provider: env
13          key: AWS_ACCESS_KEY_ID
14        - name: secret_access_key
15          provider: env
16          key: AWS_SECRET_ACCESS_KEY

Reference

provider.kind

The provider type.

See supported providers for more information.

provider.endpoint

The provider endpoint.

Some providers offer default values for provider.endpoint.

See supported providers for more information.

provider.store

The provider store.

The concept of a "store" varies by provider:

• s3: uses provider.store as the bucket name.
• git: uses provider.store as the branch name.
• ssh: uses provider.store as the path name.

Some providers offer default values for provider.store.

See supported providers for more information.

provider.secrets

The provider secret(s).

The concept of a provider "secret" varies by provider:

• s3: uses provider.secrets as API credentials.
• git: uses provider.secrets as ssh key paths or API credentials.
• ssh: uses provider.secrets as ssh key paths.

Supported providers

s3 provider

The s3 provider supports website deployment to AWS S3 and S3-compatible providers.

Compatible hosting services

• Cloudflare R2 (recommended)
• Amazon Web Services S3
• Microsoft Azure Blob Storage
• Google Cloud Storage
• Fastly Object Storage
• Digital Ocean Spaces
• Minio
• Akamai Object Storage
• Oracle Object Storage

git provider

🚧 Coming soon... 🚧

ssh provider

🚧 Coming soon... 🚧