maintenance-page--offline.html.twig is not picked up when system is offline

Seeing the same thing here and haven't found a way to get it to work yet.

There's a suggestion in system_theme_suggestions_maintenance_page in core/modules/system/system.module, which looks like it should work, but doesn't.

Yeah this does look like a bug of sorts, the folks in #drupal-uk tried all sorts of things and couldn't get a template working, even putting a forced template in core/modules/system/templates

Hi there,

Has anyone found an alternative way to create a custom offline maintenance page? Since this bug has been reported, there has not been an update for 7 months, so I'm curious as to if anyone else found a solution.

Thanks!

Has anyone found an alternative solution to create a custom offline maintenance page? There hasn't been an update on this issue for about 7 months now...

Changing the status to major, as the system outputs a WSOD in the case of a fatal error, which is horrible UI. This fits into the status description for major due to this:

Cause a significant admin- or developer-facing bug with no workaround.

This is a significant bug and there is no workaround at the moment.

First of all, steps to reproduce the issue.
Situation A (when core/includes/errors.inc is used):
1. Set incorrect database credentials in settings file.
2. Refresh the page.

Situation B (when core/lib/Drupal/Core/EventSubscriber/FinalExceptionSubscriber is used):
1. Comment out $settings['hash_salt'] in settings file
2. Refresh the page.

The patch adds a possibility to have a twig template that styles fatal errors described in A and B.

I tested the patch in #12, unfortunately it does not work with 8.8.

Patch to the 8.9.x-dev

Patch to the 8.9.x-dev

I performed Novice Triage on this issue. I am leaving the Novice tag on this issue because I think that we still need to update the issue summary here to make it clear what the steps to reproduce. Also we sould run this through Major issue triage and update the issue accordingly that would be great. Particularly we should also analyze based on Allowed changes in major and minor releases.

Hello,
This patch doesn't work anymore with Drupal 8.8.4 (or maybe earlier after 8.7.x)
Any solution ?

Thanks

Rerolled the patch, Please review

I tested the patch from #30 on Drupal 8.8.4, and it did not work.

Thank you for your contribution, @Neslee Canil Pinto, but your two patches were incomplete. My guess is that since the template file was new it didn't get added to the Git diff.

I'm adding the Needs Reroll tag back. Whoever makes another attempt at this, make sure you reroll #21, not #29 or #30. Also, make sure you add the template to the diff.

I installed a clean site with drupal 8.9.x-dev as well as 8.4.4. The maintenance page loads without a problem with bartik. I even have twig debug enabled and the source code is showing the correct template file being used. Is this an issue with other themes? It's not clear why a patch is needed at this point. I can help with this issue but I'm unable to reproduce the error originally noted based on the information provided. If anyone can provide more details that would be helpful. Thanks.

bthompson1

Did you follow the steps to reproduce?

I have tested patch from #21 with 8.9.x-dev and 8.8.x-dev and it works for me.
So why does it need to be rerolled?

I agree, #21 works. #30 doesn't work as it's missing the template file.

I just tested the patch in 21. It is an improvement on the existing UX, giving an error page, versus the default error message (or nothing) on the WSOD.

However, the template file is named incorrectly. The system is expecting the template file maintenance-page--offline.html.twig, as outlined in the opening post, but the patch is using fatal-error-page.html.twig. So this still needs some work.

Definitely better than the current core default though.

If a site is throwing fatal errors, which is what is happening in the steps to reproduce, then this really has nothing to do with maintenance mode in my opinion. I consider these separate issues and see a fatal error template as reasonable.

If a site is throwing fatal errors, which is what is happening in the steps to reproduce, then this really has nothing to do with maintenance mode in my opinion.

Maybe that's a separate issue then.
The current issue is about maintenance-mode--offline.html.twig not being picked up, functionality that was part of D7, whose implementation was only partially completed in D8.

I consider these separate issues and see a fatal error template as reasonable.

Maybe for that issue, but it does not solve the current issue.

@Jaypan, I have modified patch #21. Removed dependency on Bartik's theme added in #21.
Now all the fatal errors are themable. Now anyone can override the maintenance offline template in their theme.
I hope this is what you are addressing in this issue.

@NOTE: Don't use this patch instead use patch #47.

Cleanup tags, `drupal core` is unnecessary and IS updated, Rerolled.

