Skip to content
This repository has been archived by the owner on Oct 1, 2024. It is now read-only.

Latest commit

 

History

History
160 lines (126 loc) · 4.01 KB

README.adoc

File metadata and controls

160 lines (126 loc) · 4.01 KB
Raw

can-utils Image

GitHub Workflow Status pre-commit

A container image for the SocketCAN userspace utilities and tools.

Synopsis

Image

quay.io/jwillikers/can-utils

Tags

  • latest

Supported architectures

  • amd64 (x86_64)

  • arm64 (aarch64)

User

The default user inside the container is named user.

Working directory

/home/user

Labels
io.containers.autoupdate=registry

Enables automatic updates when using Podman and the fully-qualified image name.

Quick Start

To connect to a CAN network interface from within this container, use host networking as shown in the following Podman command.

podman run \
    --rm \
    --network host \
    --name can-utils \
    -it quay.io/jwillikers/can-utils:latest

Build

This project uses Buildah and Podman for building and testing the image. A set of pre-commit checks are readily available to ensure your code is up-to-spec at the time it is committed. Instructions for setting up a development environment, building the image, and testing the image follow. These instructions are intended for users of Fedora Silverblue, where the packages buildah, git, and podman are already available. Moreover, I use the fish shell.

  1. Install the fish shell.

    sudo rpm-ostree install fish

  2. Reboot to finish the installation.

    systemctl reboot

  3. Clone this repository.

    git -C ~/Projects clone git@github.com:jwillikers/can-utils-image.git

  4. Install pre-commit.

    pip install pre-commit

  5. Change into the project directory.

    cd ~/Projects/can-utils-image

  6. Install pre-commit’s Git hooks.

    pre-commit install

  7. Run the shell script to build the image.

    buildah unshare ~/Projects/can-utils-image/build.fish

  8. Test the image with the test.fish shell script.

    ~/Projects/can-utils-image/test.fish

Contributing

Contributions in the form of issues, feedback, and even pull requests are welcome. Make sure to adhere to the project’s Code of Conduct.

Open Source Software

This project is built on the hard work of countless open source contributors. Several of these projects are enumerated below.

Code of Conduct

Refer to the project’s Code of Conduct for details.

License

This repository is licensed under the GPLv3, a copy of which is provided in the license file.

© 2021 Jordan Williams

Authors