Skip to content

Commit

Permalink
Fix usage (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
moul committed Jan 11, 2016
1 parent ae82f38 commit 07e220e
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
Readthedocs in Docker
=====================
# Readthedocs in Docker

A Docker container of Readthedocs (RTD).

Usage
-----
## Usage

Run as a daemon :
Run using docker-compose:

docker run -d -p 8000:8000 moul/readthedocs
* start a readthedocs container + its dependencies (postgresql, elasticsearch and redis)

Run in foreground :
```console
$ docker-compose run --service-ports --rm readthedocs
# or
$ make run
```

docker run -it -p 8000:8000 moul/readthedocs
---

Run in debug mode (bash) :

make run
# or
docker run -it --rm --entrypoint=bash moul/readthedocs

Build the container from sources :

docker build -t moul/readthedocs .
# or
make build
## License

MIT

0 comments on commit 07e220e

Please sign in to comment.