Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bretfisher/jekyll-serve

Jekyll in a Docker Container For Easy SSG Development
https://github.com/bretfisher/jekyll-serve

docker docker-compose docker-image jekyll static-site-generator

Last synced: 7 days ago
JSON representation

Jekyll in a Docker Container For Easy SSG Development

Host: GitHub
URL: https://github.com/bretfisher/jekyll-serve
Owner: BretFisher
License: mit
Created: 2017-03-05T10:48:57.000Z (almost 8 years ago)
Default Branch: main
Last Pushed: 2023-03-07T07:06:15.000Z (almost 2 years ago)
Last Synced: 2025-01-19T12:07:37.180Z (14 days ago)
Topics: docker, docker-compose, docker-image, jekyll, static-site-generator
Language: Dockerfile
Size: 85 KB
Stars: 348
Watchers: 12
Forks: 122
Open Issues: 5
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt

Awesome Lists containing this project

README

# Jekyll in a Docker Container

[![GitHub Super-Linter](https://github.com/bretfisher/jekyll-serve/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter)
[![Docker Build](https://github.com/BretFisher/jekyll-serve/actions/workflows/call-docker-build.yaml/badge.svg)](https://github.com/BretFisher/jekyll-serve/actions/workflows/call-docker-build.yaml)

> But this has been done. Why not `docker run jekyll/jekyll`?

- I wanted two images, one for easy CLI (`bretfisher/jekyll`) and one for
easy local server for dev with sane defaults (`bretfisher/jekyll-serve`), which I use 90% of the time
- So you can start any Jekyll server with `docker-compose up`
- I wanted to dev on a local Jekyll site without having Jekyll installed on my host OS
- I wanted it to be as easy as possible to start
- I wanted current `amd64` and `arm64` images using official Ruby and Jekyll latest

> So, this does that.

Note [I have courses on Docker (including a Lecture on Jekyll in Docker)](https://www.bretfisher.com/courses).

:bangbang: :bangbang: :bangbang:

:warning: WARNING: :warning: This isn't meant to be a production image that you run a web server with. I don't do that with the Jekyll
CLI that comes with this image. Jekyll CLI generates
a static site that you can run with GitHub Pages, Netlify, or your own NGINX setup. Furthermore, I don't version
anything so these images will not run guaranteed versions of Ruby, Jekyll, etc. (which, if you're running a server,
should pin all versions usually.)

## Docker Images

| Image | Purpose | Example |
| ----- | ------- | ------- |
| [bretfisher/jekyll](https://hub.docker.com/r/bretfisher/jekyll/) | Runs Jekyll by default with no options, good for general CLI commands | `docker run -v $(pwd):/site bretfisher/jekyll new .` |
| [bretfisher/jekyll-serve](https://hub.docker.com/r/bretfisher/jekyll-serve/) | Runs Jekyll serve with sane defaults, good for local Jekyll site dev | `docker run -p 4000:4000 -v $(pwd):/site bretfisher/jekyll-serve` |

## Getting Started

Creating a site:

```shell
cd to empty directory
docker run -v $(pwd):/site bretfisher/jekyll new .
```

Start a local server with sane defaults listening on port 4000:

```shell
cd dir/of/your/jekyll/site
docker run -p 4000:4000 -v $(pwd):/site bretfisher/jekyll-serve
```

That's it!

Details: it will mount your current path into the containers `/site`, `bundle install` before running
`jekyll serve` to , serve it at `http://:4000`.

To make this even easier, copy `docker-compose.yml`
[from this repository](https://github.com/BretFisher/jekyll-serve/blob/master/docker-compose.yml)
to your jekyll site root. Then you'll only need to:

```shell
cd dir/of/your/jekyll/site
docker-compose up
```

## Known issues

1. `arm/v7` version (aka `armhf`) doesn't exist in this repository.
- Yes, `arm/v7` has become too difficult to support.
2. `alpine` version doesn't exist in this repository.
- Yes, not all Jekyll dependencies are built with `musl` support, so `glibc`-based images are now the only option (Debian, Ubuntu, etc).
3. RESOLVED as of Jekyll 4.3
~~`webrick` errors during startup.~~
- ~~As of April 2021, Ruby 3.0 is out, and Jekyll is still on 4.2 (released 12/2020). Jekyll 4.2 doesn't have `webrick` listed as a dependency, so we'll have to manually add it to Gemfile for now if you want to use Ruby 3.0.~~
~~Ruby 3.0 removed this bundled gems so you'll need to add them manually if you use them: `sdbm`, `webrick`, `net-telnet`, `xmlrpc`. Hopefully Jekyll 4.3 will have `webrick` listed as a Jekyll dependency (it is fixed in Jekyll master branch) so manually updating Gemfiles won't be needed.~~

## Q&A

### Q. What if I want to run other jekyll commands?

just add the jekyll options to the end of the `bretfisher/jekyll`:

```shell
docker run -v $(pwd):/site bretfisher/jekyll doctor
```

### Q. What if I want to build a site with Gemfile dependencies?

As your Jekyll site gets fancier, you'll need to add Jekyll plugins via Ruby's `Gemfile` and `bundle` CLI. You'll need to do a `bundle install` first before building your Jekyll site.

If you were using this repo's image, you could:

`docker run -v $(pwd):/site -it --entrypoint bash bretfisher/jekyll`

Then run your commands interactively:

```bash
bundle install --retry 5 --jobs 20
bundle exec jekyll build
```

Then your bind-mounted `_site` will be there on your host, built by Jekyll using your Gemfile Jekyll dependencies that were installed in that container.

If this is something you do often, you'll want to build your *own* image that already has your Ruby dependencies installed. Then when you run the `jekyll build` command, it'll have all the Gemfile dependencies it needs.

## License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.