Skip to content

Commit 666d114

Browse files
committed
🚀 Release version 2.0.0 and probably the last in a long time.
1 parent ff5d543 commit 666d114

File tree

194 files changed

+12409
-29
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

194 files changed

+12409
-29
lines changed

CHANGELOG.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,48 @@
22

33
Below is a detailed change-log, along with specific tasks completed, for each version released to date for Apache Error Pages.
44

5+
## Version 2.0.0 (15/05/2018)
6+
7+
- [#new](#new)
8+
- Added link to Font Awesome License.
9+
- New templates:
10+
- `409.html`
11+
- `410.html`
12+
- `412.html`
13+
- `416.html`
14+
- `417.html`
15+
- `418.html`
16+
- `421.html`
17+
- `422.html`
18+
- `423.html`
19+
- `424.html`
20+
- `426.html`
21+
- `428.html`
22+
- `451.html`
23+
- `506.html`
24+
- `507.html`
25+
- `508.html`
26+
- `510.html`
27+
- `511.html`
28+
- `nginx/444.html`
29+
- `nginx/494.html`
30+
- `nginx/495.html`
31+
- `nginx/496.html`
32+
- `nginx/497.html`
33+
- `nginx/499.html`
34+
- `ms-iis/440.html`
35+
- `ms-iis/449.html`
36+
- `ms-iis/451.html`
37+
- All template files missing have now been created. There are no outstanding error codes to add; the list is now exhaustive.
38+
- Additional Server Support; now supporting Nginx, IIS and others.
39+
- Added new minification scripts to minify additional templates for:
40+
- Nginx: `./scripts/minify_nginx`
41+
- MS IIS: `./scripts/minify_iis`
42+
- Other: `./scripts/minify_other`
43+
- [#enhancement](#enhancement)
44+
- Restructured the `/dist/` folder and cleaned it up so it now only contains sub-folders for the respective webservers.
45+
- Apache templates files have moved from `/dist/` to `/dist/apache/`.
46+
547
## Version 1.1.0 (14/05/2018)
648

749
- [#new](#new)

README.md

Lines changed: 156 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
These Apache Error Pages project is a drop-in replacement of beautifully designed, user-friendly Apache 2 error pages. If you're tired of having _boring_ Apache error pages displayed to users then these might just be the solution for you.
44

5+
As of Version 2.0.0 there is now additional support for Nginx, Microsoft IIS and other webservers. Installation instructions are similar to Apache 2 and more details are contained below.
6+
57
<!-- @import "[TOC]" {cmd="toc" depthFrom=2 depthTo=6 orderedList=false} -->
68

79
<!-- code_chunk_output -->
@@ -16,6 +18,7 @@ These Apache Error Pages project is a drop-in replacement of beautifully designe
1618
* [Smartphone (older-generation)](#smartphone-older-generation)
1719
* [Installation](#installation)
1820
* [Copying the Error Pages](#copying-the-error-pages)
21+
* [Additional Server Support](#additional-server-support)
1922
* [Modifying your Apache Config file](#modifying-your-apache-config-file)
2023
* [Minification Setup](#minification-setup)
2124
* [Dependencies](#dependencies)
@@ -24,12 +27,15 @@ These Apache Error Pages project is a drop-in replacement of beautifully designe
2427
* [Installing postcss](#installing-postcss)
2528
* [Installing uglify-js](#installing-uglify-js)
2629
* [Running the minify script](#running-the-minify-script)
30+
* [Additional scripts](#additional-scripts)
31+
* [Nginx](#nginx)
32+
* [Microsoft IIS](#microsoft-iis)
33+
* [Other](#other)
2734
* [Contributing](#contributing)
2835
* [Code of Conduct](#code-of-conduct)
2936
* [Versioning](#versioning)
3037
* [Change-Log](#change-log)
3138
* [Authors](#authors)
32-
* [TODO](#todo)
3339
* [License](#license)
3440
* [Acknowledgements](#acknowledgements)
3541

@@ -41,7 +47,12 @@ These Apache Error Pages project is a drop-in replacement of beautifully designe
4147
* A compressed distribution **file size which totals only `78 KB`** (from `111 KB`) and includes Images, CSS, HTML and JavaScript. Total package size is `2.1 MB` with all the _Font Awesome_ and _Web Fonts_ included.
4248
* Fully responsive templates, **works across desktop, tablet and mobile** phones.
4349
* Animated text, **creating the experience of a terminal console**, outputting the respective error code to screen.
44-
* There are **27 templates**, 20 exclusively for Apache with an additional 7 for other web-servers. Enjoy!
50+
* Now **full support for Nginx, Microsoft IIS and other webservers** which are non-Apache related.
51+
* There are **54 templates**:
52+
* **38** exclusively for Apache.
53+
* **6** for `Nginx`.
54+
* **7** `non-Apache` HTTP status codes templates.
55+
* **3** for `Microsoft Internet Information Services`.
4556
* Each template, as well as all CSS files, have been minified to ensure the **smallest file size possible**.
4657
* **Font Awesome icons** used in error messages.
4758

@@ -73,7 +84,7 @@ These Apache Error Pages project is a drop-in replacement of beautifully designe
7384

7485
## Installation
7586

76-
Installing the drop-in replacement for Apache 2 error pages comes in two parts. First, you need to copy all the files contained within the `/dist/` folder to a location on your server. Second, you need to edit your `apache.conf` or `httpd.conf` file to link the error pages to your server installation.
87+
Installing the drop-in replacement for Apache 2 error pages comes in two parts. First, you need to copy all the files contained within the `/dist/apache/` folder to a location on your server. Second, you need to edit your `apache.conf` or `httpd.conf` file to link the error pages to your server installation.
7788

7889
### Copying the Error Pages
7990

@@ -83,11 +94,11 @@ Do not replace the default error pages with this project's files. Instead, insta
8394

8495
```bash
8596
$ cd Apache-Error-Pages/
86-
$ cp -R dist/ /usr/local/var/www/error-pages
97+
$ cp -R dist/apache/ /usr/local/var/www/error-pages
8798
$ chown -R www:apache /usr/local/var/www/error-pages # see note below.
8899
```
89100

90-
**NB: _Ensure that you replace `www` and `apache`, in the `chown` command above, with your web-server's default user and group._**
101+
**Note: _Ensure that you replace `www` and `apache`, in the `chown` command above, with your web-server's default user and group._**
91102

92103
Check to see if you have all the required files.
93104

@@ -107,22 +118,36 @@ Make sure that you have the following file structure below.
107118
├── 406.html
108119
├── 407.html
109120
├── 408.html
121+
├── 409.html
122+
├── 410.html
110123
├── 411.html
124+
├── 412.html
111125
├── 413.html
112126
├── 414.html
113127
├── 415.html
114-
├── 420.html
128+
├── 416.html
129+
├── 417.html
130+
├── 418.html
131+
├── 421.html
132+
├── 422.html
133+
├── 423.html
134+
├── 424.html
135+
├── 426.html
136+
├── 428.html
115137
├── 429.html
116138
├── 431.html
139+
├── 451.html
117140
├── 500.html
118141
├── 501.html
119142
├── 502.html
120143
├── 503.html
121144
├── 504.html
122145
├── 505.html
123-
├── 900.html
124-
├── 901.html
125-
├── 902.html
146+
├── 506.html
147+
├── 507.html
148+
├── 508.html
149+
├── 510.html
150+
├── 511.html
126151
├── assets
127152
│   └── imac.svg
128153
├── css
@@ -151,8 +176,20 @@ Make sure that you have the following file structure below.
151176
├── fa-solid-900.ttf
152177
├── fa-solid-900.woff
153178
└── fa-solid-900.woff2
179+
180+
3 directories, 63 files
154181
```
155182

183+
### Additional Server Support
184+
185+
In addition to the above Apache 2 error pages there is also support for additional webservers. You can find production-ready, minified template files for the following webservers:
186+
187+
* Nginx files located at `dist/nginx/`
188+
* Microsoft IIS files located at `dist/ms-iis/`
189+
* Other webserver files located at `dist/other/`
190+
191+
You can copy the template files required from any of these additional webserver folders to your server installation.
192+
156193
### Modifying your Apache Config file
157194

158195
Once you have your files in the right location you can now edit either your `apache.conf` or `httpd.conf` file, depending on your particular installation.
@@ -248,18 +285,36 @@ ErrorDocument 405 /ErrorPages/405.html
248285
ErrorDocument 406 /ErrorPages/406.html
249286
ErrorDocument 407 /ErrorPages/407.html
250287
ErrorDocument 408 /ErrorPages/408.html
288+
ErrorDocument 409 /ErrorPages/409.html
289+
ErrorDocument 410 /ErrorPages/410.html
251290
ErrorDocument 411 /ErrorPages/411.html
291+
ErrorDocument 412 /ErrorPages/412.html
252292
ErrorDocument 413 /ErrorPages/413.html
253293
ErrorDocument 414 /ErrorPages/414.html
254294
ErrorDocument 415 /ErrorPages/415.html
295+
ErrorDocument 416 /ErrorPages/416.html
296+
ErrorDocument 417 /ErrorPages/417.html
297+
# ErrorDocument 418 /ErrorPages/418.html (this isn't working and not sure why)
298+
ErrorDocument 421 /ErrorPages/421.html
299+
ErrorDocument 422 /ErrorPages/422.html
300+
ErrorDocument 423 /ErrorPages/423.html
301+
ErrorDocument 424 /ErrorPages/424.html
302+
ErrorDocument 426 /ErrorPages/426.html
303+
ErrorDocument 428 /ErrorPages/428.html
255304
ErrorDocument 429 /ErrorPages/429.html
256305
ErrorDocument 431 /ErrorPages/431.html
306+
ErrorDocument 451 /ErrorPages/451.html
257307
ErrorDocument 500 /ErrorPages/500.html
258308
ErrorDocument 501 /ErrorPages/501.html
259309
ErrorDocument 502 /ErrorPages/502.html
260310
ErrorDocument 503 /ErrorPages/503.html
261311
ErrorDocument 504 /ErrorPages/504.html
262312
ErrorDocument 505 /ErrorPages/505.html
313+
ErrorDocument 506 /ErrorPages/506.html
314+
ErrorDocument 507 /ErrorPages/507.html
315+
ErrorDocument 508 /ErrorPages/508.html
316+
ErrorDocument 510 /ErrorPages/510.html
317+
ErrorDocument 511 /ErrorPages/511.html
263318
```
264319

265320
Save your file and then test your configuration changes by executing the following.
@@ -332,7 +387,7 @@ $ cd src/
332387
$ ./scripts/minify
333388

334389
# expected output when executing `minify`:
335-
The ../dist folder has been reset.
390+
The ../dist/apache folder has been reset.
336391
400.html minified
337392
401.html minified
338393
403.html minified
@@ -341,30 +396,114 @@ The ../dist folder has been reset.
341396
406.html minified
342397
407.html minified
343398
408.html minified
399+
409.html minified
400+
410.html minified
344401
411.html minified
402+
412.html minified
345403
413.html minified
346404
414.html minified
347405
415.html minified
406+
416.html minified
407+
417.html minified
408+
418.html minified
409+
421.html minified
410+
422.html minified
411+
423.html minified
412+
424.html minified
413+
426.html minified
414+
428.html minified
348415
429.html minified
349416
431.html minified
417+
451.html minified
350418
500.html minified
351419
501.html minified
352420
502.html minified
353421
503.html minified
354422
504.html minified
355423
505.html minified
424+
506.html minified
425+
507.html minified
426+
508.html minified
427+
510.html minified
428+
511.html minified
356429
All the CSS files have now been minified.
357430
Minification Complete!
358431
```
359432

360433
There are no options for running this script. Executing this command will:
361434

362-
* Delete the `/dist/css/` folder.
363-
* Delete all the error pages with `rm -f ../dist/*.html`.
364-
* Recreate the `/dist/css/` folder.
435+
* Delete the `/dist/apache/css/` folder.
436+
* Delete all the error pages with `rm -f ../dist/apache/*.html`.
437+
* Recreate the `/dist/apache/css/` folder.
365438
* Minify the HTML for all files in the `/src/` directory.
366439
* Minify the CSS for all the files in `/src/css/` directory.
367-
* Output the HTML and CSS to the `/dist/` folder.
440+
* Output the HTML and CSS to the `/dist/apache/` folder.
441+
442+
#### Additional scripts
443+
444+
##### Nginx
445+
446+
There are additional templates which are used only by `nginx`. These templates are included in the `dist/nginx/` folder and the script below will minify the files for this folder.
447+
448+
```bash
449+
$ cd src/
450+
$ ./scripts/minify_nginx
451+
452+
# expected output when executing `minify_nginx`:
453+
The ../dist/nginx folder has been reset.
454+
444.html minified
455+
494.html minified
456+
495.html minified
457+
496.html minified
458+
497.html minified
459+
499.html minified
460+
All the CSS files have now been minified.
461+
Copying the /assets/ folder across...
462+
Copying the /webfonts/ folder across...
463+
Minification Complete!
464+
```
465+
466+
##### Microsoft IIS
467+
468+
There are additional templates which are used only by Microsoft Internet Information Services. These templates are included in the `dist/ms-iis/` folder and the script below will minify the files for this folder.
469+
470+
```bash
471+
$ cd src/
472+
$ ./scripts/minify_iis
473+
474+
# expected output when executing `minify_iis`:
475+
The ../dist/ms-iis folder has been reset.
476+
440.html minified
477+
449.html minified
478+
451.html minified
479+
All the CSS files have now been minified.
480+
Copying the /assets/ folder across...
481+
Copying the /webfonts/ folder across...
482+
Minification Complete!
483+
```
484+
485+
##### Other
486+
487+
There are additional templates which are used only by other webservers. These templates are included in the `dist/other/` folder and the script below will minify the files for this folder.
488+
489+
```bash
490+
$ cd src/
491+
$ ./scripts/minify_other
492+
493+
# expected output when executing `minify_other`:
494+
The ../dist/other folder has been reset.
495+
420.html minified
496+
520.html minified
497+
521.html minified
498+
533.html minified
499+
900.html minified
500+
901.html minified
501+
902.html minified
502+
All the CSS files have now been minified.
503+
Copying the /assets/ folder across...
504+
Copying the /webfonts/ folder across...
505+
Minification Complete!
506+
```
368507

369508
## Contributing
370509

@@ -380,18 +519,14 @@ We use [Semantic Versioning][semver] for software versions of this project. For
380519

381520
## Change-Log
382521

383-
View the [`CHANGELOG.md`][changelog] file for a detailed list of changes, along with specific tasks completed for each version released to date.
522+
View the [CHANGELOG.md][changelog] file for a detailed list of changes, along with specific tasks completed for each version released to date.
384523

385524
## Authors
386525

387526
* Justin Hartman - [@justinhartman][author-1]
388527

389528
Also see the list of [contributors][contribs] who have participated in this project.
390529

391-
## TODO
392-
393-
A detailed list of TODO items can be found [over here][todo].
394-
395530
## License
396531

397532
This work is licensed under the [GNU Affero General Public License][agpl]. You can view the full LICENSE by [reading this][license] file.
@@ -418,7 +553,7 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
418553
Thanks go out to the following for the inspiration, images, icons and, in some cases, the code to back this project up.
419554

420555
* [Computer SVG][vector] by Kameleon - License [CC BY 3.0][ccby30].
421-
* Icons by [Font Awesome][fontawesome] - License [CC BY 4.0][ccby40].
556+
* Icons by [Font Awesome][fontawesome] - Read [License here][fa-license].
422557
* [html-minifier][html-min] - for compressing the `/src/*.html` files into the `/dist/*.html` folder. License: [MIT][mit].
423558
* [PostCSS][postcss] - for compressing the `/src/css/` css files into the `/dist/css/` folder. License: [MIT][mit].
424559
* [@maicong/ErrorPages][maicong] - for the terminal/console output code. License: [MIT][mit].
@@ -437,12 +572,12 @@ Thanks go out to the following for the inspiration, images, icons and, in some c
437572
[gpl]: http://www.gnu.org/licenses/#GPL
438573
[trimstray]: https://github.com/trimstray/http-error-pages
439574
[fontawesome]: https://www.fontawesome.com
575+
[fa-license]: licenses/LICENSE.txt
440576
[agpl]: https://opensource.org/licenses/AGPL-3.0
441577
[site]: https://justin.hartman.me
442578
[email]: mailto:[email protected]?subject=Github+Contact
443579
[license]: LICENSE
444580
[404-template]: https://ws2.sinaimg.cn/large/006tKfTcly1fr3klp9lp9g30hs0a1gyv.gif
445-
[todo]: TODO.md
446581
[CONTRIBUTING]: CONTRIBUTING.md
447582
[COC]: CODE_OF_CONDUCT.md
448583
[changelog]: CHANGELOG.md
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)