|
1 | 1 | # Enhanced Laravel 5 Maintenance Mode |
2 | 2 |
|
3 | | -This package is a drop-in replacement for Laravel 5.5 - 5.6's maintenance mode. For 5.0 - 5.2, please use the |
4 | | -[1.0 branch](https://github.com/MisterPhilip/maintenance-mode/tree/1.0). For 5.3 - 5.4, support may be released on the |
5 | | -[1.1 branch](https://github.com/MisterPhilip/maintenance-mode/tree/1.1) branch, should there be any interest / development |
6 | | -help. |
7 | | - Features include: |
| 3 | +This package is a drop-in replacement for Laravel 5.5 - 5.6's maintenance mode. For Laravel 5.0 - 5.2, please use the |
| 4 | +[1.0 branch](https://github.com/MisterPhilip/maintenance-mode/tree/1.0). For Laravel 5.3 - 5.4, support _might_ be released |
| 5 | +on the [1.1 branch](https://github.com/MisterPhilip/maintenance-mode/tree/1.1) branch, should there be any interest / |
| 6 | +development help. Features include: |
8 | 7 | - Allowing custom maintenance messages to be shown to users |
9 | 8 | - Including a timestamp of when the application went down |
10 | 9 | - Exempting select users via custom exemption classes |
@@ -119,6 +118,10 @@ To bring your application back online, run the normal app up command: |
119 | 118 | $ php artisan up |
120 | 119 | ``` |
121 | 120 |
|
| 121 | +**NOTE:** by default, two [exemptions](#exemptions) enabled, which means that if you run |
| 122 | +your development server locally (127.0.0.1) _or_ you have `APP_ENV=local` in your `.env` file, you will _not_ see the |
| 123 | +maintenance page. You can remove these exemptions via the [configuration](#overriding-defaults). |
| 124 | + |
122 | 125 | ## Configuration |
123 | 126 |
|
124 | 127 | This package is a drop-in replacement for the default maintenance mode provided with Laravel 5. This means |
@@ -155,7 +158,7 @@ information is within the configuration file too! |
155 | 158 | to get the user's IP address |
156 | 159 | - Defaults to `false` |
157 | 160 | - `exempt-environments` (string array) |
158 | | - - An array of enviornment names that will always be exempt from the application down page |
| 161 | + - An array of environment names that will always be exempt from the application down page |
159 | 162 | - Defaults to `['local']` |
160 | 163 | - `exemptions` (string array) |
161 | 164 | - A list of the exemption classes to execute. *See [Exemptions](#exemptions)* |
|
0 commit comments