diff --git a/README.md b/README.md index 7fbd226ba97..b928515b4dd 100755 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@ These instructions will get you a copy of the Quarkus.io website up and running ### Installation -#### Using Docker +#### Using Docker or Podman -1. Install [Docker Desktop](https://docs.docker.com/install/). +1. Install [Docker Desktop](https://docs.docker.com/install/) or [Podman Desktop](https://podman-desktop.io/) 2. Fork the [project repository](https://github.com/quarkusio/quarkusio.github.io), then clone your fork: git clone git@github.com:YOUR_USER_NAME/quarkusio.github.io.git @@ -17,11 +17,17 @@ These instructions will get you a copy of the Quarkus.io website up and running cd quarkusio.github.io -4. Run Docker Compose: +4. Run Docker Compose or Podman Compose: docker compose up - > **Note:** The startup process may take several minutes, depending on your system. During this time, you might see logs with warnings or configuration messages (e.g., AutoPages and asciidoctor warnings). This is normal behavior as Jekyll builds the site. Once the server is running, you will see output like this: +or + + podman compose up + +By default, this does not include guides. To include guides, use `podman compose --file docker-compose_with_guides.yml up`, but be aware that serving guides via container is not currently working. + +> **Note:** The startup process may take several minutes, depending on your system. During this time, you might see logs with warnings or configuration messages (e.g., AutoPages and asciidoctor warnings). This is normal behavior as Jekyll builds the site. Once the server is running, you will see output like this: ``` jekyll-1 | Server address: http://0.0.0.0:4000/ diff --git a/docker-compose.yml b/docker-compose.yml index a7294b139d2..fb93609c1dd 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -6,7 +6,7 @@ services: # Add --incremental to the commandline # https://github.com/BretFisher/jekyll-serve/blob/2119a31476e1c6004a4bea4739b9160fc73e7bda/Dockerfile#L27C5-L27C94 # Also, enable dev config - command: [ "bundle", "exec", "jekyll", "serve", "--force_polling", "-H", "0.0.0.0", "-P", "4000", "--incremental", "--config", "_config.yml,_config_dev.yml" ] + command: [ "bundle", "exec", "jekyll", "serve", "--force_polling", "-H", "0.0.0.0", "-P", "4000", "--incremental", "--config", "_config.yml,_config_dev.yml,_noguides_config.yml" ] volumes: - .:/site:Z ports: diff --git a/docker-compose_with_guides.yml b/docker-compose_with_guides.yml new file mode 100644 index 00000000000..a7294b139d2 --- /dev/null +++ b/docker-compose_with_guides.yml @@ -0,0 +1,13 @@ +# no version needed since 2020 + +services: + jekyll: + image: docker.io/bretfisher/jekyll-serve + # Add --incremental to the commandline + # https://github.com/BretFisher/jekyll-serve/blob/2119a31476e1c6004a4bea4739b9160fc73e7bda/Dockerfile#L27C5-L27C94 + # Also, enable dev config + command: [ "bundle", "exec", "jekyll", "serve", "--force_polling", "-H", "0.0.0.0", "-P", "4000", "--incremental", "--config", "_config.yml,_config_dev.yml" ] + volumes: + - .:/site:Z + ports: + - '4000:4000'