jartis/kicad repository overview

⁠KiCad Docker Image

This Docker image is based on Ubuntu 24.04 and includes the installation of KiCad 8.0. It is configured to run KiCad in a container with the ability to display its graphical interface on your host's Xserver.

⁠Features

• Based on Ubuntu 24.04
• Includes KiCad 8.0
• Configured to run KiCad with GUI support on host's Xserver
• Mounts project directory from host to container for seamless file access

⁠Usage

To build the Docker image:

docker build -t kicad_image .

To run KiCad in a container with GUI support:

docker run --rm -e DISPLAY=$DISPLAY \
    -v /tmp/.X11-unix:/tmp/.X11-unix \
    -v /home/$USER/Projekt:/home/kicad/Projekt \
    --user kicad \
    --name kicad_container jartis/kicad

⁠Explanation

• --rm: Automatically removes the container when it exits.
• -e DISPLAY=$DISPLAY: Sets the DISPLAY environment variable to forward the graphical output to your host's Xserver.
• -v /tmp/.X11-unix:/tmp/.X11-unix: Mounts the X11 socket directory to allow communication with the Xserver.
• -v /home/$USER/Projekt:/home/kicad/Projekt: Mounts your project directory from the host to the container.
• --user kicad: Runs the container as the kicad user to ensure proper permissions.
• --name kicad_container: Assigns a name to the running container (optional).
• jartis/kicad: The name of the Docker image.

⁠Additional Information

This image ensures that KiCad is ready to use out of the box with all necessary dependencies and configurations. It is ideal for users who want to run KiCad in a contained environment without installing it directly on their host system.

⁠Running KiCad Docker Image on Windows

To use this Docker image on Windows and run KiCad with GUI support, follow these steps:

1. Install Docker Desktop for Windows: Ensure that Docker Desktop is installed and running on your Windows machine. You can download it from the Docker website⁠.

2. Enable WSL 2: Docker Desktop relies on the Windows Subsystem for Linux (WSL) 2 backend. Make sure WSL 2 is installed and enabled on your system. Instructions can be found on the Microsoft documentation⁠.

3. Xserver for Windows: Install an Xserver on your Windows machine, such as VcXsrv⁠. This will allow you to display the GUI of applications running inside the Docker container.

4. Configure Xserver: Start your Xserver (e.g., VcXsrv) and configure it to allow connections from your Docker containers. Ensure it is running before starting the Docker container.

5. Run the Docker Container: Open a terminal in Docker Desktop or a PowerShell window and run the following command to start KiCad in a container:

   docker run --rm -e DISPLAY=host.docker.internal:0.0 \
       -v /tmp/.X11-unix:/tmp/.X11-unix \
       -v /path/to/your/project:/home/kicad/Projekt \
       --user kicad \
       --name kicad_container jartis/kicad
   

   Copy

   Replace /path/to/your/project with the actual path to your project directory on your Windows machine.

⁠Explanation

• -e DISPLAY=host.docker.internal:0.0: Sets the DISPLAY environment variable to forward the graphical output to the Xserver running on Windows.
• -v /tmp/.X11-unix:/tmp/.X11-unix: Mounts the X11 socket directory (may not be necessary for Windows but included for completeness).
• -v /path/to/your/project:/home/kicad/Projekt: Mounts your project directory from Windows to the container.
• --user kicad: Runs the container as the kicad user to ensure proper permissions.
• --name kicad_container: Assigns a name to the running container (optional).
• jartis/kicad: The name of the Docker image.

By following these steps, you can run KiCad in a Docker container on Windows with full GUI support.