If you look at the code for system_theme_suggestions_maintenance_page it checks a constant to determine if the site is in maintenance mode. This is when processes like update and authorize are running. Only then will the page template maintenance-mode--offline.html.twig ever be picked up.

The steps to reproduce the issue are not valid as they don't result in the site site being "offline". Instead they are fatal errors which have nothing to do with the MAINTENANCE_MODE indicator.

I'm not even sure why there's a need for an offline template. you need to put your site in maintenance mode for the offline template to ever be picked up. And it would seem that if you are running processes to update your site the maintenance page template should suffice.

You’ll have to go back and find out the rationale on it. Nevertheless it’s functionality that existed in D7, but the migration to D8 is incomplete leaving this functionality broken.

I agree with @bthompson1, it is advised to keep the site in maintenance mode before doing update activity.

But I believe @jaypan is reporting about the fatal error messages (like 500, website encountered an error with backtrace messages) which render as an unformatted text on the browser. He is talking about the templatizing of these error messages. Also, I think this is not related to offline mode. @jaypan, would you please confirm if I am not wrong.

If it is related to templatizing of error messages only then patch #47 is working fine for different fatal error messages that occurred on the site. Also after applying this patch, you can customize the template in your custom theme.

@NOTE: If it is not related to maintenance mode then the naming convention of template Is a point of discussion. What name should be given to the template?

Modifications for test case failure.

Modified the patch for test case failure.

@NOTE: Please review Patch #54, as it is not compatible.

It looks like there are test failures so the correct status is Needs work. We probably also need to add some tests so I added the Needs tests tag.

I am leaving the Novice tag on this issue because it is still fairly clear what the next steps are.

It may also help to clarify the intent of the issue in the issue summary based on the discussion in earlier comments.

Adding Global2020 and Bug Smash Initiative tags to hopefully move the issue forward. See my previous comments.

I would like to propose to use the offline theme from the settings.php instead of trying to get the active theme. In my testing I always got "seven" as active theme, so this should be more reliable.

I also added escaping of the error message and removed deprecated code.

Fixing tests. BigBipe explicitly expects the error message to not contain a <body>-Tag. The Error does contain this tag after applying the patch. So I removed the assertion.

There is still work to do here, see #63.

woking same patch on 9.2.x. Tested on local.

I performed Novice Triage on this issue. I am leaving the Novice tag on this issue because I think that we can work on this together to add a test to the latest patch in order to assert the regression.

Bump back to Needs work because we should add a test for the patch since this is a regression. @shaktik, you can add a test run manually to a patch that is in Needs work without needing to change it.

Also I added the Needs issue summary tag because as it took a while to (re-)familiarize myself with what has happened so far in the issue. I think having a proposed resolution section to describe what we have done (code-wise) to resolve the issue.

I've changed "Steps to reproduce" slightly since there are two "main players" we should consider: error_level and maintenance_theme. In the test cases I suggest to focus on 'error_level = hide' because we should examine system behavior from a user point of view above all.

My review and a new patch proposal

