Skip to content

Commit

Permalink
add instructions for using docker to run local/dev version of site
Browse files Browse the repository at this point in the history
  • Loading branch information
obigriffith committed Aug 23, 2024
1 parent e8e997f commit 97fd2b3
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]: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

Expand Down
2 changes: 1 addition & 1 deletion docker/0.0.1/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
################################################################################
##################### Set Inital Image to work from ############################
##################### Set Initial Image to work from ############################

FROM ruby:3.1.2

Expand Down

0 comments on commit 97fd2b3

Please sign in to comment.