sprue/config.example.yaml at main · storacha/sprue · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# Sprue Configuration
#
# This file documents all configuration options. Copy to config.yaml and customize.
# All values can also be set via environment variables with SPRUE_ prefix.
# Environment variables take precedence over config file values.
#
# Examples:
#   server.host          -> SPRUE_SERVER_HOST
#   storage.type         -> SPRUE_STORAGE_TYPE
#   storage.postgres.dsn -> SPRUE_STORAGE_POSTGRES_DSN
#

# Deployment configuration
deployment:
  environment: "development" # or "staging" or "production"
  # Indicates whether the service allows users to provision a space without an
  # active payment plan. It should only be true in development or testing
  # environments.
  allow_provision_without_payment_plan: false
  # Maximum number of replicas that can be allocated for a given blob. It
  # includes the original blob that was uploaded, so only values above 1 will
  # allow users to have multiple copies of their data.
  max_replicas: 3

server:
  # Host address to bind the HTTP server to
  host: "0.0.0.0"
  # Port to listen on
  port: 8080

identity:
  # Path to Ed25519 PEM key file for service identity
  # Takes precedence over private_key if set
  key_file: ""
  # Base64-encoded Ed25519 private key (fallback if key_file not set)
  # If neither is set, a key will be generated at startup
  private_key: ""
  # did:web identity wrapper (e.g., "did:web:upload")
  # When set with key_file, allows accepting UCANs addressed to this did:web
  service_did: ""

indexer:
  # URL of the indexing service (port 80 for did:web resolution in Docker)
  endpoint: "http://indexer:80"
  # DID of the indexer service (optional, derived from endpoint hostname)
  did: ""

mailer:
  # Specifies the mailer implementation to use (e.g., "postmark", "smtp", "nop").
  type: "nop"
  # Email address to use as the default sender for outgoing emails.
  sender: "dev@storacha.network"
  # Postmark API token (required if type is "postmark")
  postmark_token: ""
  # Address of the SMTP server (e.g., "smtp.example.com:25")
  smtp_addr: ""
  # Username for SMTP authentication
  smtp_auth_user: ""
  # Secret for CRAMMD5 SMTP authentication
  smtp_auth_secret: ""

# Storage backend selection and per-backend configuration.
storage:
  # Selects the backend. Valid values: "memory", "postgres", "aws". Default "postgres".
  #  - memory:   in-process stores — all data lost on restart; dev/test only.
  #  - postgres: PostgreSQL for metadata + S3-compatible storage for blob payloads.
  #  - aws:      DynamoDB for metadata + S3 for blob payloads.
  type: "postgres"

  postgres:
    # libpq-style connection string (used when storage.type is "postgres").
    dsn: "postgres://sprue:sprue@postgres:5432/sprue?sslmode=disable"
    # Maximum number of pool connections. 0 uses the pgx default.
    max_conns: 10
    # Minimum idle connections to keep warm.
    min_conns: 0
    # Set to true to skip goose migrations at startup (they run by default).
    skip_migrations: false

  dynamodb:
    # DynamoDB endpoint (for local development with DynamoDB Local).
    endpoint: "http://dynamodb-local:8000"
    # AWS region for DynamoDB.
    region: "us-west-1"
    agent_index_table: "agent-index"
    blob_registry_table: "blob-registry"
    consumer_table: "consumer"
    customer_table: "customer"
    delegation_table: "delegation"
    space_metrics_table: "space-metrics"
    admin_metrics_table: "admin-metrics"
    replica_table: "replica"
    revocation_table: "revocation"
    storage_provider_table: "storage-provider"
    subscription_table: "subscription"
    space_diff_table: "space-diff"
    upload_table: "upload"

  s3:
    # S3 endpoint (for local development with MinIO).
    endpoint: "http://minio:9000"
    # S3 region.
    region: "us-west-1"
    agent_message_bucket: "agent-message"
    delegation_bucket: "delegation"
    upload_shards_bucket: "upload-shards"

log:
  # Log level: debug, info, warn, error
  level: "info"