From 5bd474278cbbabcff18028a0dc3b8c0a1989f8aa Mon Sep 17 00:00:00 2001
From: Mimic890 <144267059+Mimic890@users.noreply.github.com>
Date: Wed, 4 Nov 2026 22:46:51 +0300
Subject: [PATCH 1/2] feat: add a favicon link and GET /favicon.ico
---
internal/server/pages.go | 15 +++++++++++++++
internal/server/pages_test.go | 20 ++++++++++++++++++++
internal/server/server.go | 1 +
internal/server/web/static/favicon.svg | 1 +
internal/server/web/templates/layout.html | 1 +
5 files changed, 38 insertions(+)
create mode 100644 internal/server/web/static/favicon.svg
diff --git a/internal/server/pages.go b/internal/server/pages.go
index aa63a2a..f2c9d3a 100644
--- a/internal/server/pages.go
+++ b/internal/server/pages.go
@@ -92,6 +92,7 @@ type pages struct {
tmpl map[string]map[string]*template.Template // lang → page → template
css []byte
cssV string
+ mark []byte // built-in mark, for /favicon.ico
scripts map[string]script // file name → script
fonts fs.FS
@@ -162,6 +163,9 @@ func newPages(log *slog.Logger, cfg *config.Config, d Deps) *pages {
}
p.scripts[name] = script{body: b, url: versioned("/static/"+name, b)}
}
+ if p.mark, err = webFS.ReadFile("web/static/favicon.svg"); err != nil {
+ panic(err)
+ }
p.fonts, err = fs.Sub(webFS, "web/static/fonts")
if err != nil {
panic(err)
@@ -587,6 +591,17 @@ func (p *pages) style(w http.ResponseWriter, _ *http.Request) {
_, _ = w.Write(p.css)
}
+// favicon never answers 404: it redirects to the bucket logo when there is one, else serves the built-in mark.
+func (p *pages) favicon(w http.ResponseWriter, r *http.Request) {
+ w.Header().Set("Cache-Control", "public, max-age=3600") // the logo can appear or go with any sync
+ if ix := p.index(); ix != nil && ix.Logo {
+ http.Redirect(w, r, "/assets/logo.svg", http.StatusFound)
+ return
+ }
+ w.Header().Set("Content-Type", "image/svg+xml")
+ _, _ = w.Write(p.mark)
+}
+
func (p *pages) font(w http.ResponseWriter, r *http.Request) {
name := r.PathValue("file")
if ext := path.Ext(name); ext != ".woff2" && ext != ".txt" {
diff --git a/internal/server/pages_test.go b/internal/server/pages_test.go
index c91658d..93cdf21 100644
--- a/internal/server/pages_test.go
+++ b/internal/server/pages_test.go
@@ -274,3 +274,23 @@ func TestStatic(t *testing.T) {
}
}
}
+
+func TestFavicon(t *testing.T) {
+ ix := testIndex(1)
+ s := newSite(t, testConfig(), ix)
+ mustContain(t, s.get("/").Body.String(), ``)
+ for _, idx := range []*content.Index{ix, nil} { // nil: still starting, no index yet
+ s.idx.Store(idx)
+ rec := s.get("/favicon.ico")
+ if rec.Code != 200 || rec.Header().Get("Content-Type") != "image/svg+xml" || !strings.HasPrefix(rec.Body.String(), "`)
+ if rec := s.get("/favicon.ico"); rec.Code != http.StatusFound || rec.Header().Get("Location") != "/assets/logo.svg" {
+ t.Errorf("favicon with logo = %d %q", rec.Code, rec.Header().Get("Location"))
+ }
+}
diff --git a/internal/server/server.go b/internal/server/server.go
index bfc934d..ee10e59 100644
--- a/internal/server/server.go
+++ b/internal/server/server.go
@@ -39,6 +39,7 @@ func New(log *slog.Logger, cfg *config.Config, d Deps) http.Handler {
mux.HandleFunc("GET /sitemap.xml", p.sitemap)
mux.HandleFunc("GET /robots.txt", p.robots)
mux.HandleFunc("GET /llms.txt", p.llms)
+ mux.HandleFunc("GET /favicon.ico", p.favicon)
if key := cfg.IndexNowKey; key != "" { // the config allows only [a-zA-Z0-9-]
mux.HandleFunc("GET /"+key+".txt", func(w http.ResponseWriter, _ *http.Request) {
writeText(w, "text/plain; charset=utf-8", key)
diff --git a/internal/server/web/static/favicon.svg b/internal/server/web/static/favicon.svg
new file mode 100644
index 0000000..4f37ffa
--- /dev/null
+++ b/internal/server/web/static/favicon.svg
@@ -0,0 +1 @@
+
diff --git a/internal/server/web/templates/layout.html b/internal/server/web/templates/layout.html
index cb603d7..b0240f5 100644
--- a/internal/server/web/templates/layout.html
+++ b/internal/server/web/templates/layout.html
@@ -33,6 +33,7 @@
{{- with .JSONLD}}
{{- end}}
+
{{- range .JS}}
From b5943fcbd6e211458dba54f8b735f0453d49312a Mon Sep 17 00:00:00 2001
From: Mimic890 <144267059+Mimic890@users.noreply.github.com>
Date: Wed, 4 Nov 2026 22:46:51 +0300
Subject: [PATCH 2/2] docs: add /favicon.ico to the endpoint table and the
Decision log
---
README.md | 2 +-
README.ru.md | 2 +-
SPEC.md | 4 +++-
SPEC.ru.md | 4 +++-
4 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index d556891..866dca3 100644
--- a/README.md
+++ b/README.md
@@ -181,7 +181,7 @@ Rules:
- Unknown fields are ignored, so Obsidian can add its own.
- Images: standard Markdown, ``. A path `assets/…` becomes `/assets/…` on the site. External images are blocked by the CSP.
- Allowed asset types: `png jpg jpeg webp avif gif svg mp4 webm`.
-- `assets/logo.svg`, if present, replaces the built-in logo in the top bar.
+- `assets/logo.svg`, if present, replaces the built-in logo in the top bar and the favicon.
## Publishing from Obsidian
diff --git a/README.ru.md b/README.ru.md
index 417d24c..a997c81 100644
--- a/README.ru.md
+++ b/README.ru.md
@@ -181,7 +181,7 @@ draft: false
- Неизвестные поля игнорируются, так что Obsidian может добавлять свои.
- Картинки — обычный Markdown, ``. Путь `assets/…` на сайте становится `/assets/…`. Внешние картинки блокирует CSP.
- Разрешённые типы ассетов: `png jpg jpeg webp avif gif svg mp4 webm`.
-- `assets/logo.svg`, если есть, заменяет встроенный логотип в верхней панели.
+- `assets/logo.svg`, если есть, заменяет встроенный логотип в верхней панели и фавиконку.
## Публикация из Obsidian
diff --git a/SPEC.md b/SPEC.md
index eb4e356..e600111 100644
--- a/SPEC.md
+++ b/SPEC.md
@@ -120,7 +120,7 @@ Proposed variables (final names set during implementation):
## Bucket layout
- `assets/` — all assets: covers, images in posts. Decided.
-- `assets/logo.svg` — optional site logo in the top bar. Without it the service shows a built-in mark.
+- `assets/logo.svg` — optional site logo in the top bar and favicon. Without it the service shows a built-in mark.
- The service ignores keys where any path segment starts with `.` or `_` (same rule as Remotely Save).
### Posts
@@ -421,6 +421,7 @@ Trust boundaries: internet → Caddy → service; bucket → service (semi-trust
| `/metrics` | GET | private network | Caddy block, `METRICS_ALLOW` |
| `/healthz` | GET | public | constant body, no data |
| `/prefs` | POST | public | form body ≤ 4 KB, enum check for `theme` / `lang`, redirect only to a local path |
+| `/favicon.ico` | GET | public | built-in SVG mark, or `302` to `/assets/logo.svg` when the bucket has a logo; never `404` |
| `/static/*` | GET | public | embedded CSS, JS and fonts only, no directory listing |
| `/.txt` | GET | public | only if `INDEXNOW_KEY` is set; body is the key |
@@ -617,3 +618,4 @@ Other methods → `405`. Unknown paths → `404`.
- 2026-11-04 — Metrics, votes, limits: SQLite `DATA_DIR/hyperhack.db` (`modernc.org/sqlite` `v1.61.0`, `0600`, WAL). All-time counters per post and label (Grafana gets daily trends with `increase()`), daily views only for "Popular" (pruned after `POPULAR_DAYS`). Search queries: live requests from `search.js` (`X-Search: live`) are not stored, the settled query is; TTL 90 days, at most 10 000 rows, top 20 in `/metrics`, refreshed every 5 min. ALTCHA: `altcha-lib-go/v2` `v2.4.1`, v2 challenge with SHA-256, cost 1, `uint32` counter up to `ALTCHA_MAX_NUMBER`, key signature; own small solver `static/altcha.js` instead of the widget; signing keys derived from `ALTCHA_HMAC_KEY`; replay map capped at 100 000. Beacon: a delta on every hide and `pagehide`, sent with `fetch(…, {keepalive: true})` (JSON body), each with a random per-page-view id; the server sums time per view and clamps the sum to 4 h; time on page = average over views with reading time. Views and read depth: once per visitor per post per day; daily hashes in memory only (cap 200 000), `ip_prefix` = IPv4 address or IPv6 `/64`. Source `internal` for referrers from the site itself. Outbound hosts limited to links in the post. `/api/altcha` and `/api/vote` share `RATE_LIMIT_VOTE`; limiter tracks at most 10 000 clients. Vote cookie stored as SHA-256. "Popular" after "Newest" on page 1. `/metrics` in Prometheus text format written with the standard library.
- 2026-11-04 — Grafana, Caddy, README: dashboard `grafana/hyperhack.json` for a Prometheus-type data source on VictoriaMetrics (uses the VictoriaMetrics function `sort_by_label_numeric`); daily bars cover the day that starts at the bar, so today is shown. `Caddyfile.example` for Caddy `v2.11.7` with `caddy-ratelimit` `v0.1.0` (1200 requests per minute per client IP; `/static/*` and `/assets/*` are not counted) and `caddy-crowdsec-bouncer` `v0.14.1`; `/metrics` and `/reindex` (and their subpaths) answer `404` on the public domain; compression `zstd`/`gzip`. README: behind Caddy on the host, `TRUSTED_PROXIES` is the gateway of the Compose network. Full README in English and Russian.
- 2026-11-04 — Production Compose: image registry GHCR (confirmed). `docker-compose.yml` only pulls the released image, no `build:`, pinned to the latest release (`0.1.0`; image tags are the git tag without `v`). Local builds in `compose.dev.yml`, used only with `-f`; no `docker-compose.override.yml`. README Quick start uses the downloaded `docker-compose.yml` as is, and README documents upgrades and rollback.
+- 2026-11-04 — Favicon: every page has `` pointing to `/assets/logo.svg` when the bucket has it, else to `/favicon.ico`. `GET /favicon.ico` serves the built-in mark as SVG (accent background, white mark, fixed colors), or answers `302` to `/assets/logo.svg` when the logo exists; `Cache-Control: max-age=3600`, since the logo can change with any sync. Never `404`.
diff --git a/SPEC.ru.md b/SPEC.ru.md
index 2026f52..750f3cd 100644
--- a/SPEC.ru.md
+++ b/SPEC.ru.md
@@ -120,7 +120,7 @@
## Структура бакета
- `assets/` — все ассеты: обложки, картинки в постах. Решено.
-- `assets/logo.svg` — необязательный логотип сайта в верхнем баре. Без него сервис показывает встроенный знак.
+- `assets/logo.svg` — необязательный логотип сайта в верхнем баре и фавиконка. Без него сервис показывает встроенный знак.
- Сервис игнорирует ключи, где любой сегмент пути начинается с `.` или `_` (как Remotely Save).
### Посты
@@ -421,6 +421,7 @@ Garage не шлёт уведомления об изменениях в бак
| `/metrics` | GET | приватная сеть | блок в Caddy, `METRICS_ALLOW` |
| `/healthz` | GET | публичный | постоянный ответ, без данных |
| `/prefs` | POST | публичный | тело формы ≤ 4 КБ, проверка перечислений `theme` / `lang`, редирект только на локальный путь |
+| `/favicon.ico` | GET | публичный | встроенный знак в SVG или `302` на `/assets/logo.svg`, если в бакете есть логотип; никогда не `404` |
| `/static/*` | GET | публичный | только встроенные CSS, JS и шрифты, без листинга папок |
| `/.txt` | GET | публичный | только если задан `INDEXNOW_KEY`; в теле — ключ |
@@ -617,3 +618,4 @@ Garage не шлёт уведомления об изменениях в бак
- 2026-11-04 — Метрики, голоса, лимиты: SQLite `DATA_DIR/hyperhack.db` (`modernc.org/sqlite` `v1.61.0`, `0600`, WAL). Счётчики за всё время по посту и метке (дневные тренды Grafana считает через `increase()`), дневные просмотры — только для «Популярных» (удаляются старше `POPULAR_DAYS`). Поисковые запросы: живые запросы `search.js` (`X-Search: live`) не сохраняются, сохраняется устоявшийся запрос; TTL 90 дней, не больше 10 000 строк, топ-20 в `/metrics`, обновляется раз в 5 минут. ALTCHA: `altcha-lib-go/v2` `v2.4.1`, задача v2 с SHA-256, cost 1, счётчик `uint32` до `ALTCHA_MAX_NUMBER`, подпись ключа; свой маленький решатель `static/altcha.js` вместо виджета; ключи подписи выводятся из `ALTCHA_HMAC_KEY`; карта повторов ограничена 100 000. Beacon: дельта при каждом скрытии и `pagehide`, отправка через `fetch(…, {keepalive: true})` (тело JSON), в каждой — случайный id просмотра страницы; сервер суммирует время по просмотру и ограничивает сумму 4 ч; время на странице — среднее по просмотрам со временем чтения. Просмотры и глубина чтения: один раз на посетителя, пост и день; суточные хеши только в памяти (не больше 200 000), `ip_prefix` — адрес IPv4 или `/64` IPv6. Источник `internal` для переходов с самого сайта. Внешние домены — только из ссылок поста. `/api/altcha` и `/api/vote` делят `RATE_LIMIT_VOTE`; лимитер помнит не больше 10 000 клиентов. Cookie голоса хранится как SHA-256. «Популярные» после «Новых» на первой странице. `/metrics` в текстовом формате Prometheus, написан на стандартной библиотеке.
- 2026-11-04 — Grafana, Caddy, README: дашборд `grafana/hyperhack.json` для источника данных типа Prometheus на VictoriaMetrics (использует функцию VictoriaMetrics `sort_by_label_numeric`); дневной столбец покрывает день, который начинается в его точке, поэтому сегодняшний день виден. `Caddyfile.example` для Caddy `v2.11.7` с `caddy-ratelimit` `v0.1.0` (1200 запросов в минуту на IP клиента; `/static/*` и `/assets/*` не учитываются) и `caddy-crowdsec-bouncer` `v0.14.1`; `/metrics` и `/reindex` (и их подпути) на публичном домене отвечают `404`; сжатие `zstd`/`gzip`. README: если Caddy на хосте, `TRUSTED_PROXIES` — шлюз сети Compose. Полный README на английском и русском.
- 2026-11-04 — Продакшен Compose: реестр образов GHCR (подтверждено). `docker-compose.yml` только скачивает выпущенный образ, без `build:`, закреплён последний релиз (`0.1.0`; тег образа — git-тег без `v`). Локальная сборка в `compose.dev.yml`, только через `-f`; без `docker-compose.override.yml`. Быстрый старт в README использует скачанный `docker-compose.yml` без правок, README описывает обновление и откат.
+- 2026-11-04 — Фавиконка: на каждой странице `` ведёт на `/assets/logo.svg`, если он есть в бакете, иначе на `/favicon.ico`. `GET /favicon.ico` отдаёт встроенный знак в SVG (фон акцентного цвета, белый знак, цвета фиксированные) или отвечает `302` на `/assets/logo.svg`, если логотип есть; `Cache-Control: max-age=3600`, потому что логотип может измениться с любой синхронизацией. Никогда не `404`.