From 264c489708525c944b00c9e0fecd312811b25d94 Mon Sep 17 00:00:00 2001 From: "Jacob V. Rasmussen" Date: Sun, 30 Jun 2024 16:52:12 +0200 Subject: [PATCH] Update readme with docker info The readme now includes a set of development setups for running the site locally in a docker container. --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index a2499c0..939cd35 100644 --- a/README.md +++ b/README.md @@ -23,3 +23,34 @@ This has been tested succesfully in early 2024 on Ubuntu 22.04 LTS with APT inst cd osaawebsite bundle install bundle exec jekyll serve + +#### Docker test server on linux + + docker run \ + --entrypoint sh -c "chown -R jekyll /usr/gem/ && jekyll serve" \ + -p 4000:4000 \ + -v $PWD:/srv/jekyll \ + --env site_name=osaawebsite \ + --name osaawebsite \ + --pull missing -i false \ + jekyll/jekyll + +Connect to http://localhost:4000/ to view the site. +The jekyll server will automatically rebuild the site, when md / html files are updated. +If the config in _config.yml is changed, the container need to be restarted. + +#### Docker setup on windows + + docker run \ + --entrypoint sh -c "chown -R jekyll /usr/gem/ && jekyll serve" \ + -p 4000:4000 \ + -v %CD%:/srv/jekyll \ + --env site_name=osaawebsite \ + --env MSYS_NO_PATCHCONV=1 \ + --name osaawebsite \ + --pull missing -i false \ + jekyll/jekyll + +Connect to http://localhost:4000/ to view the site. +The jekyll server will automatically rebuild the site, when md / html files are updated. +If the config in _config.yml is changed, the container need to be restarted.