Skip to content

Commit

Permalink
Docs: Add full web.config example
Browse files Browse the repository at this point in the history
Fix #1100
  • Loading branch information
alrra committed Aug 10, 2018
1 parent 02d2c6a commit d447f03
Show file tree
Hide file tree
Showing 8 changed files with 55 additions and 20 deletions.
11 changes: 8 additions & 3 deletions packages/hint-content-type/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,9 @@ Note that:
common with hosting services), add the snippets in a `.htaccess`
file in the root of the web site/app.

For the complete set of configurations, not just for this rule, see
the [Apache server configuration related documentation][apache config].

</details>
<details><summary>How to configure IIS</summary>

Expand Down Expand Up @@ -379,8 +382,9 @@ Note that:
* The above snippet works with IIS 7+.
* You should use the above snippet in the `web.config` of your
application.
* For the complete set of configurations, not just for this rule, see
[this IIS server configuration related docs][IIS config].

For the complete set of configurations, not just for this rule,
see the [IIS server configuration related documentation][iis config].

</details>

Expand Down Expand Up @@ -459,13 +463,13 @@ And then activate it via the [`.hintrc`][hintrc] configuration file:
[required media type]: https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache#Referencing_a_cache_manifest_file
[server configs]: https://developer.mozilla.org/en-US/docs/Web/Security/Securing_your_site/Configuring_server_MIME_types
[hintrc]: https://webhint.io/docs/user-guide/further-configuration/hintrc-formats/
[IIS config]: https://webhint.io/docs/user-guide/server-configurations/iis/

<!-- Apache links -->

[addcharset]: https://httpd.apache.org/docs/current/mod/mod_mime.html#addcharset
[adddefaultcharset]: https://httpd.apache.org/docs/current/mod/core.html#adddefaultcharset
[addtype]: https://httpd.apache.org/docs/current/mod/mod_mime.html#addtype
[apache config]: https://webhint.io/docs/user-guide/server-configurations/apache/
[apache directory]: https://httpd.apache.org/docs/current/mod/core.html#directory
[how to enable apache modules]: https://github.com/h5bp/server-configs-apache/wiki/How-to-enable-Apache-modules
[htaccess is slow]: https://httpd.apache.org/docs/current/howto/htaccess.html#when
Expand All @@ -475,5 +479,6 @@ And then activate it via the [`.hintrc`][hintrc] configuration file:

<!-- IIS links -->

[iis config]: https://webhint.io/docs/user-guide/server-configurations/iis/
[mime.types iis]: https://support.microsoft.com/en-us/help/936496/description-of-the-default-settings-for-the-mimemap-property-and-for-t
[mimeMap]: https://docs.microsoft.com/en-us/iis/configuration/system.webserver/staticcontent/mimemap
12 changes: 9 additions & 3 deletions packages/hint-highest-available-document-mode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,9 @@ Note that:
common with hosting services), add the snippets in a `.htaccess`
file in the root of the web site/app.

For the complete set of configurations, not just for this rule, see
the [Apache server configuration related documentation][apache config].

</details>
<details><summary>How to configure IIS</summary>

Expand Down Expand Up @@ -335,8 +338,9 @@ Note that:
* The above snippet works with IIS 7+.
* You should use the above snippet in the `web.config` of your
application.
* For the complete set of configurations, not just for this rule, see
[this IIS server configuration related docs][IIS config].

For the complete set of configurations, not just for this rule,
see the [IIS server configuration related documentation][iis config].

</details>

Expand Down Expand Up @@ -407,11 +411,11 @@ And then activate it via the [`.hintrc`][hintrc] configuration file:
[doc modes]: https://msdn.microsoft.com/en-us/library/cc288325.aspx
[hintrc]: https://webhint.io/docs/user-guide/further-configuration/hintrc-formats/
[ie complications]: https://hsivonen.fi/doctype/#ie8
[IIS config]: https://webhint.io/docs/user-guide/server-configurations/iis/
[targeted browsers]: https://webhint.io/docs/user-guide/further-configuration/browser-context/

<!-- Apache links -->

[apache config]: https://webhint.io/docs/user-guide/server-configurations/apache/
[apache directory]: https://httpd.apache.org/docs/current/mod/core.html#directory
[header directive]: https://httpd.apache.org/docs/current/mod/mod_headers.html#header
[how to enable apache modules]: https://github.com/h5bp/server-configs-apache/wiki/How-to-enable-Apache-modules
Expand All @@ -421,4 +425,6 @@ And then activate it via the [`.hintrc`][hintrc] configuration file:
[mod_mime]: https://httpd.apache.org/docs/current/mod/mod_mime.html

<!-- IIS Links -->

[iis config]: https://webhint.io/docs/user-guide/server-configurations/iis/
[url rewrite]: https://docs.microsoft.com/en-us/iis/extensions/url-rewrite-module/using-the-url-rewrite-module
11 changes: 8 additions & 3 deletions packages/hint-http-cache/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,9 @@ Also note that:
common with hosting services), add the snippets in a `.htaccess`
file in the root of the web site/app.

