Add Dockerfile for easy installation on local machine

[pourmand1376]

I have added Dockerfile so that the installation process would be more straightforward.

• First clone the git directory (and go to that directory):

    git clone https://github.com/alshedivat/al-folio 
    cd al-folio 
  

• Then build docker image to download necessary modules and install them (just one time):

    docker build -t "mywebsite:Dockerfile" . 
  

• Then run website locally on port 8080:

  docker run --rm -v "$PWD:/srv/jekyll/" -p "8080:8080" \
                      -it mywebsite:Dockerfile bundler  \
                      exec jekyll serve --watch --port=8080 --host=0.0.0.0 
  

That's it! No need to install jekyll and ruby and gem packages and all that stuff.

[alshedivat]

thank you for this contribution! this should definitely help people get things up and running without running into issues with installing ruby. a couple of small requests before merge:

• update README: please add a description of how to run this locally (starting from installing docker to running the actual command) to Installation > Local setup section.
• add friendly aliases: the docker commands are pretty long; it would be awesome to add more user-friendly aliases to bin/aliases.sh that people can simply source bin/aliases.sh and then run something like docker-build-and-serve-al-folio command to build and serve the website locally. what do you think?

thanks again!

[pourmand1376]

Hi,
I updated the readme file. But, I didn't understand why you wanted to use aliases. I think the direct call is better. So, I added a file called run_docker.sh so you can run your website using bin/run_docker.sh. Much simpler.

[pourmand1376]

todo I noticed that there is an error which says that mmdc command not found. The image size would be very big if I install it. Do you mind?

[alshedivat]

thanks for making all the changes! I haven't had a chance to test everything, will do soon.

for mermaid, I don't think it should be provided in the docker image by default if it makes it too heavy. I'll have to think how to make it run without it and not error out (eg, not display mermaid diagrams if mermaid has not been installed).

[pourmand1376]

FYI, Currently (without mermaid installed), it doesn't show any errors. It just shows a warning!

[pourmand1376]

I just added GitHub Actions to build a docker image automatically after each commit. It means that first GitHub will fetch the repo and install all required dependencies in a docker image. Then it will push it to this repo.

The image size when building locally is 1.15GB but Dockerhub optimizes the image to 360MB.

So, to put it in a nutshell, now we can remove the old way of building the image and just tell people to:

docker pull amirpourmand/ai-folio 

and then

docker run --rm -v "$PWD:/srv/jekyll/" -p "8080:8080" -it amirpourmand/ai-folio \
bundler exec jekyll serve --watch --port=8080 --host=0.0.0.0

This way, we minimize the error since people do not have to build the image themselves.

Of course, I can put these commands in our scripts in bin folder, so people would be able to run it without copying and pasting.

However, currently, I've uploaded the images to my repo. It is up to you to decide if you want to upload your image to my repo or create your own repo. If you choose to use mine, I can add you to collaborators so you have complete access.

By the way, to make this usable, you have to add two variables to your github secrets. A Tutorial is available here. You can also change the image repository easily in the deploy-image.yml file.

Variable names in the secret are DOCKER_USERNAME and DOCKER_PASSWORD.

With all respect.

[pourmand1376]

Note. I realized that it is better to remove Gemfile.lock after each build. Sometimes, the correct version is installed but because some other version is written to Gemfile.lock, it throws an error.

[JohannesAck]

Thanks for the Dockerfile, I was using it under windows without issues a week ago, but now I suddenly got the error mentioned in this issue: #161

It seems that this was caused by the jekyll/jekyll docker image pushing a new version 5 days ago, which uses Ruby 3.
For me, changing your Dockerfile to FROM jekyll/jekyll:4.2.0 has fixed the issue, as this container still uses Ruby 2.7.x.

However I'm also using a version of al-folio from about a year ago, so maybe this is only an issue with older versions.

[pourmand1376]

Thanks 👍
I will change Dockerfile respectively and make a commit soon.

