Merge pull request #382 from Trim/ruby3-dockerfile

Ruby3 dockerfile

Author: Trim

.dockerignore

@@ -23,3 +23,4 @@
 /uploads
 /vendor/ruby
 /vendor/bundle
+/coverage

Docker.md Container.mdDocker.md renamed to Container.md

@@ -1,8 +1,24 @@
-LinuxFr on Docker
------------------
+LinuxFr with Containers
+-----------------------
 
 To simplify set up of a developement environment, LinuxFr.org can be
-run on Docker with `docker-compose up`.
+run with a container engine like Docker or Podman with the [`compose.yml`](./compose.yaml)
+file which describe how to build all needed services.
+
+If you use the Docker engine, you can use the `docker compose up` command to start the system (you
+need to install the [Docker compose plugin](https://docs.docker.com/compose/)).
+
+> Note: with the Docker engine, you need to enable the Docker BuildKit builder.
+> Either you have a Docker version which uses it by default, or you set the
+> environment variable `export DOCKER_BUILDKIT=1`.
+
+If you use Podman, you can either use the same Docker compose plugin or the
+[podman-compose](https://github.com/containers/podman-compose/)
+utility. The podman cli itself provide a wrapper of one of these two tools through the
+[`podman compose` command](https://docs.podman.io/en/latest/markdown/podman-compose.1.html).
+
+At this point, the documentation will give you `docker compose` commands, but you should be able
+to use `podman compose` without any issue.
 
 To init the SQL database schema, you need to wait upto the `database`
 container to be ready to listen MySQL connections.
@@ -16,18 +32,29 @@ For example, you should see in the logs:
 Then, open a second terminal and run:
 
 ```
-docker-compose run linuxfr.org bin/rails db:setup
+docker compose run linuxfr.org bin/rails db:setup
 ```
 
 Finally, the environment is ready and you can open [http://dlfp.lo](http://dlfp.lo)
 in your favorite browser.
 
-Note: to be able to access this URL, you'll need to add the following line
-into the `/etc/hosts` file of your machine:
+Notes:
+
+1. to be able to access this URL, you'll need to add the following line
+  into the `/etc/hosts` file of your machine:
+  
+  ```
+  127.0.0.1 dlfp.lo image.dlfp.lo
+  ```
+
+2. for [rootless containers](https://rootlesscontaine.rs/), you'll need
+  to allow standard users to listen on ports less than 1024
+  (this is needed because linuxfr use port 80 and 443):
+
+  ```sh
+  sudo sysctl net.ipv4.ip_unprivileged_port_start=80
+  ```
 
-```
-127.0.0.1 dlfp.lo image.dlfp.lo
-```
 
 Personalize configuration
 =========================
@@ -43,7 +70,7 @@ service.
 
 If you want to change the application port and/or other configurations, you can
 [override](https://docs.docker.com/compose/extends/)
-the docker-compose configuration (in particular the `nginx` service for
+the docker compose configuration (in particular the `nginx` service for
 the port).
 
 Notice, that if LinuxFr.org doesn't run on port 80, the image cache
@@ -52,8 +79,8 @@ service won't work well and so you won't be able to see images in the news.
 Test modifications
 ==================
 
-The docker-compose is currently configured to share `./app`, `./db` and
-`./public` directories with the docker container.
+The compose file currently shares `./app`, `./db` and
+`./public` directories with the container.
 
 So you can update files with your prefered IDE on your machine. Rails
 will directly detect changes and apply them on next page reload.
@@ -62,7 +89,7 @@ Furthermore, if you need to access the Rails console, you need a second
 terminal and run:
 
 ```
-docker-compose run linuxfr.org bin/rails console
+docker compose run linuxfr.org bin/rails console
 ```
 
 Note: currently, we didn't configure rails to show directly the
@@ -79,10 +106,10 @@ To get help about writing tests, see the
 [Ruby on Rails documentation](https://guides.rubyonrails.org/testing.html#the-rails-test-runner)
 .
 
-To run tests with Docker environment, you need to use this command:
+To run tests with containers, you need to use this command:
 
 ```
-docker-compose run linuxfr.org bin/rails test -v
+docker compose run linuxfr.org bin/rails test -v
 ```
 
 Inspect database schema
@@ -92,7 +119,7 @@ In case you need to inspect the database, you need a second terminal
 and run:
 
 ```
-docker-compose run database mysql -hdatabase -ulinuxfr_rails -p linuxfr_rails
+docker compose run database mysql -hdatabase -ulinuxfr_rails -p linuxfr_rails
 ```
 
 By default, the requested password is the same as the username.
@@ -104,20 +131,20 @@ In case you need to apply new database migrations, you need a second
 terminal and run:
 
 ```
-docker-compose run linuxfr.org bin/rails db:migrate
+docker compose run linuxfr.org bin/rails db:migrate
 ```
 
 If you had issue and want to reset all data in your database system,
 use:
 
 ```
-docker-compose run linuxfr.org bin/rails db:reset
+docker compose run linuxfr.org bin/rails db:reset
 ```
 
-Services provided by the docker-compose
+Services provided by the compose file
 =======================================
 
-Currently, these services are directly enabled by docker-compose:
+Currently, these services are directly enabled by compose:
 
 1. The [LinuxFr.org](https://github.com/linuxfrorg/linuxfr.org)
 ruby on rails application itself
@@ -134,7 +161,7 @@ For now, these services aren't available:
 because it requires to run 
 LinuxFr.org with a TLS certificate. When the service will accept to
 fetch articles with simple `http://`, we'll be able to provide it
-directly with docker-compose.
+directly with docker compose.
 2. The [svgtex service](https://github.com/linuxfrorg/svgtex), because LinuxFr
 has hard-coded the `localhost`
 hostname in it's [HTML Pipeline tool](https://github.com/linuxfrorg/html-pipeline-linuxfr/blob/linuxfr/lib/html/pipeline/linuxfr.rb#L8)

README.md

@@ -12,9 +12,9 @@ Install
 
 See [INSTALL.md](INSTALL.md) to set up LinuxFr.org on a Debian environment.
 
-Alternatively, you can read [Docker.md](Docker.md) to setup easily
-LinuxFr.org development environment with the Docker engine and
-[docker-compose](https://docs.docker.com/compose/).
+Alternatively, you can read [Container.md](Container.md) to setup easily
+LinuxFr.org development environment with a container engine like Docker or
+Podman and use the [container composer](https://docs.docker.com/compose/).
 
 See also
 --------

docker-compose.yaml compose.yamldocker-compose.yaml renamed to compose.yaml

@@ -4,16 +4,16 @@ services:
   linuxfr.org:
     build:
       context: .
-      dockerfile: deployment/linuxfr.org/Dockerfile
+      dockerfile: deployment/linuxfr.org/Containerfile
     env_file:
       - deployment/default.env
     volumes:
       # Share host directories so, the developer can edit them
       # and see the result without need to restart the container
-      - ./app:/linuxfr.org/app
-      - ./db:/linuxfr.org/db
-      - ./public:/linuxfr.org/public
-      - ./test:/linuxfr.org/test
+      - ./app:/linuxfr.org/app:Z
+      - ./db:/linuxfr.org/db:Z
+      - ./public:/linuxfr.org/public:Z
+      - ./test:/linuxfr.org/test:Z
       # uploads are shared with the nginx service
       - data-uploads:/linuxfr.org/uploads
     tmpfs:
@@ -41,12 +41,12 @@ services:
       - cache-img:/linuxfr-img/cache
 
   nginx:
-    image: nginx:stable
+    image: docker.io/nginx:stable
     env_file:
       - deployment/default.env
     volumes:
-      - ./deployment/nginx/templates:/etc/nginx/templates
-      - ./public/fonts:/var/linuxfr/fonts
+      - ./deployment/nginx/templates:/etc/nginx/templates:Z
+      - ./public/fonts:/var/linuxfr/fonts:Z
       - data-uploads:/var/linuxfr/uploads
     ports:
       - "80:80"
@@ -66,7 +66,7 @@ services:
       - data-database:/var/lib/mysql
 
   redis:
-    image: redis:5
+    image: docker.io/redis:5
     volumes:
       - data-redis:/data
 

db/schema.rb

@@ -205,7 +205,7 @@
     t.index ["user_id"], name: "index_nodes_on_user_id"
   end
 
-  create_table "oauth_access_grants", id: :integer, charset: "utf8mb3", force: :cascade do |t|
+  create_table "oauth_access_grants", id: :integer, charset: "utf8", force: :cascade do |t|
     t.integer "resource_owner_id", null: false
     t.integer "application_id", null: false
     t.string "token", null: false
@@ -219,7 +219,7 @@
     t.index ["token"], name: "index_oauth_access_grants_on_token", unique: true
   end
 
-  create_table "oauth_access_tokens", id: :integer, charset: "utf8mb3", force: :cascade do |t|
+  create_table "oauth_access_tokens", id: :integer, charset: "utf8", force: :cascade do |t|
     t.integer "resource_owner_id"
     t.integer "application_id", null: false
     t.string "token", null: false
@@ -234,7 +234,7 @@
     t.index ["token"], name: "index_oauth_access_tokens_on_token", unique: true
   end
 
-  create_table "oauth_applications", id: :integer, charset: "utf8mb3", force: :cascade do |t|
+  create_table "oauth_applications", id: :integer, charset: "utf8", force: :cascade do |t|
     t.string "name", null: false
     t.string "uid", null: false
     t.string "secret", null: false

deployment/database/Dockerfile deployment/database/Containerfiledeployment/database/Dockerfile renamed to deployment/database/Containerfile

@@ -1,3 +1,3 @@
-FROM mariadb:10.1
+FROM docker.io/mariadb:10.1
 
 COPY ./docker-entrypoint-initdb.d /docker-entrypoint-initdb.d

deployment/linuxfr-board/Containerfile

@@ -0,0 +1,39 @@
+FROM  docker.io/ruby:3-slim-bookworm
+
+LABEL org.opencontainers.image.title="LinuxFr.org boards"
+LABEL org.opencontainers.image.description="Push notifications for chat rooms of LinuxFr"
+LABEL org.opencontainers.image.source="https://github.com/linuxfrorg/board-sse-linuxfr.org"
+LABEL org.opencontainers.image.url="https://github.com/linuxfrorg/linuxfr.org/blob/master/Container.md"
+LABEL org.opencontainers.image.licenses="AGPL-3.0-only"
+LABEL org.opencontainers.image.version="ruby3-bookworm"
+LABEL org.opencontainers.image.authors="Adrien Dorsaz <adrien@adorsaz.ch>"
+
+ARG UID=1200
+
+RUN apt-get update \
+  # Install dependencies \
+  && apt-get install -y --no-install-recommends \
+    build-essential git ruby ruby-dev \
+  && apt-get clean
+
+USER ${UID}
+WORKDIR /linuxfr-board
+ENV HOME=/linuxfr-board
+
+# Install board-linuxfr
+# RUN gem install board-linuxfr -v '~> 0.1.4'
+
+# Temporary build board-linuxfr from sources
+RUN git clone https://github.com/linuxfrorg/board-sse-linuxfr.org.git --branch ruby3 \
+  && cd board-sse-linuxfr.org \
+  && gem build board-linuxfr.gemspec \
+  && gem install ./board-linuxfr-*.gem
+
+# Clean development dependencies
+USER 0
+RUN apt purge --autoremove -y build-essential git ruby-dev
+
+USER ${UID}
+EXPOSE 9000
+
+CMD ["board-linuxfr"]

deployment/linuxfr-board/Dockerfile

@@ -0,0 +1,35 @@
+FROM docker.io/debian:bullseye-slim as build
+
+LABEL org.opencontainers.image.title="LinuxFr.org image caching service"
+LABEL org.opencontainers.image.description="Store external images into a cache to not flood external website"
+LABEL org.opencontainers.image.source="https://github.com/linuxfrorg/img-LinuxFr.org"
+LABEL org.opencontainers.image.url="https://github.com/linuxfrorg/linuxfr.org/blob/master/Container.md"
+LABEL org.opencontainers.image.licenses="AGPL-3.0-only"
+LABEL org.opencontainers.image.version="rails7-bullseye"
+LABEL org.opencontainers.image.authors="Adrien Dorsaz <adrien@adorsaz.ch>"
+
+ARG UID=1200
+
+RUN apt-get update \
+  && apt-get install -y --no-install-recommends \
+    golang git ca-certificates \
+  && apt-get clean
+
+USER ${UID}
+ENV GOPATH=/linuxfr-img
+ENV HOME=/linuxfr-img
+WORKDIR /linuxfr-img
+
+# Build linuxfr-img
+RUN go get -u github.com/linuxfrorg/img-LinuxFr.org
+
+FROM docker.io/debian:bullseye-slim as deploy
+
+USER ${UID}
+WORKDIR /linuxfr-img
+
+COPY --from=build --chown=${UID}:0 --chmod=770 /linuxfr-img/bin/img-LinuxFr.org .
+
+EXPOSE 8000
+
+CMD ["sh", "-c", "exec ./img-LinuxFr.org -a 0.0.0.0:8000 -r \"${REDIS_URL##redis://}\""]