Skip to content

Commit 93aeb6d

Browse files
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 <[email protected]>
1 parent 1dc670b commit 93aeb6d

File tree

2 files changed

+33
-2
lines changed

2 files changed

+33
-2
lines changed

INSTALL.md

+32-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
- [Local setup on Windows](#local-setup-on-windows)
77
- [Local setup using Docker (Recommended)](#local-setup-using-docker-recommended)
88
- [Build your own docker image](#build-your-own-docker-image)
9+
- [Have Bugs on Docker Image?](#have-bugs-on-docker-image)
910
- [Local Setup with Development Containers](#local-setup-with-development-containers)
1011
- [Local Setup (Legacy, no longer supported)](#local-setup-legacy-no-longer-supported)
1112
- [Deployment](#deployment)
@@ -76,6 +77,36 @@ $ docker compose up --build
7677
7778
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.
7879

80+
### Have Bugs on Docker Image?
81+
82+
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:
83+
84+
```
85+
docker compose up -d
86+
docker compose logs
87+
```
88+
89+
Then you can see the bug! You can enter the container via this command:
90+
91+
```
92+
docker compose exec -it jekyll /bin/bash
93+
```
94+
95+
Then you can run the script:
96+
97+
```
98+
./bin/entry_point.sh
99+
```
100+
101+
You might see problems for package dependecy or something which is not available. You can fix it now by using
102+
103+
```
104+
bundle install
105+
./bin/entry_point.sh
106+
```
107+
108+
Most likely, this will solve the problem but it shouldn't really happen. So, please open a bug report for us.
109+
79110
## Local Setup with Development Containers
80111

81112
`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
211242
# Assuming the current directory is <your-repo-name>
212243
$ git remote add upstream https://github.com/alshedivat/al-folio.git
213244
$ git fetch upstream
214-
$ git rebase v0.14.2
245+
$ git rebase v0.14.3
215246
```
216247

217248
If you have extensively customized a previous version, it might be trickier to upgrade.

docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# this file uses prebuilt image in dockerhub
22
services:
33
jekyll:
4-
image: amirpourmand/al-folio:v0.14.2
4+
image: amirpourmand/al-folio:v0.14.3
55
build: .
66
# uncomment these if you are having this issue with the build:
77
# /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)

0 commit comments

Comments
 (0)