Skip to content

Commit

Permalink
Add httpd docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yosifkit committed Nov 5, 2014
1 parent bbf2658 commit 8e367ed
Show file tree
Hide file tree
Showing 5 changed files with 133 additions and 0 deletions.
1 change: 1 addition & 0 deletions httpd/README-short.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The Apache HTTP Server Project
84 changes: 84 additions & 0 deletions httpd/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
# Supported tags and respective `Dockerfile` links

- [`2.2.29`, `2.2` (*2.2/Dockerfile*)](https://github.com/docker-library/httpd/blob/79fef78cd5440f55d181cfb5a9ababbc0c01ce4a/2.2/Dockerfile)
- [`2.4.10`, `2.4`, `2`, `latest` (*2.4/Dockerfile*)](https://github.com/docker-library/httpd/blob/79fef78cd5440f55d181cfb5a9ababbc0c01ce4a/2.4/Dockerfile)

For more information about this image and its history, please see the [relevant
manifest file
(`library/httpd`)](https://github.com/docker-library/official-images/blob/master/library/httpd)
in the [`docker-library/official-images` GitHub
repo](https://github.com/docker-library/official-images).

# What is httpd?

The Apache HTTP Server, colloquially called Apache, is a Web server application
notable for playing a key role in the initial growth of the World Wide Web.
Originally based on the NCSA HTTPd server, development of Apache began in early
1995 after work on the NCSA code stalled. Apache quickly overtook NCSA HTTPd as
the dominant HTTP server, and has remained the most popular HTTP server in use
since April 1996.

> [wikipedia.org/wiki/Apache_HTTP_Server](http://en.wikipedia.org/wiki/Apache_HTTP_Server)
![logo](https://raw.githubusercontent.com/docker-library/docs/master/httpd/logo.png)

# How to use this image.

This image only contains Apache httpd with the defaults from upstream. There is
no PHP installed, but it should not be hard to extend. On the other hand, of you
just want PHP with Apache httpd see the [PHP
image](https://registry.hub.docker.com/_/php/) and look at the `-apache` tags.
If you want to run a simple HTML server, add a simple Dockerfile to your project
where `public-html/` is the directory containing all your HTML.

### Create a `Dockerfile` in your project

FROM httpd:2.4
COPY ./public-html/ /usr/local/apache2/htdocs/

Then, run the commands to build and run the Docker image:

docker build -t my-apache2 .
docker run -it --rm --name my-running-app my-apache2

### Without a `Dockerfile`

If you don't want to include a `Dockerfile` in your project, it is sufficient to
do the following:

docker run -it --rm --name my-apache-app -v "$(pwd)":/usr/local/apache2/htdocs/ httpd:2.4

### Configuration

To customize the configuration of the httpd server, just `COPY` your custom
configuration in as `/usr/local/apache2/conf/httpd.conf`.

FROM httpd:2.4
COPY ./my-httpd.conf /usr/local/apache2/conf/httpd.conf

# License

View [license information](https://www.apache.org/licenses/) for the software
contained in this image.

# User Feedback

## Issues

If you have any problems with or questions about this image, please contact us
through a [GitHub issue](https://github.com/docker-library/httpd/issues).

You can also reach many of the official image maintainers via the
`#docker-library` IRC channel on [Freenode](https://freenode.net).

## Contributing

You are invited to contribute new features, fixes, or updates, large or small;
we are always thrilled to receive pull requests, and do our best to process them
as fast as we can.

Before you start to code, we recommend discussing your plans
through a [GitHub issue](https://github.com/docker-library/httpd/issues), especially for more ambitious
contributions. This gives other contributors a chance to point you in the right
direction, give you feedback on your design, and help you find out if someone
else is working on the same thing.
46 changes: 46 additions & 0 deletions httpd/content.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# What is httpd?

The Apache HTTP Server, colloquially called Apache, is a Web server application
notable for playing a key role in the initial growth of the World Wide Web.
Originally based on the NCSA HTTPd server, development of Apache began in early
1995 after work on the NCSA code stalled. Apache quickly overtook NCSA HTTPd as
the dominant HTTP server, and has remained the most popular HTTP server in use
since April 1996.

> [wikipedia.org/wiki/Apache_HTTP_Server](http://en.wikipedia.org/wiki/Apache_HTTP_Server)
%%LOGO%%

# How to use this image.

This image only contains Apache httpd with the defaults from upstream. There is
no PHP installed, but it should not be hard to extend. On the other hand, of you
just want PHP with Apache httpd see the [PHP
image](https://registry.hub.docker.com/_/php/) and look at the `-apache` tags.
If you want to run a simple HTML server, add a simple Dockerfile to your project
where `public-html/` is the directory containing all your HTML.

### Create a `Dockerfile` in your project

FROM httpd:2.4
COPY ./public-html/ /usr/local/apache2/htdocs/

Then, run the commands to build and run the Docker image:

docker build -t my-apache2 .
docker run -it --rm --name my-running-app my-apache2

### Without a `Dockerfile`

If you don't want to include a `Dockerfile` in your project, it is sufficient to
do the following:

docker run -it --rm --name my-apache-app -v "$(pwd)":/usr/local/apache2/htdocs/ httpd:2.4

### Configuration

To customize the configuration of the httpd server, just `COPY` your custom
configuration in as `/usr/local/apache2/conf/httpd.conf`.

FROM httpd:2.4
COPY ./my-httpd.conf /usr/local/apache2/conf/httpd.conf
2 changes: 2 additions & 0 deletions httpd/license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
View [license information](https://www.apache.org/licenses/) for the software
contained in this image.
Binary file added httpd/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8e367ed

Please sign in to comment.