Projekt
Changelog
All notable changes to this project are documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Unreleased
Changed
- Product site and handbook live at
formrelay.peuser.dev.INSTALL.md, the release notes andcomposer.jsonpointed atformrelay.stockwerk2.de, which does not resolve; the 1.0.0 package still carries those links. - Own brand mark. The cloud turtle now carries the Heroicons
paper-airplaneinstead of Shortlink'slinksymbol — logo, favicons, touch icon and the product site's preview card, which also showed Shortlink's name and claim.
1.0.0 — 2026-11-18
First released version. Derived from Shortlink 4.3.4; the forms domain is new.
Added
-
Forms. The start page lists the forms this account may see. A form has a name, the exact domains it accepts submissions from, an optional thank-you page on one of those domains, the field whose address becomes the reply-to, a retention period after delivery and its own endpoint address (
/f/<token>, 16 characters). The detail page shows the address and a copyable example form including the honeypot field. Renewing the token gives the form a new address; the old one stops at once. -
Recipients confirm their address. Every recipient receives a link and gets submissions only after clicking it (valid 72 hours, can be resent). An account adding its own confirmed address is confirmed at once.
-
Settings → Features: who owns the forms. Shared by default — every account sees and manages every form, and a form without a creator can be claimed. Switched off, each account sees only its own forms; the admin who switches gets the forms without a creator. Deleting an account in that mode hands its forms to the deleting admin, so a form on a website does not fail silently.
-
New forms need a confirmed e-mail address, like new links in Shortlink.
-
The endpoint accepts submissions.
POST /f/<token>takesurlencoded,multipartand JSON bodies from the form's own domains (checked againstOrigin, https only except forlocalhostand.test) and stores each submission encrypted, with one delivery per confirmed recipient. Checks in this order: size (64 KB), form (unknown 404, paused or disabled 410), origin (403), rate limit (5 per 10 minutes per visitor network and form, 60 per hour per form; 429 withRetry-After), honeypot (answered like success, nothing stored), content (at most 50 fields of 10,000 characters, no files; 415/422), a confirmed recipient (503). Scripts get{"ok": …}JSON and CORS headers for the checked origin only; browsers are redirected to the thank-you page or a hosted confirmation, or see a page that names the problem. No session, no cookie, no IP address stored; the rate-limit key is a keyed hash of the shortened address. -
Daily counters per form. Accepted, spam and every kind of rejection, shown on the detail page for the last 30 days. Rejected submissions are only counted, never stored.
-
Submissions are delivered by mail. One queued job per confirmed recipient, carrying only the delivery's ID. The mail comes from the installation's sender, with the submitter in
Reply-Towhen the configured field holds a single valid address, every value escaped and nothing turned into a link, andAuto-Submitted: auto-generatedso out-of-office replies do not reach the submitter. An SMTP 5xx answer fails the delivery at once; 4xx answers, connection errors and timeouts are retried after 1, 5 and 15 minutes, 1, 3 and 6 hours. Only an error key is stored — never the mail server's text, which names the address — and nothing but that key reachesfailed_jobsor the log. -
Submission status and retry. A submission is delivered once every recipient has its mail, undeliverable if one delivery failed. The detail page lists the latest submissions with status and errors, never their content, and failed ones can be delivered again. The start page shows the last submission and undeliverable ones; System data warns about them.
-
Submissions are deleted after their retention period. Delivered ones after the form's retention (never longer than the installation's maximum — a lowered maximum applies at once, also to what is already stored), undeliverable ones after 7, 14 or 30 days. A queued job deletes them on the minute;
formrelay:cleanuprecalculates with the current settings and catches the rest. The cleanup also removes failed queue jobs after the same period and daily counters after 90 days, and requeues deliveries that have been waiting for a day without an attempt. A delivery is locked while it is being sent, so a second job never sends it twice. -
Settings → Features: retention and access to contents. Default and maximum retention and the period for undeliverable submissions; whether forms may allow reading stored submissions. Settings → Maintenance shows the periods in force.
-
Mail delivery is set up and checked during installation. A new step after the administrator — in the browser and in
formrelay:install(--mail-*options) — saves the access, connects to the server and sends a test message to the administrator. If that fails, the access stays saved and the server's message is shown. Skipping takes an explicit button or--skip-mail; run non-interactively with neither, the installer stops before changing anything. -
php artisan formrelay:mail-test [to] [--no-dns]prints the mail configuration in effect (without the password), checks the connection, sends a test message and shows the server's answer. Exit code 1 when the message is refused. -
Mail access is marked as checked once a test message goes through; saving the access clears the mark. System data warns while mail delivery is missing or unchecked.
-
SPF and DMARC hints for the sender domain in the installer, under Settings → E-Mail and in
formrelay:mail-test— including a record that allows no server at all. DKIM is named as not checkable without the selector.FORMRELAY_DNS_CHECKS=falseturns the lookups off. -
Supervision of all forms (administrators, under the cog menu → Form supervision): disable any form, enable it again and assign it to an account — also in user mode, where foreign forms are otherwise hidden. The owner is told by mail when a form is disabled, the new owner when a form is assigned. The list shows names, domains, owners and counts, never the content of a submission; only an administrator can release a disabled form.
-
Handbook for the forms domain. New section "Benutzen" (creating forms, embedding them in a website — HTML and
fetch, error keys, limits,Referrer-Policy—, and submissions), and under operation the form supervision, deliverability (SPF, DKIM, DMARC, why the submitter only appears as reply-to) and two templates: a record of processing activities (Art. 30 GDPR) and a privacy notice for the websites. Both are templates, not legal advice. -
Reading and deleting submissions. With access switched on for the installation and the form (off by default), a submission's content is shown on its own page. Single submissions and all submissions of a form can be deleted before their deadline; the detail page shows each deletion date.
-
The project skeleton, derived from Shortlink 4.3.4. Accounts with roles and invitations, password reset, e-mail confirmation, two-factor sign-in, editorial pages, the settings areas (general, appearance, mail with a test message, maintenance with a database download, system data with the update notice and the cron status), the CLI and browser installer,
formrelay:check,formrelay:installed,formrelay:cleanup, the release pipeline,update.shandformrelay-setup.sh. The URL-shortener domain is not part of it. Origin and procedure:docs/HERKUNFT.txt. -
Releases come from
gitlab.com/mankeldor/formrelay.formrelay-setup.shfetches them from there without--project, and the update notice asks that project's release list unlessFORMRELAY_UPDATE_SOURCEnames another one (empty switches it off). -
A queue worker, run from cron.
php artisan queue:work --stop-when-emptyevery minute, the pattern from Fileshare; it runs on shared hosting without a supervisor. Delivering submissions runs through it. Settings → System data shows whether it runs. The deployment andupdate.shrestart the queue again.
Changed
- PHP 8.4.1 or newer is required. The skeleton said 8.3, but the locked Symfony 8.1
packages require PHP 8.4.1;
composer installfailed on 8.3. Corrected incomposer.json, the installer, the setup script,update.sh, the deployment check and the documentation — as in Shortlink and Fileshare. guzzlehttp/guzzle7.15.5 andleague/commonmark2.10.3. The lock file inherited from Shortlink carried both packages with published security advisories (composer audit).
Security
- Laravel 13.43.0, the Symfony 8.1 components, Flysystem 3.36.0 and DOMPurify 3.4.18.
The locked versions carried advisories published since October (
composer audit,npm audit): CVE-2026-45070 insymfony/mime(header injection in outgoing mail), CVE-2026-121619, CVE-2026-118514, CVE-2026-108082 and two without a number insymfony/http-foundation, CVE-2026-123339 insymfony/http-kernel, CVE-2026-118516 insymfony/routing, CVE-2026-128083, CVE-2026-114509, CVE-2026-114508 and CVE-2026-102279 inlaravel/framework, CVE-2026-102601 in Flysystem, and several in DOMPurify, which the page editor ships to the browser. Packages pulled in by these stay on their major version (Guzzle 7.16.3, brick/math 0.18). - The installer's completion proof opens only the steps after the administrator (mail
and completion). Inherited from Shortlink 4.3.4, it reopened the whole installer for the
session:
POST /install/databasecould rewrite the.env, andPOST /install/admincould promote any account and reset its password. Fixed as in Shortlink and Fileshare 5.0.0. - Invitation tokens have their own table (
user_invitation_tokens). Both brokers sharedpassword_reset_tokens, each checking a row against its own lifetime, so a 60-minute reset link could be redeemed as a seven-day invitation. From Shortlink 5.0.0. - Five wrong two-factor codes lock the account for 15 minutes, across new sign-in attempts from any address; the challenge was only limited per IP. From Shortlink 5.0.0.
- The test guard runs before the test database is touched. It ran after
RefreshDatabasehad already migrated whatever database was configured. From Shortlink 5.0.0.
Fixed
- The test run no longer writes into
storage/logs/laravel.log(LOG_CHANNEL=nullinphpunit.xml) and keeps itsarraymailer —MailConfig::apply()turned it intosendmail, so a test without a mail fake called the real sendmail. Same fix as in Shortlink and Fileshare. - Mails go out under the installation name when no sender name is set. The sender
name fell back to
MAIL_FROM_NAME, which reads "Laravel" unless set, so the fallback to the installation name never applied. From Shortlink 5.0.0.
Version links
Quelle dieser Seite: CHANGELOG.md im Repository. Sie wird beim Bauen daraus erzeugt — Änderungen gehören in die
Markdown-Datei, nicht in diese Seite.