1. #67 patch fails at a case A from "Steps to reproduce". A html page with "Service unavailable" is expected but we get a plain text "The website encountered an unexpected error. Please try again later.".  It is caused by the fact that on a very early stage during fatal error handling we don't have an access to the container. It is not created because of inactive database. So we cannot use such functions like drupal_get_path().
2. Final fatal errors are rendered as a html page now  so we need change comments in a FinalExceptionSubscriber.php
3. Function  Error::renderFatalError() can throw its own exception so we shouldn't display this error (an exception message and a backtrace) if the fatal error is not displayable.
4. If we can use 'maintenance-page--offline.html.twig' template it should be described in a default.settings.php
5. If we don't check 'body' tag in a BigPipeTest.php a comment should be changed slightly
6. Function drupal_get_path() has been deprecated (https://www.drupal.org/node/2940438) and we should use \Drupal::service('extension.list.theme')->getPath($theme)
7. If error_level is set to verbose (case A from "Steps to reproduce") there is no empty line between the content and the error message
8. We still need automated tests. In my opinion there are two existing test classes we may consider to change a little:  UncaughtExceptionTest and ErrorHandlerTest

I can't resist thoughts that this issue is just a 'feature request'. We don't get WSOD in 9.2.x any longer. All proposed changes lead to replace plain text message with a Twig template.

Let's try this patch. FinalExceptionSubscriber sends a html response if a request format is html and a plain text otherwise.

A small fix to pass a testExpectedScaffoldFiles.

#76 patch is green so review is appreciated.

Tested and confirmed - the template is correctly picked up for both the test cases outlined in the issue outline. Thanks for the nice work!

Tag clean-up and back to NW for Needs Tests (#63)

(IS was updated in #45)

Lemme see if I can make a failing test for both scenarios that passes with patch #76

So I've managed to create a test for Scenario A in the IS (Change DB credentials.

I've attached that to patch#76 and as a test_only_should_fail patch.

For scenario B I've tried something similar:

  /**
   * Tests if the maintenance offline page is served when settings.php
   * originally did have a hash_salt defined, which is emptied out afterwards.
   */
  public function testRemovedHashSalt() {
    $this->drupalGet('');
    $this->assertSession()->statusCodeEquals(200);
    $this->assertSession()->pageTextContains('Log in');

    $settings = [];

    // Set $settings['hash_salt'] = '' in settings.php
    $settings['settings']['hash_salt'] = (object) [
      'value' => '',
      'required' => TRUE,
    ];
    $this->writeSettings($settings);

//    drupal_flush_all_caches();

    $this->drupalGet('');
    $this->assertSession()->statusCodeEquals(500);
    $this->assertSession()->pageTextContains('Service unavailable');
  }

but that doesn't work for TestBot.

Since reading the salt_hash happens very early in the bootstrap phase, changing it afterwards has an effect when doing actual request, but TestBot doesn't notice the change.

I've tried uncommenting drupal_flush_all_caches(); in the example above, but that throws an uncaught RuntimeException, which is an automatic fail for TestBot :/

Somebody with a bigger (Test Writing) brain than mine has to look at this.

Leaving at "Needs work" because there's still no test for Scenario B as described in the Issue Summary.

Please ignore the test_only patch from #80, this is the correct one.

@Spokje, Thanks for your tests. They inspired me a lot. I tried hard to figured it out how to write an automated test when there is no 'hash_salt' value in a settings.php file. It turned out that you were really close to solve it. Function drupal_flush_all_caches() should be called before rewriting settings. The same situation is described in "Steps to reproduce". We should clear a cache first and than refresh a page. Besides this, I've added additional test cases because we should check if a maintenance theme's template is picked up when it exists in a 'template' directory. I hope it is OK now but review is appreciated.

Was 2720109-83-test-only.patch supposed to fail?

Yes, 2720109-83-test-only.patch should fail. It replicates "Steps to reproduce" and proves that system without a 2720109-83.patch has a bug.

The idea of 'test-only' patches is explained at a step #10 on a page https://www.drupal.org/contributor-tasks/write-tests

Removed `Needs Tests`-tag since tests are here (thanks @kndr!🙏).

Since I myself worked on this issue I can't make it RTBC, but the quick scan I did on the code looks promising.

The idea of 'test-only' patches is explained at a step #10 on a page https://www.drupal.org/contributor-tasks/write-tests

Thank you, appreciated.
I don't have a testing system set up, or the time to do so, to be able to test it myself. When I do, I will, if no one has.

@Jaypan Can you mark this issue RTBC? There is a nice cheat sheet and a sample comment http://www.kristen.org/content/my-drupal-issue-queue-rtbc-cheat-sheet Thanks.

I'm matching RTBC as:
* Patch applies cleanly.
* Tests pass.
* Test-only patch fails as expected.
* No coding standard problems were found by the test bot.
* Code is clear and addresses the issue from the issue summary.
* New test code tests the specific issue from the issue summary.
* Feedback from previous comments has been addressed.
* Issue title is clear and relevant.
* The issue summary properly clarifies the issue
* Issue metadata looks okay.
* Manually tested and patch works as expected.

Reuploading the patch in #83 because the fail patch is being tested every two days.

1. +++ b/core/assets/scaffold/files/default.settings.php
   @@ -572,10 +572,15 @@
   + * This applies also when the database is inactive due to an error or when a fatal
   + * error is thrown.
   + * The template file should also be copied into the theme. It is located inside
   + * 'core/modules/system/templates/maintenance-page--offline.html.twig'.
   
   +++ b/sites/default/default.settings.php
   @@ -572,10 +572,15 @@
   + * This applies also when the database is inactive due to an error or when a fatal
   + * error is thrown.
   + * The template file should also be copied into the theme. It is located inside
   + * 'core/modules/system/templates/maintenance-page--offline.html.twig'.
   

   The comment shoudl wrap at 80 chars/

2. +++ b/core/lib/Drupal/Core/Utility/Error.php
   @@ -100,6 +106,71 @@ public static function renderExceptionSafe($exception) {
   +      // The maintenance theme is set but the container doesn't exist
   +      // since the database is inactive. Hence there are no services available
   +      // to retrieve a maintenance theme path. The path can be obtained by using
   +      // ExtensionDiscovery::scan() but it calls \Drupal::installProfile()
   +      // so a minimal mocked container has to be created earlier.
   +      $container = new ContainerBuilder();
   +      $container->setParameter('install_profile', NULL);
   +      \Drupal::setContainer($container);
   

   This can be removed if we call
   $listing->setProfileDirectories([]); after constructing the $listing object and before scanning.

3. +++ b/core/modules/system/tests/src/Functional/System/MaintenancePageOfflineTest.php
   @@ -0,0 +1,212 @@
   +        'value' => $this->randomMachineName(),
   

   This has the potential to be randomly correct. I would take the current username and add a longer random string to it. Or something like that.

4. +++ b/core/modules/system/tests/src/Functional/System/MaintenancePageOfflineTest.php
   @@ -0,0 +1,212 @@
   +    $this->assertSession()->pageTextContains('Log in');
   +
   +    drupal_flush_all_caches();
   +
   +    // CASE 1 - a maintenance theme's template is picked up
   +    // and no errors are displayed.
   ...
   +    $this->assertSession()->pageTextContains('Log in');
   +
   +    drupal_flush_all_caches();
   +
   +    // CASE 1 - a maintenance theme's template is picked up
   +    // and no errors are displayed.
   

   If the drupal_flush_all_caches() is necessary it need a comment as to why. I'm not sure it is necessary.

@alexpott, thank you for the review. You are absolutely right so I've made changes you suggested. As for the point 3 I decided to change the user password since it is impossible to set it correctly in this way. It turned out that drupal_flush_all_caches() was not necessary in an automated test but flushing the cache is necessary during manual testing 'hash_salt'. BTW, is it still valid to attach a test-only patch? If it is being tested every two days as @quietone said at #93 maybe test-only patch should be omitted?

In this case:

* The template file should also be copied into the theme. It is located inside
* 'core/modules/system/templates/maintenance-page--offline.html.twig'.

Please could you use "inside of"? E.g.:

* The template file should also be copied into the theme. It's located inside of
* 'core/modules/system/templates/maintenance-page--offline.html.twig'.

If we're doing wording, I think "located at" is natural.

I agree

First a reroll of patch #95.

Addressed #97/#99

Used 2720109-102.patch as base for the MR against 9.3.x/code>

Came to do a review.

I started reading the Issue Summary. It is really nice to have steps to reproduce, A and B. However, there are no remaining tasks or proposed resolution. Without a proposed resolution it is not possible to confirm that the patch here is doing what it should be. Note that #71 also asked for a proposed resolution section to be added. Tagging for an issue summary update and keeping the novice tag, I think updating the IS for this issue is a suitable novice task.

Then I read the issue. And then I got very confused about when the maintenance mode template is to be used. See #34, #41 and #49, all of which did not, in my opinion receive an explanation. Perhaps the reason is in the IS where is says that Drupal 7 behaved this way. I don't know if that is true, but if it is it is a regression. If I understand correctly, this is using the maintenance mode twig file when the site is deliberately placed in maintenance mode and when a fatal error occurs. The IS just says that this is to use the twig file when the site is offline and when I think 'offline' I think maintenance mode not fatal. If that is correct the IS can state that more clearly. I am not doing that in case I am wrong.

This issue also should have before and after screenshots.

No time left for a code review.

Edit: s/the/then/

As I mentioned at #74 I see this issue more as "feature request" than "bug report". The issue priority is too high as well. I can agree that maintenance mode has nothing in common with handling fatal errors. The whole work that was done in this issue was focused on rendering fatal error page from twig template. That's all. I vote for changing the category to "feature request", priority to "normal" and topic to "Render fatal error page from twig template" or so. The last patch can handle this new feature but it uses a little confusing template's name (maintenance-page--offline.html.twig) in the new context.

@kndr, thank you! I was so focused on getting my head around this issue that I didn't even think about the issue category and priority.

I agree with kndr and have implemented the suggestions in #107.

Setting to NW to change the template name to something that reflects what the template is for.

This is a bug. It's behavior from Drupal 7 that was not ported to Drupal 8, containing documentation that indicates the template will be picked up and it is not. As this bug causes a fatal error with a WSOD, it is a major bug.

@jaypan Are you sure that it causes a fatal error with WSOD? Neither "Situation A" nor "Situation B" described in "Steps to reproduce" ends with WSOD. As a result we have a plain text message: "The website encountered an unexpected error. Please try again later." so it works as designed. Can you check this out manually in your environment? Maybe we missed something that causing WSOD. If so I can agree that this is a "bug report". Otherwise I'm pretty sure that this is "feature request".

Replace WSOD with 'fatal error' then. My point still stands that it's a bug, and that it shuts down your site with no control over the site builder to theme the page. This is a major bug.

we have a plain text message: "The website encountered an unexpected error. Please try again later." so it works as designed.

This is where I disagree. As the original post lays out, it was designed to pick up a TWIG template named maintenance-page--offline.html.twig. Drupal 7 allowed for maintenance-page--offline.tpl.php, however this functionality was not properly implemented in Drupal 8, and the corresponding twig template is not picked up, as it was designed to. Hence this thread is a bug report, not a feature request.

This is definitely a bug, not a feature request. The maintenance_page__offline template suggestion is not the only thing impacted by the broken render pipeline when a fatal issue is encountered.

There is also a Twig variable db_offline available in the html.html.twig template supplied by core, but there is no practical way to make use of this Twig variable.

I performed Novice Triage on this issue. I am leaving the Novice tag on this issue because I think there is a good contribution opportunity for manual testing without a local environment to provide before/after screenshots that @quietone requested above. You should be able to do both Scenario A and Scenario B using DrupalPod.

I reviewed the current merge request and took a stab at providing the current proposed resolution and removed the Needs issue summary update tag.

I also added the Needs release note because this is a Major bug fix that site owners should be aware of. I'm not sure if that also means it needs a Change record or not.

I've added a release note. I personally don't think a changelog is necessary, as this isn't a change, it's a bugfix. That said, I don't know the criteria for determining whether a changelog should be written, so I may be out of line on that.

I'm wondering if we should add an item to remaining tasks for writing a documentation page equivalent to Theming the Drupal maintenance page. The linked page contains the D7 documentation for using maintenance-page--offline.tpl.php.

I did my best to reroll the patch on 9.3.x and here's the result.

I think there's something a little bit off with the way the template is looked up maybe? If i set my custom theme as maintenance in settings.php:

$settings['maintenance_theme'] = 'mytheme';

and i put my template in: web/themes/contrib/mytheme/templates/system/maintenance-page--offline.html.twig
it is not picked up. It only gets picked up if i put it in: web/themes/contrib/mytheme/templates/maintenance-page--offline.html.twig

This is not a huge deal, but it threw me off, because i have my "normal" maintenance page template in web/themes/contrib/mytheme/templates/system/maintenance-page.html.twig and that works correctly.

Re-rolled #120 for 9.4

Updated patch will fix the test failure.

The patch in #123 applied successfully to 9.4.x branch.

Patch works well. I used #121 because #123 would not apply to 9.3.9 via composer, and I didn't fell like requiring dev. Thanks!

I applied the patch, and it works.

But I am unable to override the maintenance-page--offline.html.twig template in my theme.

I copied the file to /themes/custom/mytheme/templates/system/maintenance-page--offline.html.twig, cleared the cache, but Drupal still displays the template from the system module instead of my theme.

Updated:
It is working in /themes/custom/mytheme/templates/maintenance-page--offline.html.twig

Have you set your theme as maintenance mode theme in settings.php @hmdnawaz?

$settings['maintenance_theme'] = 'yourtheme';

@joey-santiago

I checked it with with and without that setting,

But now I place the template file directly in the templates directory without a system directory and it works without that setting
in the settings.php.

1. +++ b/core/lib/Drupal/Core/Utility/Error.php
   @@ -100,6 +105,69 @@ public static function renderExceptionSafe($exception) {
   +   * @param array $context
   +   *   Variables to be passed to twig template.
   

   I think this should detail the expected keys. Ie. title, content and displayable and say what they are. Or I wonder if instead of $context we should have 3 parameters.

2. I wonder if we the title context should be mandatory - we're always providing it but we provide a default in the twig template.
3. I also wonder if we're going to all the trouble of using a twig template here we should then also go the other way and stop putting html in the non html responses and only output clean text. But perhaps that's a separate issue. That said this does influence how we should create the template - ie. potentially we should do more in the template and do less html munging in the code.

There is no way to override or add new variables to the template.

I have tried with mytheme_preprocess_maintenance_page(&$variables) but it is not picked up.

function mytheme_preprocess_maintenance_page(&$variables) {
  $variables['title'] = 'new title';
  $variables['new_var'] = 'new_value';
}

It is still taking the variable values from the function _drupal_log_error

$html = Error::renderFatalError([
        'title' => 'Service unavailable',
        'content' => $message,
        'displayable' => error_displayable($error),
      ]);

Here when I add my custom variable like this:

$html = Error::renderFatalError([
        'title' => 'Service unavailable',
        'content' => $message,
        'displayable' => error_displayable($error),
        'custom_var' => 'custom value',
      ]);

and print it in the template as {{ custom_var }} it is working, but I think mytheme_preprocess_maintenance_page(&$variables) is not a preprocess function for this offline template.

Is there any other preprocess function available for this template? How can I override the existing variables of the template and add new variables?

I would suggest that the test in FinalExceptionSubscriber not display the offline message if the error level is verbose. (Change the content type test to:

 if ($content_type == 'text/html' && !$this->isErrorLevelVerbose()) {

I've adjusted the patch from 121 in this attachment.

#135 works against 9.4.x and 9.5.x

This should be taken more seriously as a matter of system reliability in the event of errors. After applying patch #135 in core 9.4.8 and copying the maintenance-page--offline.html.twig template to my theme templates directory (themes/custom/mytheme/templates/maintenance-page--offline.html.twig), the template renders correctly but it is not possible to modify any of its variables from my .theme file, it does not receive any CSS, nor JS, nor does it accept any preprocessing.

Analyzing the patch and trying to add new variables from errors.inc these worked in the template. To make the solution as generic as possible I made the following changes to errors.inc on line 277:

 $base_url = base_url(); //get the base URL of the site
      $base_dir = str_replace(basename($_SERVER['SCRIPT_NAME']), '', $_SERVER['SCRIPT_NAME']); //get the root dir
      $public_dir = $base_dir . 'sites/default/files/'; //get the public dir
      $public_dir_url = $base_url . 'sites/default/files/'; //get the public dir URL

      //Check for a favicon in public files directory with svg or ico mimetype(prefers svg)
       if (file_exists($public_dir . 'favicon.svg')) {
        $favicon = $public_dir_url . 'favicon.svg';
        }else if (file_exists($public_dir . 'favicon.ico')){
         $favicon = $public_dir_url . 'favicon.ico';
       }

      //Check for a logo in public files directory with svg or png mimetype(prefers svg)CHECK more mimes
      if (file_exists($public_dir . 'logo.svg')) {
        $site_logo = $public_dir_url . 'logo.svg';
      }else if (file_exists($public_dir . 'logo.png')){
        $site_logo = $public_dir_url . 'logo.png';
      }

      //Check for a css in public files directory(this fail)
//      if (file_exists($public_dir . 'maintenance/maintenance.css')) {
//        $styles = $public_dir_url . 'maintenance/maintenance.css';
//      }
      //force the load of the css
      $styles = $public_dir_url . 'maintenance/maintenance.css';

      //Check for a js in public files directory(this fail)
//      if (file_exists($public_dir . 'maintenance/maintenance.js')) {
//        $scripts = $public_dir_url . 'maintenance/maintenance.js';
//      }
      //force the load of the js
      $scripts = $public_dir_url . 'maintenance/maintenance.js';

      $html = Error::renderFatalError([
        'title' => 'Service unavailable',
        'content' => $message,
        'displayable' => error_displayable($error),
        'base_url' => $base_url,
        'favicon' => $favicon,
        'site_logo' => $site_logo,
        'styles' => $styles,
        'scripts' => $scripts,
      ]);

And this function at the end of the file:

if (!function_exists('base_url')) {
  function base_url($atRoot=FALSE, $atCore=FALSE, $parse=FALSE){
    if (isset($_SERVER['HTTP_HOST'])) {
      $http = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) !== 'off' ? 'https' : 'http';
      $hostname = $_SERVER['HTTP_HOST'];
      $dir =  str_replace(basename($_SERVER['SCRIPT_NAME']), '', $_SERVER['SCRIPT_NAME']);

      $core = preg_split('@/@', str_replace($_SERVER['DOCUMENT_ROOT'], '', realpath(dirname(__FILE__))), NULL, PREG_SPLIT_NO_EMPTY);
      $core = $core[0];

      $tmplt = $atRoot ? ($atCore ? "%s://%s/%s/" : "%s://%s/") : ($atCore ? "%s://%s/%s/" : "%s://%s%s");
      $end = $atRoot ? ($atCore ? $core : $hostname) : ($atCore ? $core : $dir);
      $base_url = sprintf( $tmplt, $http, $hostname, $end );
    }
    else $base_url = 'http://localhost/';

    if ($parse) {
      $base_url = parse_url($base_url);
      if (isset($base_url['path'])) if ($base_url['path'] == '/') $base_url['path'] = '';
    }

    return $base_url;
  }
}

Then modify the maintenance-page--offline.html.twig template:

{#
/**
 * @file
 * Default theme implementation to display a single Drupal page while offline.
 *
 * @see template_preprocess_maintenance_page()
 *
 * @ingroup themeable
 */
#}
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width-device-width, initial-scale-1">
  <title>
{#    {% if title %}#}
{#      {{ title }}#}
{#    {% else %}#}
      Service unavailable
{#    {% endif %}#}
  </title>
  <link rel="shortcut icon" type="image/x-icon" href="{{ favicon }}">
  <link rel="stylesheet" href="{{ styles }}">
</head>

<body class="maintenance-page layout-no-sidebars path-frontpage">
<div class="container contenido-mantenimiento">
  <div class="caja" data-aos="fade-up" data-aos-duration="700" data-aos-delay="1000" data-aos-once="true">
    <header role="banner" data-aos="zoom-in" data-aos-duration="500" data-aos-delay="1300"
            data-aos-once="true">
      <img src="{{ site_logo }}" alt="Site name"/>
    </header>
    <main class="texto-mantenimiento" role="main">

      <h2 data-aos="fade-up" data-aos-duration="600" data-aos-delay="1600"
          data-aos-once="true">
{#        {{ title }}#}
        Your site name or something else
      </h2>

      <div data-aos="fade-up" data-aos-duration="600" data-aos-delay="1900" data-aos-once="true">
{#        {{ page.content }}#}
        Your personalized text explaining the error.
        <br><br>
        Some more text.
      </div>
    </main>
  </div>
</div>
<script src="{{ scripts }}"></script>
</body>
</html>

In this template I also decided to add animations to make it not so flat.

Then in the public files directory (/sites/default/files) add a favicon.svg, a logo.svg and a maintenance folder to put CSS, JS and images files.
Optional (for animations): place the AOS library in an aos folder inside maintenance.

This is my CSS in maintenance.css, note that the '@import' is for loading the aos library from the CSS itself:

@import "aos/aosnext.css";
body.maintenance-page {
  font-family: "Verdana", sans-serif;
  font-size: 14px;
  margin: 0;
  background-image: url("images/mantenimiento.jpg");
  background-attachment: fixed;
  background-position: center center;
  background-repeat: no-repeat;
  background-size: cover; }
body.maintenance-page .contenido-mantenimiento {
  display: flex;
  flex-direction: column;
  align-items: center;
  justify-content: center;
  height: 100vh; }
body.maintenance-page .contenido-mantenimiento .caja {
  padding: 1.5rem;
  text-align: justify;
  color: #000;
  background-color: rgba(255, 255, 255, 0.8); }
body.maintenance-page .contenido-mantenimiento header {
  display: flex;
  flex-direction: column;
  align-items: center;
  justify-content: center;
  margin-bottom: 1rem; }
body.maintenance-page .contenido-mantenimiento header img {
  width: 200px; }
body.maintenance-page .contenido-mantenimiento .texto-mantenimiento {
  display: flex;
  flex-direction: column;
  align-items: center;
  justify-content: center;
  text-align: center;
  font-size: 1rem; }
body.maintenance-page .contenido-mantenimiento .texto-mantenimiento h2 {
  text-align: center;
  margin-bottom: 1rem; }

This is my JS in maintenance.js, the function to concatenate the JS fails to load because of some access restriction, so I manually concatenated jQuery and the AOS library and then put my custom code:

// function include(filePath) {
//   const scriptTag = document.createElement("script");
//   scriptTag.src = filePath;
//   document.body.appendChild(scriptTag);
// }
// include("js/jquery.min.js");
// include("aos/aosnext.js");

//Jquery
/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */
<Full jQuery JS content>(I am not copying it here for obvious reasons)

//AOS
<Full AOS JS content>(I am not copying it here for obvious reasons)

//My code
jQuery(document).ready(function () {
  setTimeout(() => {
    AOS.init();
  }, 120);
});

After all this "superhuman" effort I managed to create an offline maintenance page with a similar style and behavior (animations) to the online maintenance page (just change the texts). Of this last one it would be necessary a way to access to those variables of the site and to show them in the template so that it is not necessary to put the plain text.

Please someone review these modifications to see what can be improved and please update the patch with these changes that are a temporary solution to this problem, it is not the best but it solves. I don't know how to update the patch on my own or make patches. Thanks in advance and I hope this solution will be helpful.

Translated with www.DeepL.com/Translator (free version)

Thanks for the patch #151 - this applied for me on Drupal 9.5 - and I was able to change the offline page within a minimal theme I have created just for offline pages across all my multisites.

The issues I cannot fathom - is how to elegantly alter the response code of the error page. If we have a database issue - I need a 504 - such that my upstream proxy serves an interim cached site page - any thoughts around this? Previously, we could achieve that using a preprocess hook - but as we're bypassing the drupal ecosystem and going direct via twig - I can't see how to alter the response code.

Can't get 135 to apply on 10.1.1 with composer.

Here's the patch in #135 re-rolled for 10.1.

142 applies, but it's not picking up my maintenance-page--offline.html.twig file.

Ahh... I was missing this step:

Edit settings.php, uncomment the line $settings['maintenance_theme'] = 'bartik';, and change the value from bartik to the machine name of the theme you chose in step one above.

Re-rolled the patch for 10.2

@binoli-lalani: Please change the title of the MR back the way it was. This issue has nothing to do with fixing missing hyphens for prefixes - Words starting with "de"

The title should be:

Issue #2720109 by Spokje, kndr, sharma.amitt16, maacl, felribeiro, Neslee Canil Pinto, yogeshmpawar, quietone, zeuty, joey-santiago, Brian-C, ranjith_kumar_k_u, seppelM, jenny.cha, kiwimind, NikLP: maintenance-page--offline.html.twig is not picked up when system is offline

Hello @everyone
I also tried to change the title using git (by changing the commit message ), but sadly, that is not working, and I don't have access to change it directly at MR

Hi @jwilson3,

The original merge request seemed to be abandoned and the title was still incorrect.
Since there was no update, I created a new branch using cherry-pick and opened a new MR with the correct title as suggested.

Some minor adjustments were also made to fix issues that were causing test failures.

Let me know if there's anything that needs to be changed or improved.

Left comments.

patch for 11.2 without tests

The above patch in 154 is wrong. The correct one with tests.

154 and 155 don't patch for Drupal 11.3 for me. How about others?

#155 patch worked for me on Drupal 11.3.3, but you definitely need to make sure your maintenance-page--offline.html.twig is in your theme's template folder and not within a sub-directory. Once I applied the patch and moved it to just "templates" directory, the site picked it up as expected.

I have a functional offline maintenance page using 155, tests well. Do we need more people testing it or could we move this forward to get it merged before core updates again and we miss the opportunity to get this in. It's been a long road for this work already.

The MR has numerous errors, needs a rebase, and needs a review before going to RTBC

I am removing the Novice tag from this issue because it is not as straightforward to manual test and provide a good review.

I’m using this documentation as a source: https://www.drupal.org/community/contributor-guide/task/triage-novice-is...