Add Docker TAGLINE env customization for modern frontend slogan (#794)

* Initial plan

* Add Docker TAGLINE env customization for modern UI slogan

Agent-Logs-Url: https://github.com/librespeed/speedtest/sessions/e1da6e0e-5194-453d-bffb-961ed782e215

Co-authored-by: sstidl <12804296+sstidl@users.noreply.github.com>

* Refine TAGLINE replacement and expand E2E coverage

Agent-Logs-Url: https://github.com/librespeed/speedtest/sessions/e1da6e0e-5194-453d-bffb-961ed782e215

Co-authored-by: sstidl <12804296+sstidl@users.noreply.github.com>

* Fix TAGLINE sed delimiter and add apostrophe tagline E2E test

- Switch TAGLINE sed from '#' to '/' delimiter so html_escape'd
  apostrophes (&#39;) don't break the sed expression
- Add standalone-apostrophe Docker service with TAGLINE="It'd rather be fast!"
- Add standaloneApostrophe URL (port 18186) to env.js
- Add E2E test asserting the apostrophe tagline renders correctly

Agent-Logs-Url: https://github.com/librespeed/speedtest/sessions/ebe265a8-4b1e-49b5-959a-66133ea0ab3a

Co-authored-by: sstidl <12804296+sstidl@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: sstidl <12804296+sstidl@users.noreply.github.com>
This commit is contained in:
Copilot 2026-04-18 23:06:37 +02:00 committed by GitHub
parent 8f0323c4a7
commit ecb2a0e736
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 39 additions and 1 deletions

View file

@ -32,6 +32,7 @@ COPY docker/entrypoint.sh /
# Prepare default environment variables
ENV TITLE=LibreSpeed
ENV TAGLINE="No Flash, No Java, No Websockets, No Bullsh*t"
ENV MODE=standalone
ENV PASSWORD=password
ENV TELEMETRY=false

View file

@ -46,6 +46,7 @@ COPY docker/entrypoint.sh /
# Prepare default environment variables
ENV TITLE=LibreSpeed
ENV TAGLINE="No Flash, No Java, No Websockets, No Bullsh*t"
ENV MODE=standalone
ENV PASSWORD=password
ENV TELEMETRY=false

View file

@ -33,6 +33,7 @@ services:
environment:
MODE: standalone
#TITLE: "LibreSpeed"
#TAGLINE: "No Flash, No Java, No Websockets, No Bullsh*t"
#TELEMETRY: "false"
#ENABLE_ID_OBFUSCATION: "false"
#REDACT_IP_ADDRESSES: "false"
@ -57,6 +58,7 @@ The test can be accessed on port 80.
Here's a list of additional environment variables available in this mode:
* __`TITLE`__: Title of your speed test. Default value: `LibreSpeed`
* __`TAGLINE`__: Slogan shown below the heading on the modern frontend (`index-modern.html`). Default value: `No Flash, No Java, No Websockets, No Bullsh*t`
* __`USE_NEW_DESIGN`__: When set to `true`, enables the new modern frontend design. When set to `false` (default), uses the classic design. The design can also be switched using URL parameters (`?design=new` or `?design=old`). Default value: `false`
* __`SERVER_LIST_URL`__: When set, both frontend designs load their server list from this URL instead of the generated or mounted `server-list.json`. This is useful if you want the containerized frontend to consume a remote shared server list.
* __`TELEMETRY`__: Whether to enable telemetry or not. If enabled, you maybe want your data to be persisted. See below. Default value: `false`

View file

@ -108,6 +108,15 @@ if [[ "$MODE" == "frontend" || "$MODE" == "dual" || "$MODE" == "standalone" ]];
sed -i "s/<title>LibreSpeed<\\/title>/<title>$TITLE_ESCAPED<\\/title>/g" /var/www/html/index.html
sed -i "s/<title>LibreSpeed - Free and Open Source Speedtest<\\/title>/<title>$TITLE_ESCAPED - Free and Open Source Speedtest<\\/title>/g; s/<h1>Free and Open Source Speedtest\\.<\\/h1>/<h1>$TITLE_ESCAPED<\\/h1>/g" /var/www/html/index-modern.html
fi
# Replace modern page tagline if TAGLINE is set
if [ -n "$TAGLINE" ]; then
TAGLINE_ONE_LINE=${TAGLINE//$'\r'/}
TAGLINE_ONE_LINE=${TAGLINE_ONE_LINE//$'\n'/ }
TAGLINE_HTML_ESCAPED=$(html_escape "$TAGLINE_ONE_LINE")
TAGLINE_ESCAPED=$(sed_escape "$TAGLINE_HTML_ESCAPED")
sed -i "s/<p class=\"tagline\">No Flash, No Java, No Websockets, No Bullsh\\*t<\\/p>/<p class=\"tagline\">$TAGLINE_ESCAPED<\\/p>/g" /var/www/html/index-modern.html
fi
# Support legacy EMAIL env var as fallback for GDPR_EMAIL
if [ -z "$GDPR_EMAIL" ] && [ ! -z "$EMAIL" ]; then

View file

@ -27,9 +27,22 @@ services:
- WEBPORT=8080
- USE_NEW_DESIGN=true
- 'TITLE=Grüße "Tempo" ''Österreich'''
- 'TAGLINE=No "Flash", <No Java>, No Websockets & No Bullsh*t'
ports:
- "18185:8080"
standalone-apostrophe:
build:
context: ..
dockerfile: Dockerfile
environment:
- MODE=standalone
- WEBPORT=8080
- USE_NEW_DESIGN=true
- "TAGLINE=It'd rather be fast!"
ports:
- "18186:8080"
backend:
build:
context: ..

View file

@ -4,6 +4,7 @@ const baseUrls = {
frontend: 'http://127.0.0.1:18182',
dual: 'http://127.0.0.1:18183',
standaloneNew: 'http://127.0.0.1:18185',
standaloneApostrophe: 'http://127.0.0.1:18186',
};
module.exports = {

View file

@ -2,6 +2,8 @@ const { test, expect } = require('@playwright/test');
const { baseUrls } = require('./helpers/env');
const { modernStartButton } = require('./helpers/ui');
const defaultTagline = 'No Flash, No Java, No Websockets, No Bullsh*t';
test.describe('Runtime mode smoke coverage', () => {
test('standalone exposes UI and local backend endpoints', async ({ page, request }) => {
const root = await request.get(`${baseUrls.standalone}/`);
@ -18,6 +20,7 @@ test.describe('Runtime mode smoke coverage', () => {
await page.goto(`${baseUrls.standalone}/index-modern.html`);
await expect(modernStartButton(page)).toBeVisible();
await expect(page.locator('main > p.tagline')).toHaveText(defaultTagline);
});
test('backend exposes only local backend contract endpoints', async ({ request }) => {

View file

@ -2,16 +2,24 @@ const { test, expect } = require('@playwright/test');
const { baseUrls } = require('./helpers/env');
const specialTitle = 'Grüße "Tempo" \'Österreich\'';
const specialTagline = 'No "Flash", <No Java>, No Websockets & No Bullsh*t';
const apostropheTagline = "It'd rather be fast!";
test.describe('TITLE special characters', () => {
test.describe('TITLE and TAGLINE special characters', () => {
test('modern page title supports umlauts and quotes', async ({ page }) => {
await page.goto(`${baseUrls.standaloneNew}/index-modern.html`);
await expect(page).toHaveTitle(`${specialTitle} - Free and Open Source Speedtest`);
await expect(page.locator('main > h1')).toHaveText(specialTitle);
await expect(page.locator('main > p.tagline')).toHaveText(specialTagline);
});
test('classic heading supports umlauts and quotes', async ({ page }) => {
await page.goto(`${baseUrls.standaloneNew}/index-classic.html`);
await expect(page.locator('h1').first()).toHaveText(specialTitle);
});
test('modern page tagline renders apostrophe correctly', async ({ page }) => {
await page.goto(`${baseUrls.standaloneApostrophe}/index-modern.html`);
await expect(page.locator('main > p.tagline')).toHaveText(apostropheTagline);
});
});