From 93aeb6d685d99ddde5b65b1466a532dc98a69380 Mon Sep 17 00:00:00 2001 From: Amir Pourmand Date: Fri, 14 Mar 2025 17:08:19 +0330 Subject: [PATCH] Update INSTALL.md (#3074) Again, I saw this version problem with current version of our docker image. Supposedly, there is some json package problem which I dealt with. But here is the overall solution to this problem for whoever is having it. --------- Co-authored-by: George <31376482+george-gca@users.noreply.github.com> --- INSTALL.md | 33 ++++++++++++++++++++++++++++++++- docker-compose.yml | 2 +- 2 files changed, 33 insertions(+), 2 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index f0ccca5..d8393aa 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -6,6 +6,7 @@ - [Local setup on Windows](#local-setup-on-windows) - [Local setup using Docker (Recommended)](#local-setup-using-docker-recommended) - [Build your own docker image](#build-your-own-docker-image) + - [Have Bugs on Docker Image?](#have-bugs-on-docker-image) - [Local Setup with Development Containers](#local-setup-with-development-containers) - [Local Setup (Legacy, no longer supported)](#local-setup-legacy-no-longer-supported) - [Deployment](#deployment) @@ -76,6 +77,36 @@ $ docker compose up --build If you want to use a specific docker version, you can do so by changing `latest` tag to `your_version` in `docker-compose.yaml`. For example, you might have created your website on `v0.10.0` and you want to stick with that. +### Have Bugs on Docker Image? + +Sometimes, there might be some bugs in the current docker image. It might be version mismatch or anything. If you want to debug and easily solve the problem for yourself you can do the following steps: + +``` +docker compose up -d +docker compose logs +``` + +Then you can see the bug! You can enter the container via this command: + +``` +docker compose exec -it jekyll /bin/bash +``` + +Then you can run the script: + +``` +./bin/entry_point.sh +``` + +You might see problems for package dependecy or something which is not available. You can fix it now by using + +``` +bundle install +./bin/entry_point.sh +``` + +Most likely, this will solve the problem but it shouldn't really happen. So, please open a bug report for us. + ## Local Setup with Development Containers `al-folio` supports [Development Containers](https://containers.dev/supporting). @@ -211,7 +242,7 @@ If you installed **al-folio** as described above, you can manually update your c # Assuming the current directory is $ git remote add upstream https://github.com/alshedivat/al-folio.git $ git fetch upstream -$ git rebase v0.14.2 +$ git rebase v0.14.3 ``` If you have extensively customized a previous version, it might be trickier to upgrade. diff --git a/docker-compose.yml b/docker-compose.yml index 49ed238..dde293c 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,7 +1,7 @@ # this file uses prebuilt image in dockerhub services: jekyll: - image: amirpourmand/al-folio:v0.14.2 + image: amirpourmand/al-folio:v0.14.3 build: . # uncomment these if you are having this issue with the build: # /usr/local/bundle/gems/jekyll-4.3.4/lib/jekyll/site.rb:509:in `initialize': Permission denied @ rb_sysopen - /srv/jekyll/.jekyll-cache/.gitignore (Errno::EACCES)