CI: add workflow

.github/workflows/docker.yml

@@ -0,0 +1,44 @@
+name: Build and Push Docker image
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - v*
+  pull_request:
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: quarkslab/numbatui
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+
+    permissions:
+      packages: write
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          file: docker/Dockerfile
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

README.md

@@ -21,26 +21,50 @@ Features added are:
 ## Usage
 
 We strongly recommend using the provided Docker image to run NumbatUI, as
-it contains all the required dependencies. To build the docker image:
-
-```bash
-cd docker
-docker build -t numbatui .
-```
-
-Then to open the */path/to/my_database.srctrlprj* database with NumbatUI, run:
-
-```bash
-docker run -it --env DISPLAY=$DISPLAY \
-               --env QT_X11_NO_MITSHM=1 \
-               --volume /tmp/.X11-unix:/tmp/.X11-unix \
-               --volume /path/to/:/data/ \
-               numbatui:latest /data/my_database.srctrlprj
-```
-
-It will open NumbatUI with the database. Note: as the application is a GUI Qt application
-one needs to forward the X11 display to the container.
-
+it contains all the required dependencies. You can either:
+- Build locally the docker image:
+  ```bash
+  cd docker
+  docker build -t numbatui .
+  ```
+- Download it from github:
+  ```bash
+  docker pull ghcr.io/quarkslab/numbatui
+  ```
+
+Then open the */path/to/my_database.srctrlprj* database with NumbatUI. The command will depend of your windowing system, as the application is a GUI Qt application
+one needs to forward the X11/Wayland display to the container.
+
+
+- For **X11** users, run the following command. You may need to add allow `docker` to use your Xserver.
+> [!NOTE]
+> You may need to add allow `docker` to use your Xserver.
+> ```bash
+> xhost +local:docker
+> ```
+> After usage, you can remove this authorization with:
+> ```bash
+> xhost -local:docker
+> ```
+  ```bash
+  docker run -it --rm \
+             --env DISPLAY=$DISPLAY \
+             --env QT_X11_NO_MITSHM=1 \
+             --volume /tmp/.X11-unix:/tmp/.X11-unix \
+             --volume /path/to/:/data/ \
+             numbatui:latest /data/my_database.srctrlprj
+  ```
+- For **Wayland** users, run the following command:
+  ```bash
+  docker run -it --rm \
+             --env QT_QPA_PLATFORM=wayland \
+             --env XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR \
+             --env WAYLAND_DISPLAY=$WAYLAND_DISPLAY \
+             --volume /run/user/1000/$WAYLAND_DISPLAY:/run/user/1000/$WAYLAND_DISPLAY \
+             --volume /usr/share/wayland-sessions:/usr/share/wayland-sessions \
+             --volume /path/to/:/data/ \
+             numbatui:latest /data/my_database.srctrlprj
+  ```
 
 
 ## Manual Installation