• Stars
    star
    186
  • Rank 202,928 (Top 5 %)
  • Language
    Shell
  • License
    MIT License
  • Created about 9 years ago
  • Updated over 4 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

:octocat: ๐Ÿณ Alpine Docker Image for GitHub Pages and Jekyll powered sites

Alpine Docker GitHub Pages Image Layers

Alpine Docker image for running GitHub Pages / Jekyll projects. Only 70 MB.

Demo using GitHub Page on Docker

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 your 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 -it --rm -v "$PWD":/usr/src/app -p "4000:4000" starefossen/github-pages

Your Jekyll page will 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

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

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

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

Docker compose

If you want to use Docker Compose instead, you can move a lot of the options into a docker-compose.yml at the root of your project:

version: '3'
services:
  jekyll:
    image: starefossen/github-pages
    environment:
      - "JEKYLL_GITHUB_TOKEN:${JEKYLL_GITHUB_TOKEN}"
    ports:
      - "4000:4000"
    volumes:
      - ./:/usr/src/app
    tty: true

Then start the container with docker-compose up.

Slow filesystem issues in Docker for Mac

When running this image in Docker for Mac you might experience slow page generation times. This is due to some limitations in the Docker for Mac filesystem integration. Changing the volume configuration to -v "$PWD":/usr/src/app:delegated will massively improve the page generation time, at the cost of delaying the generated files showing up in your host system slightly. In case you don't even need the generated pages on your host system, you can also exclude the _site/ folder completely from being mounted by adding a container-only volume: -v site:/usr/src/app/_site.

Image Variants

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

starefossen/github-pages:<version>

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.

starefossen/github-pages:onbuild

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.

License

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

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

User Feedback

Documentation

Issues

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

Contributing

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

More Repositories

1

docker-ruby-node

๐Ÿณ Alpine Docker Image with latest versions of Ruby, Node.js and yarn installed. This Docker Image is actively maintained and updated regularly.
Dockerfile
79
star
2

docker-pgrouting

๐Ÿณ Docker Image for pgRouting with PostGIS and official Postgres Docker Image
Shell
33
star
3

node-nrk

๐Ÿ“บ Node.JS wrapper for NRK.no APIs
JavaScript
18
star
4

prlctl-ssh

๐Ÿ“ก Parallels desktop command line utility for open a new SSH connection to a given virtual machine
Shell
14
star
5

dotfiles

๐Ÿพ All of my configuration files for all the things
Vim Script
12
star
6

node-skyss

๐ŸšŒ Node.JS wrapper for Skyss.no APIs
JavaScript
11
star
7

awesome-rants

๐Ÿ˜Ž A curated list of awesome developer and software rants
11
star
8

docker-node-imagemagick

๐Ÿณ Docker Image for Node.js with optimised ImageMagick
Shell
8
star
9

m3u-to-mp4

๐ŸŽฅ Bulk record m3u (or m3u8) playlists to mp4 files using ffmpeg
Shell
8
star
10

docker-gifsicle

๐Ÿณ Docker Image for gifsicle โ€“ create, manipulate, and optimize GIF images and animations
Shell
7
star
11

node-express-health

๐Ÿข ๐Ÿš€ Health checking route for Express.js applications
JavaScript
7
star
12

slack-jira

๐Ÿš€ ๐Ÿ’ฌ Create and manage JIRA issues directly from Slack
JavaScript
7
star
13

mov-to-gif

๐ŸŽฅ Bulk convert videos to gifs using FFmpeg and Gifsicle
Shell
6
star
14

prlctl-usb

๐Ÿ“ก USB connection utility for Parallels desktop
Shell
5
star
15

nrk-tv-cli

๐Ÿ“บ Command line client for interacting with TV programs from the Norwegian Broadcasting Corporation (NRK)
JavaScript
5
star
16

node-rema-ae-api

Node.js wrapper for the Rema 1000 "ร†" app API
5
star
17

osx

๐Ÿ’ป Mac OS X build configurations
Shell
4
star
18

jenkins-monitor

๐Ÿ‘ด Jenkins Monitor and Alert for Node.JS CI โœจ ๐Ÿข ๐Ÿš€ โœจ
JavaScript
4
star
19

docker-wildfly-prometheus

Docker Wildfly with Prometheus metrics using `jmx_exporter`
4
star
20

node-passord

๐Ÿ” Memorable password, and codeword, for nativ Norwegian speaking users inspired by reference codes from BankID pรฅ Mobil
JavaScript
4
star
21

docker-transporter

๐Ÿณ Docker Image for Compose Transporter
4
star
22

dvm

๐Ÿณ Docker Version Manager โ€“ dvm
Shell
3
star
23

atb-sanntid

๐ŸšŒ Rewritten real-time API for AtB.no
PHP
3
star
24

starefossen.github.com

โœจ Random thoughts on development and stuff
CSS
3
star
25

