Files
MaintenanceWebsite/README.md
T
fraujulian 2a063481a6
CI / javascript (push) Successful in 13s
CI / docker (push) Successful in 12s
docs: reorganize project README
2026-10-02 13:35:38 +02:00

1.7 KiB

Maintenance Website

A lightweight maintenance page served as a static website.

Preview

Open the live preview

Technology

  • HTML, CSS, and vanilla JavaScript
  • Nginx
  • Docker and Docker Compose

Features

  • Selects a maintenance message from the browser's preferred language, with English fallback
  • Supports English, German, Slovak, Czech, Dutch, Swedish, Norwegian, Polish, Italian, French, Spanish, Slovenian, and Danish
  • Provides email, abuse, phone, imprint, and status links

Project Architecture

  • index.html — page content and contact links
  • style.css — page layout and styling
  • script.js — language selection
  • images/ — page images and icons
  • nginx.conf — web server configuration
  • Dockerfile — production image definition
  • docker-compose.yml — production service configuration

Setup

Development

From the project root, start a local static server:

python -m http.server 8000

Open http://localhost:8000.

Production

Requires Docker Compose and access to the configured image registry. Copy the example environment file, set IMAGE_TAG if needed, then start the service:

cp .env.example .env
docker compose up -d

The page is available at http://localhost:8080 by default. Set MAIN_PORT in .env to change the host port.

Tests

There is no dedicated test suite. CI checks JavaScript syntax with node --check and builds the Docker image.

Guidelines

Use the issue templates in .gitea/ISSUE_TEMPLATE for bug reports and feature requests.

LICENSE

The project is licensed under the GNU General Public License v3. Icons by Icons8.