Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Include a short description of the project, as well as information on how to use
the configurations and what Apache and browser versions are supported.
  • Loading branch information
alrra committed Nov 11, 2013
1 parent 00d3f63 commit 735c8f4
Showing 1 changed file with 58 additions and 3 deletions.
61 changes: 58 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,68 @@
# [Apache Server Configs](https://github.com/h5bp/server-configs-apache/)

## Contributing to this project
__Apache Server Configs__ is a collection of boilerplate configurations that
can help your server improve the web site's performance and security, while
also ensuring that resources are served with the correct content-type and are
accessible, if needed, even cross-domain.

Anyone and everyone is welcome to contribute. Please take a moment to review the
[guidelines for contributing](CONTRIBUTING.md).
## Usage

If you have access to the [main server configuration
file](http://httpd.apache.org/docs/current/configuring.html#main)
(usually called `httpd.conf`), you should add the logic from the `.htaccess`
file in, for example, a
[`<Directory>`](http://httpd.apache.org/docs/current/mod/core.html#directory)
section in the main configuration file. This is usually the recommended way, as
using `.htaccess` files [slows
down](http://httpd.apache.org/docs/current/howto/htaccess.html#when) Apache!

If you don't have access, which is quite common with hosting services, just put
the `.htaccess` file in the root of the website.

Also note that, some configurations won't have any effect if the appropriate
modules aren't enabled. So, in order for everything to work as intended, you
need to ensure the you have the following Apache modules
[enabled](https://github.com/h5bp/server-configs-apache/wiki/How-to-enable-Apache-modules):
* [`mod_autoindex.c` (autoindex_module)](http://httpd.apache.org/docs/current/mod/mod_autoindex.html)
* [`mod_deflate.c` (deflate_module)](http://httpd.apache.org/docs/current/mod/mod_deflate.html)
* [`mod_expires.c` (expires_module)](http://httpd.apache.org/docs/current/mod/mod_expires.html)
* [`mod_filter.c` (filter_module)](http://httpd.apache.org/docs/current/mod/mod_filter.html)
* [`mod_headers.c` (headers_module)](http://httpd.apache.org/docs/current/mod/mod_headers.html)
* [`mod_include.c` (include_module)](http://httpd.apache.org/docs/current/mod/mod_include.html)
* [`mod_mime.c` (mime_module)](http://httpd.apache.org/docs/current/mod/mod_mime.html)
* [`mod_rewrite.c` (rewrite_module)](http://httpd.apache.org/docs/current/mod/mod_rewrite.html)
* [`mod_setenvif.c` (setenvif_module)](http://httpd.apache.org/docs/current/mod/mod_setenvif.html)

For more detailed information on configuration files and how to use them, please
check the appropriate Apache documentation:

* http://httpd.apache.org/docs/current/configuring.html
* http://httpd.apache.org/docs/current/howto/htaccess.html


## Support

* #### __Apache v2.2.0+__

* #### __Browsers:__

* Chrome
* Firefox 4+
* Internet Explorer 8+
* Opera 12+
* Safari 5+


## Contributing

Anyone and everyone is welcome to contribute, but before you do, please take a
moment to review the [guidelines](CONTRIBUTING.md).

* [Bug reports](CONTRIBUTING.md#bugs)
* [Feature requests](CONTRIBUTING.md#features)
* [Pull requests](CONTRIBUTING.md#pull-requests)


## Acknowledgements

[Apache Server Configs](https://github.com/h5bp/server-configs-apache/) is
Expand All @@ -21,6 +75,7 @@ This project is currently maintained by:
|:---:|:---:|
| [Cătălin Mariș](http://twitter.com/alrra) |


## License

[Apache Server Configs](https://github.com/h5bp/server-configs-apache/) is
Expand Down

0 comments on commit 735c8f4

Please sign in to comment.