diff --git a/README.md b/README.md index b9707d6..d4158bd 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,21 @@ To install this site locally run the following commands: The site should now be running on localhost port 4000. Changes to files will show up interactively on localhost:4000 -**Note:** The _config.yml file is only read during the initial serve, changing this file will require re-running step 4 for changes to appear. +**Note:** The _config.yml and _config_dev.yml files are only read during the initial serve, changing these files will require re-running step 4 for changes to appear. + +## Docker Installation + +To install the site locally with docker run the following commands: + +1. Clone the repo `$ git clone git@github.com:griffithlab/griffithlab.org.git` +2. Pull the docker image `$ docker pull griffithlab/griffithlabdev:0.0.1` +3. Run the docker `$ docker run -p 4000:4000 -v ~/git/griffithlab.org/:/opt/git/griffithlab.org -it griffithlab/griffithlabdev:0.0.2` + +Make sure that the above command has correct path to cloned git repo (The first part specified with -v option). The site should now be running on localhost port 4000. Changes to files will show up interactively on localhost:4000. + +**Note:** The Dockerfile for this image is maintained in [this repo](https://github.com/griffithlab/griffithlab.org/blob/master/docker/) and the image itself is hosted on [dockerhub](https://hub.docker.com/r/griffithlab/griffithlabdev). + +**Note:** The _config.yml and _config_dev.yml files are only read during the initial serve, changing this file will require re-running step 3 for changes to appear. ## License diff --git a/docker/0.0.1/Dockerfile b/docker/0.0.1/Dockerfile index 39c5632..af27199 100644 --- a/docker/0.0.1/Dockerfile +++ b/docker/0.0.1/Dockerfile @@ -1,5 +1,5 @@ ################################################################################ -##################### Set Inital Image to work from ############################ +##################### Set Initial Image to work from ############################ FROM ruby:3.1.2