For the complete set of configurations, not just for this rule, see
the [Apache server configuration related documentation][apache config].

</details>
<details><summary>How to configure IIS</summary>

Expand Down Expand Up @@ -333,8 +336,9 @@ Important notes:
* The above snippet works with IIS 7+.
* You should use the above snippet in the `web.config` of your
application.
* For the complete set of configurations, not just for this rule, see
[this IIS server configuration related docs][IIS config].

For the complete set of configurations, not just for this rule,
see the [IIS server configuration related documentation][iis config].

</details>

Expand Down Expand Up @@ -435,13 +439,13 @@ And then activate it via the [`.hintrc`][hintrc] configuration file:
[google http caching]: https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/http-caching
[hintrc]: https://webhint.io/docs/user-guide/further-configuration/hintrc-formats/
[how well you know the web]: https://youtu.be/vAgKZoGIvqs?t=12m20s
[IIS config]: https://webhint.io/docs/user-guide/server-configurations/iis/
[maxage0]: http://httparchive.org/about.php#maxage0
[maxage0 image]: https://chart.googleapis.com/chart?chd=t:-1%7C49,51,100,100,51,51,51,51,51,51,100,50,50,50,50,50,50,50,51,51,51,50,50,50&chxl=0:%7C+%7C12%2F16%7C+%7C1%2F17%7C+%7C2%2F17%7C+%7C3%2F17%7C+%7C4%2F17%7C+%7C5%2F17%7C+%7C6%2F17%7C+%7C7%2F17%7C+%7C8%2F17%7C+%7C9%2F17%7C+%7C10%2F17%7C+%7C11%2F17&chxt=x&chs=600x300&cht=lxy&chco=184852&chxs=0,676767,11.5,0,lt,676767&chxtc=0,8&chm=N**+%,184852,0,1::2,12,,h::8&chds=0,100,0,100&chts=184852,24&chtt=Cacheable+Resources&chls=2&chma=5,5,5,25
[revving files]: https://www.stevesouders.com/blog/2008/08/23/revving-filenames-dont-use-querystring/

<!-- Apache links -->

[apache config]: https://webhint.io/docs/user-guide/server-configurations/apache/
[apache directory]: https://httpd.apache.org/docs/current/mod/core.html#directory
[expiresactive]: https://httpd.apache.org/docs/current/mod/mod_expires.html#expiresactive
[expiresbytype]: https://httpd.apache.org/docs/current/mod/mod_expires.html#expiresbytype
Expand All @@ -456,3 +460,4 @@ And then activate it via the [`.hintrc`][hintrc] configuration file:
<!-- IIS links -->

[clientcache iis]: https://docs.microsoft.com/en-us/iis/configuration/system.webserver/staticcontent/clientcache
[iis config]: https://webhint.io/docs/user-guide/server-configurations/iis/
11 changes: 8 additions & 3 deletions packages/hint-http-compression/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -790,6 +790,9 @@ Also note that:
common with hosting services), add the snippets in a `.htaccess`
file in the root of the web site/app.

For the complete set of configurations, not just for this rule, see
the [Apache server configuration related documentation][apache config].

</details>
<details><summary>How to configure IIS</summary>

Expand Down Expand Up @@ -964,8 +967,9 @@ Note that:
* The above snippet works with IIS 7+.
* You should use the above snippet in the `web.config` of your
application.
* For the complete set of configurations, not just for this rule, see
[this IIS server configuration related docs][IIS config].

For the complete set of configurations, not just for this rule,
see the [IIS server configuration related documentation][iis config].

</details>

Expand Down Expand Up @@ -1065,7 +1069,6 @@ And then activate it via the [`.hintrc`][hintrc] configuration file:
[gzip is not enough]: https://www.youtube.com/watch?v=whGwm0Lky2s
[gzip ratio]: https://www.youtube.com/watch?v=Mjab_aZsdxw&t=24s
[hintrc]: https://webhint.io/docs/user-guide/further-configuration/hintrc-formats/
[IIS config]: https://webhint.io/docs/user-guide/server-configurations/iis/
[unship sdch]: https://groups.google.com/a/chromium.org/forum/#!topic/blink-dev/nQl0ORHy7sw
[wdmsc]: https://whatdoesmysitecost.com/
[zopfli blog post]: https://developers.googleblog.com/2013/02/compress-data-more-densely-with-zopfli.html
Expand All @@ -1074,6 +1077,7 @@ And then activate it via the [`.hintrc`][hintrc] configuration file:
<!-- Apache links -->

[addoutputfilterbytype]: https://httpd.apache.org/docs/2.4/mod/mod_filter.html#addoutputfilterbytype
[apache config]: https://webhint.io/docs/user-guide/server-configurations/apache/
[apache directory]: https://httpd.apache.org/docs/current/mod/core.html#directory
[how to enable apache modules]: https://github.com/h5bp/server-configs-apache/wiki/How-to-enable-Apache-modules
[htaccess is slow]: https://httpd.apache.org/docs/current/howto/htaccess.html#when
Expand All @@ -1086,4 +1090,5 @@ And then activate it via the [`.hintrc`][hintrc] configuration file:

