lew/guestbook
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: readme

Browse source
This commit is contained in:
Lewis Wynne 2026-04-09 20:28:31 +01:00
parent 21cadb630b
commit f9f4d9e1de
4 changed files with 372 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

42
.env.example
View file

@ -1,11 +1,11 @@
# Port to listen on (binds to 127.0.0.1).
BOOK_PORT=8123
# BOOK_PORT=8123
# Directory for guestbook entry files.
BOOK_DATA_DIR=./data
# BOOK_DATA_DIR=./data
# Site title shown in nav and page title.
BOOK_SITE_TITLE=guestbook
# BOOK_SITE_TITLE=guestbook
# Telegram bot token. Optional — if unset, telegram moderation is disabled.
# BOOK_TELEGRAM_BOT_TOKEN=your-bot-token-here
@ -14,21 +14,21 @@ BOOK_SITE_TITLE=guestbook
# BOOK_TELEGRAM_CHAT_ID=0
# Enable honeypot field for spam prevention.
BOOK_ENABLE_HONEYPOT=true
# BOOK_ENABLE_HONEYPOT=true
# Allow new guestbook submissions. When false, the form is hidden and submissions are rejected.
BOOK_ENABLE_SUBMISSIONS=true
# BOOK_ENABLE_SUBMISSIONS=true
# Show website field in form and render website links in entries.
# When false, the input is hidden, submitted values are ignored, and existing links are not displayed.
BOOK_ENABLE_WEBSITE_LINKS=true
# BOOK_ENABLE_WEBSITE_LINKS=true
# Allow raw HTML/JS in entry names and message bodies. When false, HTML is escaped.
# Website URLs are always escaped regardless of this setting.
BOOK_ENABLE_HTML_INJECTION=false
# BOOK_ENABLE_HTML_INJECTION=false
# Enable captcha on submission form.
BOOK_ENABLE_CAPTCHA=false
# BOOK_ENABLE_CAPTCHA=false
# Captcha question displayed as a label.
# BOOK_CAPTCHA_QUESTION=What is my name?
@ -37,22 +37,22 @@ BOOK_ENABLE_CAPTCHA=false
# BOOK_CAPTCHA_ANSWER=lew
# Require exact match (true) or just "contains" (false).
BOOK_CAPTCHA_EXACT=false
# BOOK_CAPTCHA_EXACT=false
# Require case-sensitive match.
BOOK_CAPTCHA_CASESENSITIVE=false
# BOOK_CAPTCHA_CASESENSITIVE=false
# Maximum length for names. 0 for unlimited.
BOOK_MAX_NAME_LENGTH=0
# BOOK_MAX_NAME_LENGTH=0
# Maximum length for messages. 0 for unlimited.
BOOK_MAX_MESSAGE_LENGTH=0
# BOOK_MAX_MESSAGE_LENGTH=0
# Maximum length for website URLs. 0 for unlimited.
BOOK_MAX_WEBSITE_LENGTH=0
# BOOK_MAX_WEBSITE_LENGTH=0
# Separator between guestbook entries.
BOOK_SEPARATOR=------------------------------------------------------------
# BOOK_SEPARATOR=------------------------------------------------------------
# Path to a CSS file. Takes precedence over BOOK_STYLE.
# BOOK_STYLE_FILE=./templates/default.css
@ -64,25 +64,25 @@ BOOK_SEPARATOR=------------------------------------------------------------
# BOOK_STYLE=
# Text shown above the form.
BOOK_FORM_PROMPT=Thanks for visiting. Sign the guestbook!
# BOOK_FORM_PROMPT=Thanks for visiting. Sign the guestbook!
# Submit button text.
BOOK_BUTTON_TEXT=sign
# BOOK_BUTTON_TEXT=sign
# Label for the name field.
BOOK_LABEL_NAME=Your name:
# BOOK_LABEL_NAME=Your name:
# Label for the website field.
BOOK_LABEL_WEBSITE=Your website (optional):
# BOOK_LABEL_WEBSITE=Your website (optional):
# Label for the message field.
BOOK_LABEL_MESSAGE=Your message:
# BOOK_LABEL_MESSAGE=Your message:
# Number of rows for the message textarea.
BOOK_TEXTAREA_ROWS=8
# BOOK_TEXTAREA_ROWS=8
# Number of columns for the message textarea.
BOOK_TEXTAREA_COLS=60
# BOOK_TEXTAREA_COLS=60
# Custom HTML template file with {{title}}, {{form}}, {{entries}}, and {{style}} placeholders.
# Uses built-in default if unset.