hoelee
5d9db48a26
- README rewritten around a copy-paste quick start (CLI and Portainer), verified alert test, day-to-day NocoDB operations, troubleshooting table, FAQ - new docker-compose.allinone.yml: NocoDB (pinned 2026.09.0, SQLite) + monitor on a private network, with healthchecks and the Telegram IPv4 pin documented - docs/: QUICKSTART-PORTAINER, TELEGRAM-SETUP, NOCODB-SETUP, ARCHITECTURE, OPERATIONS, TROUBLESHOOTING (replace DOCUMENTATION.md + COMPOSE-SETUP.md) - secrets: SECRETS.md is gitignored and untracked; tracked template is SECRETS.example.md; real base id / chat id removed from .env.example - LICENSE (MIT), .gitignore/.dockerignore tidied - AGENTS.md: layout, iron rules, verification gates; host-specific deploy details moved to the gitignored OPS-INTERNAL.md
75 lines
3.4 KiB
Bash
75 lines
3.4 KiB
Bash
# =============================================================================
|
|
# carousell-monitor — example environment file
|
|
#
|
|
# Copy to `.env` and fill in:
|
|
# cp .env.example .env
|
|
#
|
|
# `.env` is gitignored. NEVER commit real values.
|
|
# Every value below is read by docker compose (`${VAR}`) and passed into the
|
|
# container. Operational knobs (which searches to watch, how often) are NOT
|
|
# here — they live in NocoDB's `Settings` table, so you can change them from
|
|
# the web UI without a restart.
|
|
# =============================================================================
|
|
|
|
# ----------------------------------------------------------------------------
|
|
# NocoDB (the archive database) — REQUIRED
|
|
# ----------------------------------------------------------------------------
|
|
# Where the monitor talks to NocoDB.
|
|
# all-in-one stack : http://nocodb:8080 (the compose service name)
|
|
# existing NocoDB : the container's name on the shared docker network
|
|
NOCODB_URL=http://nocodb:8080
|
|
|
|
# The base that holds the four tables. Open the base in NocoDB and copy the id
|
|
# out of the browser URL:
|
|
# http://<host>:8080/dashboard/#/nc/base/<THIS_PART>/...
|
|
NOCODB_BASE_ID=
|
|
|
|
# NocoDB API token (starts with `nc_pat_`). Create it in NocoDB:
|
|
# avatar (bottom-left) -> Account Settings -> Tokens -> Create token
|
|
# You may leave it blank for the very first start — the monitor refuses to run
|
|
# with a clear error until it is set.
|
|
NOCODB_TOKEN=
|
|
|
|
# ----------------------------------------------------------------------------
|
|
# Telegram (where alerts are sent) — REQUIRED
|
|
# ----------------------------------------------------------------------------
|
|
# 1. Talk to @BotFather in Telegram -> /newbot -> copy the token it gives you.
|
|
# 2. Get your numeric chat id from @userinfobot (send it any message).
|
|
# For a group: add the bot to the group, send a message, then read chat.id
|
|
# from https://api.telegram.org/bot<TOKEN>/getUpdates
|
|
TELEGRAM_BOT_TOKEN=
|
|
TELEGRAM_CHAT_ID=
|
|
|
|
# ----------------------------------------------------------------------------
|
|
# NocoDB container settings (all-in-one stack only)
|
|
# ----------------------------------------------------------------------------
|
|
# Signing secret for NocoDB login sessions. Generate one:
|
|
# openssl rand -hex 32
|
|
NC_AUTH_JWT_SECRET=
|
|
|
|
# Host port for the NocoDB web UI -> container port 8080.
|
|
NOCODB_PORT=8080
|
|
|
|
# ----------------------------------------------------------------------------
|
|
# Optional tuning (defaults are sane; leave blank to use the defaults)
|
|
# ----------------------------------------------------------------------------
|
|
# How often the monitor wakes up (seconds). This is the heartbeat, not the
|
|
# per-search interval — that one is `check_interval_minutes` in NocoDB.
|
|
TICK_SECONDS=60
|
|
|
|
# Minimum pause (seconds) between two Carousell requests inside one tick.
|
|
# Prevents a burst of requests when many searches come due at once. 0 disables.
|
|
FETCH_GAP_SECONDS=1
|
|
|
|
# A tick that fails every watch marks the container unhealthy. One flaky
|
|
# search should not, so the tick is only "failed" when this fraction of the
|
|
# watches failed (1.0 = all of them must fail; 0 = never fail).
|
|
FAILURE_RATIO_THRESHOLD=1.0
|
|
|
|
# Send the Telegram failure alert only after this many consecutive failed
|
|
# ticks, and one recovery notice when it clears (debounce, avoids spam).
|
|
ERROR_ALERT_AFTER=3
|
|
|
|
# Container clock. Timestamps written to NocoDB are UTC on purpose.
|
|
TZ=Asia/Kuala_Lumpur
|