secutils/.env.example at main · secutils-dev/secutils · 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
# Secutils.dev environment configuration
# Copy this file to .env and fill in the values.

# Log level for the Secutils API.
RUST_LOG=info

# Database connection string (used by sqlx for migrations and compile-time checks).
DATABASE_URL=postgres://postgres@localhost/secutils

# Use cached query metadata from .sqlx/ instead of connecting to the database at
# compile time. This lets you compile without running migrations first. The app
# still applies migrations automatically on startup.
# Set to `false` if you want live query validation during development (requires
# running `sqlx migrate run` first).
SQLX_OFFLINE=true

# Path to the TOML configuration file.
SECUTILS_CONFIG=${PWD}/secutils.toml

# Secret key used to sign and verify JSON Web Tokens for API access.
# Generate with: openssl rand -hex 16
SECUTILS_SECURITY__JWT_SECRET=<your-jwt-secret>

# SMTP configuration (optional, for sending emails).
# SECUTILS_SMTP__ADDRESS=smtp.example.com
# SECUTILS_SMTP__USERNAME=user@example.com
# SECUTILS_SMTP__PASSWORD=secret
# SECUTILS_SMTP__CATCH_ALL__RECIPIENT=dev@example.com

# Enable verbose HTTP client logging (optional).
# SECUTILS_HTTP__CLIENT__VERBOSE=true

# JWT tokens for Kratos webhook authentication.
# Generate with: cargo run -p secutils-jwt-tools -- generate --secret <your-jwt-secret> --sub @kratos --exp 1year
SELFSERVICE_FLOWS_REGISTRATION_AFTER_PASSWORD_HOOKS_0_CONFIG_AUTH_CONFIG_VALUE="Bearer <generated-kratos-jwt>"
SELFSERVICE_FLOWS_REGISTRATION_AFTER_WEBAUTHN_HOOKS_0_CONFIG_AUTH_CONFIG_VALUE="Bearer <generated-kratos-jwt>"
COURIER_HTTP_REQUEST_CONFIG_AUTH_CONFIG_VALUE="Bearer <generated-kratos-jwt>"

# HTML tool app deployment (dev/tools/)
# SECUTILS_HTML_APP_API_DOMAIN=https://secutils.dev
# SECUTILS_HTML_APP_API_KEY=su_ak_...
#
# Public host where the tools are served. Used by `dev/tools/deploy.ts` to substitute `{{TOOLS_HOST}}` placeholders in
# HTML and skill .md sources before minification (canonical, og:url, og:image, JSON-LD, related-tools links, llms.txt
# entries). Defaults to `tools.secutils.dev`.
# SECUTILS_TOOLS_PUBLIC_HOST=tools.secutils.dev
#
# Absolute path (or path relative to this repo root) to the marketing site's index.html. Read by
# `scripts/tools-check.ts` to verify that every promoted tool is linked from the home page's "Free single-page tools"
# section, and that no non-promoted tool leaked there. The marketing site lives in a separate (private) sibling
# checkout. When unset the marketing-side check is skipped with a warning so contributors without that checkout can
# still run `make tools-check`.
# SECUTILS_TOOLS_PROMO_HOME_INDEX=../<promo-repo>/.../src/index.html
#
# Per-tool responder IDs. Each tool has two sibling responders:
#   _<TOOL>     -> serves `https://<TOOLS_HOST>/<path>`     (text/html)
#   _<TOOL>_MD  -> serves `https://<TOOLS_HOST>/<path>.md`  (text/markdown,  the AI agent skill)
# Plus the agent-discovery singletons:
#   _LLMS_TXT            -> /llms.txt                          (text/markdown,     llmstxt.org index)
#   _ROBOTS_TXT          -> /robots.txt                        (text/plain,        AI crawler rules + Content Signals + sitemap pointer)
#   _SITEMAP_XML         -> /sitemap.xml                       (application/xml,   one entry per public surface)
#   _AGENT_SKILLS_INDEX  -> /.well-known/agent-skills/index.json (application/json, Cloudflare Agent Skills Discovery RFC v0.2.0)
#
# Tools whose source HTML lacks a responder ID are skipped at deploy with a
# yellow warning (existing behavior; this lets you stage rollouts safely).
# SECUTILS_HTML_APP_RESPONDER_ID_INDEX=
# SECUTILS_HTML_APP_RESPONDER_ID_JWT_DEBUGGER=
# SECUTILS_HTML_APP_RESPONDER_ID_JWT_DEBUGGER_MD=
# SECUTILS_HTML_APP_RESPONDER_ID_SAML_DECODER=
# SECUTILS_HTML_APP_RESPONDER_ID_SAML_DECODER_MD=
# SECUTILS_HTML_APP_RESPONDER_ID_MOCK_SAML_IDP=
# SECUTILS_HTML_APP_RESPONDER_ID_MOCK_SAML_IDP_MD=
# SECUTILS_HTML_APP_RESPONDER_ID_CERTIFICATE_DECODER=
# SECUTILS_HTML_APP_RESPONDER_ID_CERTIFICATE_DECODER_MD=
# SECUTILS_HTML_APP_RESPONDER_ID_MARKDOWN_TO_HTML=
# SECUTILS_HTML_APP_RESPONDER_ID_MARKDOWN_TO_HTML_MD=
# SECUTILS_HTML_APP_RESPONDER_ID_PDF_EXTRACTOR=
# SECUTILS_HTML_APP_RESPONDER_ID_PDF_EXTRACTOR_MD=
# SECUTILS_HTML_APP_RESPONDER_ID_ECHO=
# SECUTILS_HTML_APP_RESPONDER_ID_ECHO_MD=
# SECUTILS_HTML_APP_RESPONDER_ID_LLMS_TXT=
# SECUTILS_HTML_APP_RESPONDER_ID_ROBOTS_TXT=
# SECUTILS_HTML_APP_RESPONDER_ID_SITEMAP_XML=
# SECUTILS_HTML_APP_RESPONDER_ID_AGENT_SKILLS_INDEX=