wayback-cache-proxy/config.example.yaml at main · zkmkarlsruhe/wayback-cache-proxy · 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
# Wayback Cache Proxy — Configuration
#
# Copy this file to config.yaml and edit as needed.
# Both the proxy and admin service read from this file.
#
# To reload the proxy without restarting, save changes via the admin UI
# or publish a Redis message: PUBLISH wayback:config_reload reload

# ── Proxy Server ──────────────────────────────────────────────────────
proxy:
  host: "0.0.0.0"          # Bind address
  port: 8888               # Listen port (requires restart to change)
  error_pages_dir: ""      # Custom error page template directory (optional)

# ── Wayback Machine ──────────────────────────────────────────────────
wayback:
  target_date: "20010911"    # Target date in YYYYMMDD format
  date_tolerance_days: 365   # How far from target_date to accept snapshots
  base_url: "https://web.archive.org"
  geocities_fix: true        # Route geocities.com through oocities.org

# ── Redis Cache ──────────────────────────────────────────────────────
cache:
  redis_url: "redis://localhost:6379/0"   # Requires restart to change
  hot_ttl_seconds: 604800                 # Hot cache TTL — 7 days

# ── Speed Throttling ─────────────────────────────────────────────────
# Simulate period-accurate modem speeds.
# Valid speeds: 14.4k, 28.8k, 56k, isdn, dsl, none
throttle:
  default_speed: "56k"        # Default for all visitors
  allow_user_override: true   # Let visitors pick speed via header bar dropdown

# ── Header Bar ───────────────────────────────────────────────────────
# Overlay bar injected into every HTML page (post-cache).
header_bar:
  enabled: true
  position: "top"            # top | bottom
  custom_text: "Wayback Proxy"
  show_speed_selector: true

# ── Landing Page ─────────────────────────────────────────────────────
landing_page:
  enabled: true
  most_viewed_count: 10      # Number of top domains to show

# ── Admin Interface ──────────────────────────────────────────────────
# The built-in admin at /_admin/ on the proxy port.
admin:
  enabled: true
  password: "admin123"       # Empty string = no auth required

# ── Access Control ───────────────────────────────────────────────────
access:
  mode: "open"               # open | allowlist

# ── Prefetch Crawler ─────────────────────────────────────────────────
crawler:
  concurrency: 3             # Max parallel fetches
  max_urls: 10000            # Cap on URLs per crawl (0 = unlimited)

# ── Backend Chain ───────────────────────────────────────────────────
# Tried in order — chain order decides priority.
#   type: local   — forward matching requests to a self-hosted API
#   type: pywb    — local WARC archives via pywb (multiple instances allowed)
#   type: cache   — Redis cache (curated + hot tiers)
#   type: wayback — Wayback Machine (live internet)
# If omitted, defaults to: cache → wayback
backends:
  chain:
    # Local API replacement — intercept requests to specific hostnames
    # and forward them to a self-hosted service. Supports fnmatch patterns.
    # - type: local
    #   base_url: "http://localhost:9000"
    #   hostnames:                   # omit for catch-all
    #     - "api.sounddogs.com"      # exact hostname
    #     - "*.example.com"          # wildcard pattern
    #   timeout: 30                  # request timeout in seconds
    #
    # pywb replay mode — local WARC files served via URL rewriting
    # - type: pywb
    #   base_url: "http://localhost:8080"
    #   collection: "web"
    #   mode: replay               # default — /{collection}/{ts}id_/{url}
    #
    # pywb proxy mode — memento proxy with archive sequences (Rhizome, IA, LOC, etc.)
    # - type: pywb
    #   base_url: "http://localhost:8089"
    #   mode: proxy                # send requests through pywb as HTTP proxy
    #
    # Multiple instances — one per artwork, each with its own archive config
    # - type: pywb
    #   base_url: "http://localhost:8090"
    #   mode: proxy
    - type: cache
    - type: wayback