termblog/example.config.yaml at master · ajmeese7/termblog · 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
# TermBlog Configuration
# Copy this file to config.yaml and customize as needed

blog:
  # Blog title displayed in the TUI header
  title: "TermBlog"

  # Short description for feeds and meta tags
  description: "A blog you can read in your terminal"

  # Default author name for new posts
  author: "Aaron Meese"

  # Base URL for RSS feeds and links (no trailing slash)
  base_url: "https://termblog.com"

  # Directory containing markdown posts (relative to config file)
  content_dir: "content/posts"

  # Message shown after exiting the SSH session (supports multiple lines)
  exit_message: |
    Thanks for visiting TermBlog!
    Check out the web version at https://termblog.com

  # Path to ASCII art file for TUI header (optional)
  # ascii_header: "header.txt"

server:
  # SSH server port (connect via: ssh localhost -p 2222)
  ssh_port: 2222

  # HTTP server port (web terminal and feeds)
  http_port: 8080

  # Path to SSH host key (auto-generated if missing)
  host_key_path: ".ssh/termblog_host_key"

  # Trust X-Forwarded-For headers from reverse proxy (default: false)
  # Only enable when running behind a trusted proxy (nginx, caddy, etc.)
  # trust_proxy: true

  # Rate limiting for SSH connections
  rate_limit:
    # Maximum connections per IP within the window
    limit: 10
    # Window duration in seconds
    window: 60

storage:
  # SQLite database path (relative to config file)
  database_path: "termblog.db"

# Admin settings (SSH-only, not available via web terminal)
admin:
  # SSH key fingerprints allowed to access admin features
  # Get your fingerprint with: ssh-keygen -lf ~/.ssh/id_ed25519.pub
  # Format: SHA256:...
  fingerprints: []
  # Example:
  # fingerprints:
  #   - "SHA256:abcdef1234567890abcdef1234567890abcdef12"

# Theme name: pipboy, dracula, nord, monokai, monochrome, amber, matrix, paper, terminal
# Or path to custom theme YAML file
theme: "dracula"

# Browser tab favicon. Letter and emoji modes recolor live as visitors switch
# themes; image mode serves a fixed icon you provide.
favicon:
  enabled: true

  # mode: letter | emoji | image
  mode: letter

  # letter mode: single character drawn in the theme's accent color
  letter: "T"

  # emoji mode: any glyph; emoji_bg is "transparent" or "themed"
  # mode: emoji
  # emoji: "📝"
  # emoji_bg: transparent

  # image mode: local path (resolved relative to this config file) or http(s) URL
  # mode: image
  # image: "static/my-favicon.png"
  # image: "https://example.com/favicon.ico"