https://github.com/friendsofredaxo/maintenance

Wartungsmodus: Sperrung des Frontends für Besucher und des Backends für Redakteure
https://github.com/friendsofredaxo/maintenance

backend frontend maintenance maintenance-mode redaxo redaxo-addon

Last synced: about 1 month ago
JSON representation

Wartungsmodus: Sperrung des Frontends für Besucher und des Backends für Redakteure

• Host: GitHub
• URL: https://github.com/friendsofredaxo/maintenance
• Owner: FriendsOfREDAXO
• License: mit
• Created: 2017-09-05T22:59:20.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-11-12T16:30:18.000Z (about 1 month ago)
• Last Synced: 2024-11-12T17:24:45.488Z (about 1 month ago)
• Topics: backend, frontend, maintenance, maintenance-mode, redaxo, redaxo-addon
• Language: PHP
• Homepage:
• Size: 2.66 MB
• Stars: 52
• Watchers: 6
• Forks: 7
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Wartungsmodus (Maintenance mode) für REDAXO 5.x

![Screenshot](https://raw.githubusercontent.com/FriendsOfREDAXO/maintenance/assets/Maintenance.png)

Das AddOn ermöglicht es Administratoren, das Frontend und/oder des Backend von REDAXO für Besucher und/oder Redakteure zu sperren. Zum Beispiel bei Wartungsarbeiten oder in der Entwicklungsphase.

## Funktionen

### Sperren des Frontends

* Wahl der Authentifizierung: Geheime URL oder Passwort

* Optionales Sperren des Frontends auch für REDAXO-Benutzer (außer Admins)

* Optionale Weiterleitung zu einer festgelegten URL, z.B. REDAXO-Login

* Festlegen des HTTP-Statuscodes (z.B. 503 Service Unavailable)

* Anpassen der Sperrseite durch eigenes Fragment (`maintenance/frontend.php`)

* Definieren von Ausnahmen, die dennoch Zugriff erhalten, z.B. für

  * IP-Adressen

  * Hosts

  * YRewrite-Domains (neu in Version 3.0.0)

* Meldung und Zeitraum zur Ankündigung eines Wartungsfensters definieren (neu in Version 3.0.0)

### Sperren des REDAXO-Backends

* Sperren des REDAXO-Backends für alle Benutzer (außer Admins)

### Wartungsmodus ankündigen

Eine Meldung und Zeitraum zur Ankündigung eines Wartungsfensters definieren (neu in Version 3.0.0). Die Ausgabe erfolgt über `FriendsOfRedaxo\Maintenance\Maintenance::getAnnouncement()`, z.B.

```php

$announcement = FriendsOfRedaxo\Maintenance\Maintenance::getAnnouncement();

if($announcement) {

    echo '
'.$announcement.'
';

}

```


Eine für Nutzer*innen hilfreiche Meldung ist beispielsweise:

> Geplante Wartungsarbeiten am 01.01.2022 von 00:00 bis 06:00 Uhr. In dieser Zeit ist die Website möglicherweise nicht erreichbar.

### Eigene HTML-Seite für den Wartungsmodus

Standardmäßig wird eine einfache HTML-Seite angezeigt, die den Wartungsmodus anzeigt.

Diese kann durch eine eigene HTML-Seite ersetzt werden. Dazu muss im Projekt-AddOn ein Ordner `fragments/maintenance` angelegt werden. In diesem Ordner kann eine Datei `frontend.php` mit eigenem HTML-Code erstellt werden. D.h. `/src/addons/maintenance/fragments/maintenance/frontend.php`

So kann bspw. eigener Text, Logo oder komplett andere Gestaltung erfolgen.

## Anzeige des aktuellen Status im REDAXO-Hauptmenü

Der Menüeintrag erhält bei Aktivierung einer der Wartungsmodi ein zusätzliches Tag.

* Standard: Alle Funktionen sind deaktiviert.

* `F` in rotem Tag: Der Wartungsmodus ist für das Frontend aktiv.

* `B` in blauem Tag: Der Wartungsmodus ist für das Backend aktiv.

## Extensionpoint MAINTENANCE_MEDIA_UNBLOCK_LIST

Über diesen Extension-Point kann ein Array mit Medien übergeben werden, die das Addon nicht sperren soll.

## `search_it` und Wartungs-Modus

Ist die Frontendsperre aktiviert, kann `search_it` den Index nicht erstellen.

Dazu einfach die aktuelle IP des Servers, auf dem REDAXO installiert ist und von dem aus gecrawlt wird, als  Ausnahme hinzufügen. Schon kann `search_it` wieder crawlen. 🕵🏻

## Konsole

Es wird die im Backend ausgewählte Sperrseite angezeigt. Aktivieren der Frontendsperre

Mit `maintenance:on` oder `frontend:off`

Deaktivieren mit `maintenance:off` oder `frontend:on`

## Autor

### FriendsOfREDAXO

* 

* 

## Projekt-Team

* [Alexander Walther](https://github.com/alxndr-w)

* [KLXM Crossmedia / Thomas Skerbis](https://klxm.de)

## Credits

Danke an:

* [Thorben](https://github.com/eaCe)

* [Christian Gehrke](https://github.com/chrison94)

* [Oliver Kreischer](https://github.com/olien)

* u.v.a