diff --git a/README.DOCKER.md b/README.DOCKER.md new file mode 100644 index 000000000..356ac398a --- /dev/null +++ b/README.DOCKER.md @@ -0,0 +1,12 @@ +# Running Homebrewery via Docker + +The repo includes a Dockerfile and a docker-compose.yml file. + +To run the application via docker-compose.yml: +`docker-compose up -d` + +To stop the application: +`docker-compose down` + +To stop the application and remove all data: +`docker-compose down -v` diff --git a/README.md b/README.md index 7922df074..0d8fba091 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,10 @@ Fourth, you will need to install the program and run it using the two commands: You should now be able to go to [http://localhost:8000](http://localhost:8000) in your browser and use the Homebrewery offline. +### Running the application via Docker + +Please see the docs here: [README.DOCKER.md](./README.DOCKER.md) + ### Standalone PHB Stylesheet If you just want the stylesheet that is generated to make pages look like they are from the Player's Handbook, you will find it in the [phb.standalone.css](./phb.standalone.css) file.