Skip to content
Back to search

earful

Self-hosted bug report, crash and feedback inbox: one Rust binary + SQLite, anti-spam without CAPTCHAs, offline semantic search, MCP server for AI agents

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/georgevibing--earful/badge.svg)](/listings/georgevibing--earful)

HTML

<a href="/listings/georgevibing--earful"><img src="/api/listings/georgevibing--earful/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

You need Docker. Three commands and you have an inbox:

git clone https://github.com/georgevibing/earful && cd earful
printf "EARFUL_ADMIN_PASSWORD_HASH='%s'\n" "$(printf '%s' 'choose-a-long-password' | docker run --rm -i $(docker build -q .) hash-password)" > .env
docker compose up -d --build

Open **http://127.0.0.1:8080/admin/**, sign in, create a project and copy its snippet. Done.

The compose file binds to `127.0.0.1` only. For a public instance put it behind an HTTPS proxy: see [Deploy](#-deploy).

<details> <summary><b>Build from source instead</b></summary>

<br>

Prerequisites: Rust stable (rustup), Node 22+ and pnpm (`corepack enable`).

pnpm install
pnpm build:web                       # widget + admin UI, embedded into the binary
cargo build --release

export EARFUL_ADMIN_PASSWORD_HASH="$(printf '%s' 'choose-a-long-password' | ./target/release/earful hash-password)"
export EARFUL_COOKIE_SECURE=false        # plain http on localhost only
./target/release/earful download-model   # optional: offline semantic search
./target/release/earful serve

The server listens on `127.0.0.1:8080`. Without `EARFUL_ADMIN_PASSWORD_HASH` every login fails, by design.

</details>

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 376 lines
  1. <div align="center">
  2. <picture>
  3. <source media="(prefers-color-scheme: dark)" srcset="docs/assets/logo-dark.svg">
  4. <img alt="Earful" src="docs/assets/logo-light.svg" width="260">
  5. </picture>
  6. ### Let your players give you an earful.
  7. Bug reports, crash logs and feedback from everything you ship.<br>One 10 MB self-hosted binary. No accounts. No CAPTCHAs. No spam.
  8. [![CI](https://github.com/georgevibing/earful/actions/workflows/ci.yml/badge.svg)](https://github.com/georgevibing/earful/actions/workflows/ci.yml)
  9. [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
  10. [![Rust 2024](https://img.shields.io/badge/rust-2024%20edition-orange.svg?logo=rust)](https://www.rust-lang.org)
  11. [![SQLite](https://img.shields.io/badge/storage-SQLite-003B57.svg?logo=sqlite)](https://sqlite.org)
  12. [![MCP: 23 tools](https://img.shields.io/badge/MCP-23%20tools-8A2BE2.svg)](docs/mcp.md)
  13. [![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
  14. [Quickstart](#-quickstart) ·
  15. [Features](#-features) ·
  16. [Integrate](#-drop-it-into-your-product) ·
  17. [Anti-spam](#%EF%B8%8F-spam-protection-without-captchas) ·
  18. [Agents](#-let-your-agent-triage) ·
  19. [Docs](docs/)
  20. <br>
  21. <picture>
  22. <source media="(prefers-color-scheme: dark)" srcset="docs/assets/inbox-dark.png">
  23. <img alt="The feedback inbox: a hybrid search for 'game crash' with highlighted hits and the detail panel showing metadata and similar reports" src="docs/assets/inbox-light.png" width="100%">
  24. </picture>
  25. </div>
  26. ## Why Earful?
  27. You shipped a game, a web app or a CLI. Now you want to hear from the people using it, without making them sign up, without paying per seat for a SaaS inbox, and without wading through bot spam.
  28. Earful is a self-hosted inbox for exactly that. Players and users report bugs **anonymously** through a hosted page, a one-line widget or a plain HTTP API. Nine layers of invisible anti-spam keep scripts out. You find anything again with typo-tolerant, keyword and **semantic search that runs fully offline**. And your coding agent can triage the whole inbox for you over **MCP**.
  29. | | Earful | GitHub Issues | SaaS feedback tools |
  30. | --- | :---: | :---: | :---: |
  31. | Reporters need an account | **No** | Yes | Often |
  32. | Self-hosted, your data stays yours | **Yes** | No | No |
  33. | Runs on a $5 VPS (about 10 MB RAM idle) | **Yes** | n/a | n/a |
  34. | Spam protection without CAPTCHAs | **Yes** | n/a | Varies |
  35. | Crash and log reports from games | **Yes** | No | Rarely |
  36. | Semantic search with no external API | **Yes** | No | No |
  37. | Built-in MCP server for AI agents | **Yes** | Third party | Rarely |
  38. | Price | **Free, MIT** | Free | Monthly |
  39. ## 🚀 Quickstart
  40. You need Docker. Three commands and you have an inbox:
  41. ```sh
  42. git clone https://github.com/georgevibing/earful && cd earful
  43. printf "EARFUL_ADMIN_PASSWORD_HASH='%s'\n" "$(printf '%s' 'choose-a-long-password' | docker run --rm -i $(docker build -q .) hash-password)" > .env
  44. docker compose up -d --build
  45. ```
  46. Open **http://127.0.0.1:8080/admin/**, sign in, create a project and copy its snippet. Done.
  47. The compose file binds to `127.0.0.1` only. For a public instance put it behind an HTTPS proxy: see [Deploy](#-deploy).
  48. <details>
  49. <summary><b>Build from source instead</b></summary>
  50. <br>
  51. Prerequisites: Rust stable (rustup), Node 22+ and pnpm (`corepack enable`).
  52. ```sh
  53. pnpm install
  54. pnpm build:web # widget + admin UI, embedded into the binary
  55. cargo build --release
  56. export EARFUL_ADMIN_PASSWORD_HASH="$(printf '%s' 'choose-a-long-password' | ./target/release/earful hash-password)"
  57. export EARFUL_COOKIE_SECURE=false # plain http on localhost only
  58. ./target/release/earful download-model # optional: offline semantic search
  59. ./target/release/earful serve
  60. ```
  61. The server listens on `127.0.0.1:8080`. Without `EARFUL_ADMIN_PASSWORD_HASH` every login fails, by design.
  62. </details>
  63. ## ✨ Features
  64. - **📥 Collect from anywhere.** A hosted page at `/s/<slug>`, an embeddable widget (about 9 KB gzipped, Shadow DOM, light and dark), or the HTTP API from Unity, Godot, C++, Python or `curl`.
  65. - **💥 Bugs, feedback, crashes, exceptions and logs.** Attach version, platform and GPU in `meta`, and up to 64 KB of stack traces and log tails in `diagnostics`. See the [crash reporting guide](docs/crash-reporting.md).
  66. - **🛡️ Spam-proof without friction.** Proof of work, signed single-use challenges, rate limits, a honeypot, heuristics and near-duplicate detection. No CAPTCHA, no account.
  67. - **🔎 Find anything.** Fuzzy (`invetnory crsh` finds "Inventory crash"), BM25 keyword, semantic, and a hybrid mode that fuses all three. "Similar reports" on every item makes duplicates obvious.
  68. - **🏷️ Triage fast.** Status tabs, multi-label filters (all/any/unlabeled), bulk actions, keyboard shortcuts, notes, a themes dashboard, CSV and JSON export.
  69. - **🤖 Agent-ready.** A built-in MCP server with 23 tools and 4 prompts lets Claude Code, Cursor or VS Code triage, label, de-duplicate and write release notes.
  70. - **🪶 Tiny and boring to run.** One Rust binary with the UI embedded, one SQLite file, no Redis, no Postgres, no queue. A distroless Docker image with a health check.
  71. - **🔒 Private by default.** Raw IPs are never stored (keyed HMAC pseudonyms only), there's a single argon2id admin login, a strict CSP, and it binds localhost unless told otherwise.
  72. <table>
  73. <tr>
  74. <td width="50%">
  75. <picture>
  76. <source media="(prefers-color-scheme: dark)" srcset="docs/assets/dashboard-dark.png">
  77. <img alt="Dashboard with totals, a 30 day bug vs feedback chart, blocked spam by reason and per project counts" src="docs/assets/dashboard-light.png">
  78. </picture>
  79. <p align="center"><b>Dashboard</b>: activity, blocked spam, themes</p>
  80. </td>
  81. <td width="50%">
  82. <picture>
  83. <source media="(prefers-color-scheme: dark)" srcset="docs/assets/project-dark.png">
  84. <img alt="Project page with the ingest key and copy-paste integration snippets" src="docs/assets/project-light.png">
  85. </picture>
  86. <p align="center"><b>Project</b>: ingest key and ready-to-paste snippets</p>
  87. </td>
  88. </tr>
  89. <tr>
  90. <td width="50%">
  91. <picture>
  92. <source media="(prefers-color-scheme: dark)" srcset="docs/assets/hosted-dark.png">
  93. <img alt="Hosted feedback page for a game, with bug report and feedback modes" src="docs/assets/hosted-light.png">
  94. </picture>
  95. <p align="center"><b>Hosted page</b>: share a link, no code needed</p>
  96. </td>
  97. <td width="50%">
  98. <picture>
  99. <source media="(prefers-color-scheme: dark)" srcset="docs/assets/widget-dark.png">
  100. <img alt="The floating feedback widget open on a third party web app" src="docs/assets/widget-light.png">
  101. </picture>
  102. <p align="center"><b>Widget</b>: one script tag on any site</p>
  103. </td>
  104. </tr>
  105. </table>
  106. <sub>Screenshots follow your GitHub theme and are generated from seeded demo data by <a href="scripts/screenshots.mjs"><code>scripts/screenshots.mjs</code></a>.</sub>
  107. ## 🔌 Drop it into your product
  108. Create a project in the admin UI and copy its ingest key. The key ships inside your game or page, so it is public by design (rotate it any time). The project page shows every snippet below, prefilled.
  109. **No code:** link to `https://<your-host>/s/<slug>` from your game menu, store page or Discord.
  110. **Any website:** one script tag adds a floating feedback button:
  111. ```html
  112. <script src="https://<your-host>/widget.js" data-earful-key="ear_..." defer></script>
  113. ```
  114. Prefer an inline form? Use `<div data-earful-inline data-earful-key="ear_..."></div>`. Bundler users get an ESM client: see [packages/widget](packages/widget/README.md).
  115. **Games and native apps:** fetch a challenge, solve a small proof of work, submit:
  116. ```sh
  117. BASE=https://<your-host> KEY=ear_...
  118. CH=$(curl -s "$BASE/api/v1/challenge?key=$KEY")
  119. TOKEN=$(echo "$CH" | jq -r .challenge) BITS=$(echo "$CH" | jq -r .bits)
  120. NONCE=$(earful solve "$TOKEN" "$BITS")
  121. curl -s "$BASE/api/v1/feedback" -H 'Content-Type: application/json' -d @- <<EOF
  122. {"key":"$KEY","kind":"bug","title":"Crash on launch","body":"Black screen, then crash to desktop.",
  123. "meta":{"version":"1.2.3","platform":"windows"},"challenge":"$TOKEN","nonce":"$NONCE"}
  124. EOF
  125. ```
  126. Copy-paste examples for **Unity (C#), Godot 4, C++ and Python** are in [docs/integrations.md](docs/integrations.md). The full HTTP contract is [docs/api.md](docs/api.md).
  127. ## 🛡️ Spam protection without CAPTCHAs
  128. Every submission runs through a fixed pipeline. Errors a real client needs to know about are returned. Everything else answers `202 {"ok": true}`, so spammers never learn what got caught, and soft signals quarantine instead of reject, so you never lose a real report.
  129. | Layer | What it does | On failure |
  130. | --- | --- | --- |
  131. | Ingest key | Scopes every request to one project; rotatable, pausable | `404` / `403` |
  132. | Honeypot | Hidden field only bots fill in | Silently dropped |
  133. | Validation | Length caps, UTF-8, control characters stripped | `400` |
  134. | Rate limits | Sliding windows per IP and project, per IP globally, per project globally | `429` + `Retry-After` |
  135. | Proof of work | SHA-256 puzzle, about 0.2 s in a browser, harder for repeat senders and under load | `400` |
  136. | Single-use challenge | HMAC-signed, project-bound, expires after 30 minutes | `400` |
  137. | Minimum fill time | Submitted less than 2 s after the challenge | Quarantined |
  138. | Exact duplicate | Same text within 24 h: dropped from the same IP, merged (`+1`) from another | Dropped or merged |
  139. | Heuristics | Links, shorteners, spam phrases, shouting, repetition | Quarantined |
  140. | Near duplicate | Paraphrased repeats from one IP (embedding similarity ≥ 0.95) | Quarantined |
  141. Quarantined items wait in the **Spam** tab, one click from being restored. The reasoning behind each layer is in [docs/architecture.md](docs/architecture.md).
  142. ## 🔎 Search that understands players
  143. | Mode | How | Best for |
  144. | --- | --- | --- |
  145. | `hybrid` (default) | Reciprocal rank fusion of the three below | Everyday searching |
  146. | `fuzzy` | FTS5 trigrams + typo-tolerant edit distance | Half-remembered words, typos |
  147. | `keyword` | FTS5 with Porter stemming, BM25 ranked | Error strings, exact terms |
  148. | `semantic` | Cosine similarity over embeddings | "game freezes" → "stuck on the loading screen" |
  149. Semantic search works **offline out of the box**: the Docker image bundles the 31 MB [Model2Vec](https://github.com/MinishLab/model2vec) `potion-base-8M` model (no GPU, no API, about 13 µs per embedding). It finds "the Steam trophy never popped" for "achievement didn't unlock", and "billed two times" for "refund for double payment". Want more? Point it at OpenAI, Ollama or any OpenAI-compatible `/embeddings` endpoint.
  150. <details>
  151. <summary><b>Embedding providers and benchmark</b></summary>
  152. <br>
  153. | Provider | What it is | Cost | Quality |
  154. | --- | --- | --- | --- |
  155. | `model2vec` | Local static embeddings, default [`minishlab/potion-base-8M`](https://huggingface.co/minishlab/potion-base-8M) (MIT, 256 dims) | About 80 MB RAM, loads in about 20 ms | Real semantic matches |
  156. | `hash` | Feature hashing over stems, bigrams and trigrams plus a small game/app concept map | Nothing | Lexical with a little help |
  157. | `openai` | Any OpenAI-compatible API: OpenAI, Ollama, LM Studio, vLLM, llama.cpp | API fees or a model server | Best |
  158. | `none` | Semantic search off; keyword and fuzzy still work | Nothing | n/a |
  159. `EARFUL_EMBED_PROVIDER=auto` (default) uses Model2Vec when a model exists at `EARFUL_EMBED_MODEL_PATH`, otherwise `hash`. Embeddings are computed in the background, so submissions never wait. Vectors are tagged with their model, so switching providers re-embeds everything automatically.
  160. On 17 paraphrase queries over 18 realistic reports (`crates/server/tests/model2vec.rs`), potion-base-8M reaches an MRR of **0.81** against 0.61 for `hash`. The larger `potion-retrieval-32M` scored 0.73 on this data, so the small model stays the default.
  161. </details>
  162. ## 🤖 Let your agent triage
  163. Earful serves an MCP endpoint at `/mcp`. Create a token under **API tokens**, then:
  164. ```sh
  165. claude mcp add --transport http earful https://<your-host>/mcp \
  166. --header "Authorization: Bearer <token>"
  167. ```
  168. Then just ask: *"Triage the new feedback for starfall, group it into themes and label the duplicates."*
  169. | | |
  170. | --- | --- |
  171. | Read tools (10) | `list_projects`, `get_project`, `list_feedback`, `search_feedback`, `get_feedback`, `find_similar_feedback`, `list_labels`, `get_stats`, `export_feedback`, `get_integration_snippets` |
  172. | Write tools (13) | `create_feedback`, `update_feedback`, `bulk_update_feedback`, `delete_feedback`, `create_label`, `update_label`, `delete_label`, `label_feedback`, `create_project`, `update_project`, `rotate_project_key`, `delete_project`, `reindex_embeddings` |
  173. | Prompts | `triage_inbox`, `group_feedback_themes`, `summarize_feedback`, `release_notes_from_resolved` |
  174. Tokens are scoped (`read` or `write`), hashed and revocable. Read tokens never see write tools, and destructive tools require explicit confirmation. Stdio-only clients such as Claude Desktop use the built-in `earful mcp-stdio` bridge. Setup for every client: [docs/mcp.md](docs/mcp.md) and [docs/agent-themes.md](docs/agent-themes.md).
  175. ## 📦 Deploy
  176. Any container host works. The image runs as non-root on distroless, binds `0.0.0.0:8080` inside the container, stores everything under `/data` and ships a `HEALTHCHECK`.
  177. 1. Build from this repository's `Dockerfile` (Coolify, Dokploy, CapRover, Fly.io, plain Docker).
  178. 2. Mount a persistent volume at `/data`.
  179. 3. Set `EARFUL_ADMIN_PASSWORD_HASH` (and optionally the embedding variables).
  180. 4. Put an HTTPS reverse proxy in front. **Never publish port 8080 directly.**
  181. Step-by-step Coolify instructions, Cloudflare notes, an optional Ollama sidecar, backups and upgrades: [docs/deploy-coolify.md](docs/deploy-coolify.md).
  182. <details>
  183. <summary><b>Configuration</b> (all environment variables)</summary>
  184. <br>
  185. [.env.example](.env.example) is a commented template.
  186. | Variable | Default | Purpose |
  187. | --- | --- | --- |
  188. | `EARFUL_BIND` | `127.0.0.1:8080` | Listen address. The Docker image sets `0.0.0.0:8080` inside the container. |
  189. | `EARFUL_DATABASE_PATH` | `earful.db` | SQLite file. Image default `/data/earful.db`. |
  190. | `EARFUL_ADMIN_PASSWORD_HASH` | unset | Argon2 PHC string from `earful hash-password`. Unset means every login is rejected. |
  191. | `EARFUL_ADMIN_PASSWORD_HASH_FILE` | unset | File containing the hash. Takes precedence. |
  192. | `EARFUL_SESSION_TTL_HOURS` | `168` | Admin session lifetime. |
  193. | `EARFUL_COOKIE_SECURE` | `true` | `Secure` flag on the session cookie. Only disable for plain http on localhost. |
  194. | `EARFUL_TRUSTED_PROXY_HOPS` | `0` | Reverse proxies to trust for `X-Forwarded-For`. Image default `1`. |
  195. | `EARFUL_LIMIT_IP_PROJECT_MINUTE` | `3` | Submissions per IP per project per minute. |
  196. | `EARFUL_LIMIT_IP_PROJECT_HOUR` | `10` | Per IP per project per hour. |
  197. | `EARFUL_LIMIT_IP_PROJECT_DAY` | `30` | Per IP per project per day. |
  198. | `EARFUL_LIMIT_IP_GLOBAL_DAY` | `60` | Per IP across all projects per day. |
  199. | `EARFUL_LIMIT_PROJECT_HOUR` | `300` | Per project across all IPs per hour (flood guard). Beyond it submissions are quarantined; at 3x they are refused. |
  200. | `EARFUL_LIMIT_GLOBAL_DAY` | `5000` | Submissions per day across every project and IP (protects the disk). |
  201. | `EARFUL_SPAM_RETENTION_DAYS` | `30` | Quarantined items older than this are purged. `0` keeps them forever. |
  202. | `EARFUL_LIMIT_CHALLENGES_IP_HOUR` | `60` | Challenges issued per IP per hour. |
  203. | `EARFUL_MIN_FILL_SECS` | `2` | Submissions faster than this after the challenge are quarantined. |
  204. | `EARFUL_SPAM_THRESHOLD` | `0.7` | Heuristic score that sends a submission to the spam bucket. |
  205. | `EARFUL_POW_BITS` | `18` | Base proof of work difficulty (leading zero bits). |
  206. | `EARFUL_POW_MAX_BITS` | `23` | Upper bound for adaptive difficulty. |
  207. | `EARFUL_CHALLENGE_TTL_SECS` | `1800` | Challenge lifetime. |
  208. | `EARFUL_EMBED_PROVIDER` | `auto` | `auto`, `model2vec`, `hash`, `openai` or `none`. |
  209. | `EARFUL_EMBED_MODEL_PATH` | `models/potion-base-8M` (Docker: `/models/potion-base-8M`) | Model2Vec model directory. |
  210. | `EARFUL_EMBED_AUTO_DOWNLOAD` | `false` | With `model2vec`, download a missing model from Hugging Face at startup. |
  211. | `EARFUL_EMBED_DIM` | `384` | Vector size for the `hash` provider. |
  212. | `EARFUL_EMBED_URL` | `https://api.openai.com/v1` | Base URL of an OpenAI-compatible API. |
  213. | `EARFUL_EMBED_MODEL` | `text-embedding-3-small` (`openai`), `minishlab/potion-base-8M` (`model2vec`) | Model name, or the Hugging Face repo for auto download. |
  214. | `EARFUL_EMBED_API_KEY` / `EARFUL_EMBED_API_KEY_FILE` | unset | Bearer token for the embedding API. |
  215. | `RUST_LOG` | `info` | Log filter (tracing `EnvFilter` syntax). |
  216. Admin logins are limited to 5 failures per 15 minutes per IP, failed MCP token attempts to 20 per 15 minutes per IP.
  217. </details>
  218. <details>
  219. <summary><b>Security model</b></summary>
  220. <br>
  221. - **One admin.** argon2id password, random 256-bit sessions stored only as SHA-256, `HttpOnly` + `SameSite=Strict` + `Secure` cookies, cross-origin admin writes rejected. No configured hash means no login.
  222. - **Public by design, guarded by layers.** The ingestion API is unauthenticated because anonymous players are its audience; the anti-spam pipeline protects it.
  223. - **Private by default.** Binds `127.0.0.1` unless told otherwise. Always go through an HTTPS proxy.
  224. - **Strict headers.** `self`-only CSP and `X-Frame-Options: DENY` on the admin UI, `nosniff` and `no-referrer` everywhere.
  225. - **No raw IPs.** Only keyed HMAC pseudonyms (IPv6 at /64 granularity).
  226. Found a vulnerability? Please report it privately, see [SECURITY.md](SECURITY.md).
  227. </details>
  228. <details>
  229. <summary><b>Backups</b></summary>
  230. <br>
  231. All state lives in one SQLite database in WAL mode. Don't copy the `.db` file alone while the server runs. Instead use `sqlite3 earful.db ".backup '/backups/earful-$(date +%F).db'"`, replicate continuously with [Litestream](https://litestream.io), or stop the container and copy the `.db`, `-wal` and `-shm` files together.
  232. </details>
  233. ## 🏗️ How it works
  234. ```
  235. game / app / site you your agent
  236. | | |
  237. | GET /api/v1/challenge | /admin (session cookie) | /mcp (bearer token)
  238. | POST /api/v1/feedback | /api/admin/* |
  239. v v v
  240. +-------------------------------------------------------------------------+
  241. | Earful (one Rust binary) |
  242. | |
  243. | axum -> anti-spam pipeline -> SQLite (WAL) |
  244. | |- projects, feedback, labels |
  245. | embedded admin UI + widget.js |- FTS5 porter (keyword) |
  246. | |- FTS5 trigram (fuzzy) |
  247. | background worker --embeds--> '- embeddings -> in-memory index |
  248. +-------------------------------------------------------------------------+
  249. ```
  250. axum on tokio, rusqlite with bundled SQLite + FTS5, argon2id, and rust-embed for the web assets. The admin UI is Preact with no other runtime dependencies (about 21 KB of JS gzipped). Deep dive: [docs/architecture.md](docs/architecture.md).
  251. ## 🛠️ Contributing
  252. Contributions are welcome, whether that's bug reports, integrations for another engine, or docs fixes.
  253. ```sh
  254. pnpm install
  255. pnpm dev:server # API on :8080 (needs EARFUL_ADMIN_PASSWORD_HASH and EARFUL_COOKIE_SECURE=false)
  256. pnpm dev:admin # admin UI with hot reload on :5173/admin/
  257. pnpm check # the gate: typecheck, rustfmt, clippy -D warnings, Rust + web tests, Playwright e2e
  258. ```
  259. Start with [CONTRIBUTING.md](CONTRIBUTING.md). Conventions and invariants for humans and coding agents live in [AGENTS.md](AGENTS.md).
  260. <details>
  261. <summary><b>Project layout</b></summary>
  262. <br>
  263. ```
  264. crates/server/ Rust server and CLI (axum, rusqlite, argon2). Binary: earful
  265. apps/admin/ Admin UI (Preact + Vite), embedded at /admin/
  266. packages/widget/ widget.js, ESM client and the TypeScript proof of work solver
  267. e2e/ Playwright tests against the real binary
  268. scripts/ Demo data seeding and README screenshots
  269. docs/ API contract, architecture, MCP, deployment, integrations
  270. ```
  271. </details>
  272. ## 🗺️ Roadmap
  273. - [ ] Notifications: webhook, email or Discord message for new bugs, with a daily digest
  274. - [ ] Screenshot attachments, stored next to the database with size caps
  275. - [ ] Multilingual semantic search (`potion-multilingual-128M`)
  276. - [ ] Public "known issues" page per project, generated from triaged bugs
  277. - [ ] Reply to the reporter from the admin UI
  278. - [ ] Prebuilt multi-arch Docker images
  279. Have an idea? [Open a feature request](https://github.com/georgevibing/earful/issues/new/choose).
  280. ## License
  281. [MIT](LICENSE) © 2026 George Kaltsikis
  282. <div align="center">
  283. <sub>If Earful saves you from a spam-filled inbox, a ⭐ helps others find it.</sub>
  284. </div>

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.