<!-- IIS links -->

[iis config]: https://webhint.io/docs/user-guide/server-configurations/iis/
[urlcompression]: https://docs.microsoft.com/en-us/iis/configuration/system.webserver/urlcompression
10 changes: 7 additions & 3 deletions packages/hint-no-html-only-headers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,8 @@ Note that:
common with hosting services), add the snippets in a `.htaccess`
file in the root of the web site/app.

For the complete set of configurations, not just for this rule, see
the [Apache server configuration related documentation][apache config].
</details>
<details><summary>How to configure IIS</summary>

Expand Down Expand Up @@ -195,8 +197,9 @@ Note that:
* The above snippet works with IIS 7+.
* You should use the above snippet in the `web.config` of your
application.
* For the complete set of configurations, not just for this rule, see
[this IIS server configuration related docs][IIS config].

For the complete set of configurations, not just for this rule,
see the [IIS server configuration related documentation][iis config].

</details>

Expand Down Expand Up @@ -260,14 +263,15 @@ And then activate it via the [`.hintrc`][hintrc] configuration file:

<!-- Apache links -->

[apache config]: https://webhint.io/docs/user-guide/server-configurations/apache/
[apache directory]: https://httpd.apache.org/docs/current/mod/core.html#directory
[hintrc]: https://webhint.io/docs/user-guide/further-configuration/hintrc-formats/
[how to enable apache modules]: https://github.com/h5bp/server-configs-apache/wiki/How-to-enable-Apache-modules
[htaccess is slow]: https://httpd.apache.org/docs/current/howto/htaccess.html#when
[IIS config]: https://webhint.io/docs/user-guide/server-configurations/iis/
[main apache conf file]: https://httpd.apache.org/docs/current/configuring.html#main
[mod_headers]: https://httpd.apache.org/docs/current/mod/mod_headers.html

<!-- IIS links -->

[iis config]: https://webhint.io/docs/user-guide/server-configurations/iis/
[url rewrite]: https://docs.microsoft.com/en-us/iis/extensions/url-rewrite-module/using-the-url-rewrite-module
11 changes: 8 additions & 3 deletions packages/hint-strict-transport-security/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,9 @@ Note that:
common with hosting services), add the snippets in a `.htaccess`
file in the root of the web site/app.

For the complete set of configurations, not just for this rule, see
the [Apache server configuration related documentation][apache config].

</details>
<details><summary>How to configure IIS</summary>

Expand All @@ -170,8 +173,9 @@ Note that:
* The above snippet works with IIS 7+.
* You should use the above snippet in the `web.config` of your
application.
* For the complete set of configurations, not just for this rule, see
[this IIS server configuration related docs][IIS config].

For the complete set of configurations, not just for this rule,
see the [IIS server configuration related documentation][iis config].

</details>

Expand Down Expand Up @@ -259,7 +263,6 @@ And then activate it via the [`.hintrc`][hintrc] configuration file:

[hsts cheat sheat]: https://www.owasp.org/index.php/HTTP_Strict_Transport_Security_Cheat_Sheet
[hsts wiki]: https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security
[IIS config]: https://webhint.io/docs/user-guide/server-configurations/iis/
[pineapple]: https://www.troyhunt.com/the-beginners-guide-to-breaking-website/
[preload form]:https://hstspreload.org/
[preload list]:https://cs.chromium.org/codesearch/f/chromium/src/net/http/transport_security_state_static.json
Expand All @@ -270,6 +273,7 @@ And then activate it via the [`.hintrc`][hintrc] configuration file:

<!-- Apache links -->

[apache config]: https://webhint.io/docs/user-guide/server-configurations/apache/
[apache directory]: https://httpd.apache.org/docs/current/mod/core.html#directory
[header directive]: https://httpd.apache.org/docs/current/mod/mod_headers.html#header
[how to enable apache modules]: https://github.com/h5bp/server-configs-apache/wiki/How-to-enable-Apache-modules
Expand All @@ -281,3 +285,4 @@ And then activate it via the [`.hintrc`][hintrc] configuration file:
<!-- IIS links -->

[customHeader]: https://docs.microsoft.com/en-us/iis/configuration/system.webserver/httpprotocol/customheaders/
[iis config]: https://webhint.io/docs/user-guide/server-configurations/iis/
3 changes: 3 additions & 0 deletions packages/hint/docs/user-guide/server-configurations/apache.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Basic server configuration for Apache

TODO
6 changes: 4 additions & 2 deletions packages/hint/docs/user-guide/server-configurations/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ technologies, they only contain the relevant portions.
The following are examples of basic server configurations to help you
get started:

* [IIS][IIS config]
* [Apache][apache config]
* [IIS][iis config]

<!-- Link labels: -->

[IIS config]: ./iis.md
[apache config]: ./apache.md
[iis config]: ./iis.md

0 comments on commit d447f03

Please sign in to comment.