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>
This commit is contained in:
parent
1dc670b02e
commit
93aeb6d685
33
INSTALL.md
33
INSTALL.md
@ -6,6 +6,7 @@
|
|||||||
- [Local setup on Windows](#local-setup-on-windows)
|
- [Local setup on Windows](#local-setup-on-windows)
|
||||||
- [Local setup using Docker (Recommended)](#local-setup-using-docker-recommended)
|
- [Local setup using Docker (Recommended)](#local-setup-using-docker-recommended)
|
||||||
- [Build your own docker image](#build-your-own-docker-image)
|
- [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 with Development Containers](#local-setup-with-development-containers)
|
||||||
- [Local Setup (Legacy, no longer supported)](#local-setup-legacy-no-longer-supported)
|
- [Local Setup (Legacy, no longer supported)](#local-setup-legacy-no-longer-supported)
|
||||||
- [Deployment](#deployment)
|
- [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.
|
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
|
## Local Setup with Development Containers
|
||||||
|
|
||||||
`al-folio` supports [Development Containers](https://containers.dev/supporting).
|
`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 <your-repo-name>
|
# Assuming the current directory is <your-repo-name>
|
||||||
$ git remote add upstream https://github.com/alshedivat/al-folio.git
|
$ git remote add upstream https://github.com/alshedivat/al-folio.git
|
||||||
$ git fetch upstream
|
$ 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.
|
If you have extensively customized a previous version, it might be trickier to upgrade.
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
# this file uses prebuilt image in dockerhub
|
# this file uses prebuilt image in dockerhub
|
||||||
services:
|
services:
|
||||||
jekyll:
|
jekyll:
|
||||||
image: amirpourmand/al-folio:v0.14.2
|
image: amirpourmand/al-folio:v0.14.3
|
||||||
build: .
|
build: .
|
||||||
# uncomment these if you are having this issue with the 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)
|
# /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)
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user