[alshedivat]

@pourmand1376, thanks again for contributing docker-based build local build and sorry about slow review on my end.

overall, everything looks good. I have just a couple of things:

1. when following your instructions on mac, I get the following error when trying to run bin/dockerhub_run.sh:

$ ./bin/dockerhub_run.sh
WARNING: The requested image's platform (linux/amd64) does not match the detected host platform (linux/arm64/v8) and no specific platform was requested
Could not find jekyll-4.2.1, jekyll-scholar-7.0.0, jekyll-sass-converter-2.1.0, kramdown-2.3.1, rouge-3.28.0, html-pipeline-2.14.0, loofah-2.14.0, public_suffix-4.0.6, concurrent-ruby-1.1.9, activesupport-7.0.2.2 in any of the sources
Run `bundle install` to install missing gems.

when building the docker image locally, bin/docker_build.sh works, but then bin/docker_run.sh fails with the same error. do you know if there is a way to fix this?

2. it looks like docker image CI build fails. is there a way to fix this? is it somehow related to github secretes that you mentioned?

[pourmand1376]

Note. I realized that it is better to remove Gemfile.lock after each build. Sometimes, the correct version is installed but because some other version is written to Gemfile.lock, it throws an error.

I updated the scripts to automatically remove Gemfile.lock file. I believe your problem is for that.

it looks like docker image CI build fails. is there a way to fix this? is it somehow related to github secretes that you mentioned?

Exactly, you should add Github secrets and then send me your username in dockerhub. You can email me if you don't want to add it here. After that, I will add you to this repo and we are set.

This is the error in CI build:

Error: Username and password required

[pourmand1376]

Thanks for the Dockerfile, I was using it under windows without issues a week ago, but now I suddenly got the error mentioned in this issue: #161

It seems that this was caused by the jekyll/jekyll docker image pushing a new version 5 days ago, which uses Ruby 3. For me, changing your Dockerfile to FROM jekyll/jekyll:4.2.0 has fixed the issue, as this container still uses Ruby 2.7.x.

However I'm also using a version of al-folio from about a year ago, so maybe this is only an issue with older versions.

Actually, as I tested multiple times, this problem doesn't occur with the latest version.

[pourmand1376]

TODO

• Add docker-compose yaml file and guidelines to use it.
• Use versioning to keep all built images (currently we are using latest tag, but it is better if each image has its own tag).

[alshedivat]

Note. I realized that it is better to remove Gemfile.lock after each build. Sometimes, the correct version is installed but because some other version is written to Gemfile.lock, it throws an error.

I updated the scripts to automatically remove Gemfile.lock file. I believe your problem is for that.

it looks like docker image CI build fails. is there a way to fix this? is it somehow related to github secretes that you mentioned?

Exactly, you should add Github secrets and then send me your username in dockerhub. You can email me if you don't want to add it here. After that, I will add you to this repo and we are set.

This is the error in CI build:

Error: Username and password required

great, thank you! I added DOCKER_USERNAME and DOCKER_PASSWORD secrets to the repo. my username is the same as for github.

[pourmand1376]

I added you to the contributor list, but the action still fails

Apparently

secrets are not passed to the runner when a workflow is triggered from a forked repository. (see here).

You can see my docker image actions for my forked repo here. The action related to docker is working fine.

I think we can not test this one and you should merge this one to see if it goes fine. Hopefully, github would create someway of sharing this secrets later ...

[alshedivat]

@all-contributors please add @pourmand1376 for code

[allcontributors]

@alshedivat

I've put up a pull request to add @pourmand1376! 🎉

[gabrielraya]

Do you know why I am getting this after running ./bin/dockerhub_run.sh

System: Windows 10 Enterprise

[pourmand1376]

Hi
I think you should open up a discussion or issue and mention me there. This way other people who come up with your issue can solve their problem easier. BTW, What is the output of command ./bin/dockerhub_run.sh?