Merge pull request #2981 from adriandavidauer/fix_docker

added chmod to docu and connection_pool to gemfile, added VS Code container (close #2443)

Author: rjzupkoii

.devcontainer/devcontainer.json

@@ -0,0 +1,15 @@
+{
+    "name": "ACADEMIC PAGES",
+    "dockerComposeFile": "../docker-compose.yaml",
+    "service": "jekyll-site",
+    "remoteEnv": {
+        "VSCODE_SERVER_DIR": "/home/vscode/.vscode-server"
+    },
+    "runArgs": [
+        "--user",
+        "1000:1000"
+    ],
+    "workspaceFolder": "/usr/src/app",
+    "remoteUser": "vscode",
+    "forwardPorts": [4000] // Add port forwarding
+}

Dockerfile

@@ -7,14 +7,29 @@ RUN apt-get update && apt-get install -y \
     nodejs \
     && rm -rf /var/lib/apt/lists/*
 
-# Set the working directory inside the container
+
+# Create a non-root user with UID 1000
+RUN groupadd -g 1000 vscode && \
+    useradd -m -u 1000 -g vscode vscode
+
+# Set the working directory
 WORKDIR /usr/src/app
 
+# Set permissions for the working directory
+RUN chown -R vscode:vscode /usr/src/app
+
+# Switch to the non-root user
+USER vscode
+
 # Copy Gemfile into the container (necessary for `bundle install`)
 COPY Gemfile ./
 
+
+
 # Install bundler and dependencies
-RUN gem install bundler:2.3.26 && bundle install
+RUN gem install connection_pool:2.5.0
+RUN gem install bundler:2.3.26
+RUN bundle install
 
 # Command to serve the Jekyll site
 CMD ["jekyll", "serve", "-H", "0.0.0.0", "-w", "--config", "_config.yml,_config_docker.yml"]

Gemfile

@@ -10,3 +10,4 @@ group :jekyll_plugins do
 end
 
 gem 'github-pages'
+gem 'connection_pool', '2.5.0'

README.md

@@ -20,6 +20,8 @@ See more info at https://academicpages.github.io/
 When you are initially working on your website, it is very useful to be able to preview the changes locally before pushing them to GitHub. To work locally you will need to:
 
 1. Clone the repository and made updates as detailed above.
+
+### Using a different IDE
 1. Make sure you have ruby-dev, bundler, and nodejs installed
 
     On most Linux distribution and [Windows Subsystem Linux](https://learn.microsoft.com/en-us/windows/wsl/about) the command is:
@@ -59,11 +61,16 @@ Working from a different OS, or just want to avoid installing dependencies? You
 You can build and execute the container by running the following command in the repository:
 
 ```bash
+chmod -R 777 .
 docker compose up
 ```
 
 You should now be able to access the website from `localhost:4000`.
 
+### Using the DevContainer in VS Code
+
+If you are using [Visual Studio Code](https://code.visualstudio.com/) you can use the [Dev Container](https://code.visualstudio.com/docs/devcontainers/containers) that comes with this Repository. Normally VS Code detects that a development coontainer configuration is available and asks you if you want to use the container. If this doesn't happen you can manually start the container by **F1->DevContainer: Reopen in Container**. This restarts your VS Code in the container and automatically hosts your academic page locally on http://localhost:4000. All changes will be updated live to that page after a few seconds.
+
 # Maintenance
 
 Bug reports and feature requests to the template should be [submitted via GitHub](https://github.com/academicpages/academicpages.github.io/issues/new/choose). For questions concerning how to style the template, please feel free to start a [new discussion on GitHub](https://github.com/academicpages/academicpages.github.io/discussions).

docker-compose.yaml

@@ -2,7 +2,8 @@ services:
   jekyll-site:
     image: jekyll-site
     build: .
-    volumes: [.:/usr/src/app]
-    ports: [4000:4000]
+    volumes: [ .:/usr/src/app ]
+    ports: [ 4000:4000 ]
     user: 1000:1000
-    environment: [JEKYLL_ENV=docker]
+    environment: [ JEKYLL_ENV=docker ]
+    command: jekyll serve -H 0.0.0.0 -w --config _config.yml, _config_docker.yml