Public | Automated Build

Last pushed: 11 hours ago
Short Description
Docker image for running GitHub Pages / Jekyll projects
Full Description

Docker GitHub Pages

Docker image for running GitHub Pages / Jekyll projects.

Supported tags and respective Dockerfile links

What is GitHub Pages

GitHub Pages are public webpages hosted and published directly through your
GitHub repository.

How to use this image

This image makes it easy to run you GitHub Pages page locally while developing –
refreshing changes automatically as you make them. All you need to do is to mount
your page in a volume under /usr/src/app like this:

$ docker run -v "$PWD":/usr/src/app -p "4000:4000" starefossen/github-pages

And you Jekyll page with be available on http://localhost:4000.

Remember to add all the gems to your _config.yml file in order to get all the
different things to work correctly:

repository: your/repo

- jekyll-github-metadata
- jekyll-mentions
- jekyll-redirect-from
- jekyll-sitemap
- jemoji

Also, in order for the {{ site.github }} metadata variables to be poppulated
you need to set the JEKYLL_GITHUB_TOKEN environment variable with your GitHub

$ docker run \
  -v "$PWD":/usr/src/app \
  -e JEKYLL_GITHUB_TOKEN=my-github-token \
  -p "4000:4000" starefossen/github-pages

Image Variants

The starefossen/github-pages images come in two flavors, each designed for a
specific use case.


This is the defacto image. If you are unsure about what your needs are, you
probably want to use this one. It is designed to be used both as a throw away
container (mount your source code and start the container to start your app), as
well as the base to build other images off of.


This image makes building derivative images easier. For most use cases, creating
a Dockerfile in the base of your project directory with the line FROM starefossen/github-pages:onbuild will be enough to create a stand-alone image
for your project.


This Docker image is licensed under the MIT License.

Software contained in this image is licensed under the following:

Supported Docker versions

This image is officially supported on Docker version 1.6.1.

Support for older versions (down to 1.0) is provided on a best-effort basis.

User Feedback



If you have any problems with or questions about this image, please contact us
through a GitHub issue.


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
, 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.

Docker Pull Command
Source Repository

Comments (0)