docker-aspell

๐Ÿณ Docker image for running GNU Aspell spell checking
3
star
26

commit-message-ci

๐Ÿต Simple CI server to validate the formatting of git commit messages
JavaScript
3
star
27

node-express-project-x

๐Ÿข ๐Ÿš€ X-Project headers for your Express.js applications
JavaScript
3
star
28

cilium-workshop

Cilium Workshop for NDCOslo 2022
3
star
29

node-slackr

Send incoming Slack messages like a boss!
JavaScript
3
star
30

node-express-cors

๐Ÿข ๐Ÿš€ Cross-origin resource sharing headers middleware for Express.js applications
JavaScript
2
star
31

node-rand-path

๐Ÿข ๐Ÿš€ Dead simple random path generator
JavaScript
2
star
32

docker-iojs-imagemagick

๐Ÿณ Docker Image for io.js with optimised ImageMagick
Shell
2
star
33

node-async-each-map

๐Ÿข ๐Ÿš€ Dependency free async each, map, and reduce written in ES6 package for Node.js
JavaScript
2
star
34

node-http-error

๐Ÿข ๐Ÿš€ HTTP aware error class for all your Node.js applications
JavaScript
2
star
35

wercker-npm-publish

:shipit: Publishing package to NPM through Wercker CI
1
star
36

docker-pgbouncer

๐Ÿณ Docker Image for PgBouncer
1
star
37

node-docker-boilerplate

๐Ÿณ ๐Ÿข ๐Ÿš€ Boilerplate project for Node.js in a Docker environment
1
star
38

yolo-octo-ninja

JavaScript
1
star
39

maps-of-norway

Series of physical maps of Norway as GeoJSON feature collections
1
star
40

tf-k8s-iscsi-pvc

Terraform Module to Create ISCSI backed PVC
HCL
1
star
41

aws-iot-coffee-button

๐Ÿš€ AWS IoT HipChat / Slack Coffebutton
JavaScript
1
star
42

node-grunt-example

Example project with Grunt build-configuration.
JavaScript
1
star
43

fra-barnehagen

โœจ Download documents from the kindergarden and email them
JavaScript
1
star
44

jenkins-k8s-demo

Jenkins on Kubernetes
1
star
45

testing-node-drivers

๐Ÿ’ฅ Testing Node.JS drivers with external dependencies
Shell
1
star
46

Slackly

๐Ÿ’ฌ Interface for Sprint.ly through Slack slash commands
CoffeeScript
1
star
47

256-SoG

256 Shades of Gray Web Site
JavaScript
1
star
48

skyss-cli

๐ŸšŒ Command line client for interacting with stops and routes from Skyss.no APIs
JavaScript
1
star
49

opsys_oving3

TDT4186 Operativsystemer, ร˜ving 3
Java
1
star
50

mips-processor

MIPS processor written in VHDL.
VHDL
1
star
51

docker-sslmate

๐Ÿณ Docker Image for SSL Mate command line API
Shell
1
star
52

tannlege.narvik.no

Website for "Tannlegene i Sentrumsgรฅrden" in Narvik, Norway
HTML
1
star
53

skyss.api

[DEPRECATED] Skyss sitt udokumenterte API
1
star
54

open-source-policy

This repository contains the official Open Source Policy of The Norwegian Trekking Association (DNT)
1
star
55

mpeg-to-gif

Vagrant virtual machine ready for converting mpeg mvoies to gifs
Ruby
1
star
56

compilers

My exercise solutions to Compilers Principles, Techniques, and Tools by Aho Lam Sethi Ullman (Second Edition)
1
star
57

literate-readme-test

Test project to check out if or how a literate README file would work
CoffeeScript
1
star
58

gitbook-test

Testing GitBook
1
star
59

node-express-influx-stats

Express.js stats aggregation to InfluxDB
1
star
60

mengenlehreuhr

Mengenlehreuhr implementation in HTML, CSS, and JavaScript
JavaScript
1
star
61

bergis

๐Ÿซ Interactive map of public schools in Bergen, Norway
JavaScript
1
star
62

github-release-watch

Watch GitHub repositories for new releases
1
star
63

jenkins-github-status

๐Ÿ‘ด Jenkins GitHub Build Status for Node.JS CI โœจ ๐Ÿข ๐Ÿš€ โœจ
JavaScript
1
star
64

flyttesalg

Kristin og Hans Kristian flytter fra T-Town. Alle mรธblene skal ut og selges billig!
JavaScript
1
star
65

bootflat

Boot* Blog Tempate using Bootflat and Bootstrap
CSS
1
star
66

status-api

๐Ÿ”ฅ Service status API
JavaScript
1
star
67

numerics-k8s-metrics

Kubernetes Metrics for Numerics
JavaScript
1
star
68

tibber-go

Go API for for Tibber
1
star