https://github.com/jwillikers/can-utils-image
A container image for the SocketCAN userspace utilities and tools
https://github.com/jwillikers/can-utils-image
canbus container docker linux podman quayio socketcan
Last synced: about 1 month ago
JSON representation
A container image for the SocketCAN userspace utilities and tools
- Host: GitHub
- URL: https://github.com/jwillikers/can-utils-image
- Owner: jwillikers
- License: other
- Archived: true
- Created: 2021-07-21T13:37:25.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-15T13:40:04.000Z (almost 4 years ago)
- Last Synced: 2025-04-06T21:52:12.646Z (about 1 month ago)
- Topics: canbus, container, docker, linux, podman, quayio, socketcan
- Language: Shell
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE.adoc
- Code of conduct: CODE_OF_CONDUCT.adoc
Awesome Lists containing this project
README
= can-utils Image
Jordan Williams
:experimental:
:icons: font
ifdef::env-github[]
:tip-caption: :bulb:
:note-caption: :information_source:
:important-caption: :heavy_exclamation_mark:
:caution-caption: :fire:
:warning-caption: :warning:
endif::[]
:Black-Magic-Probe: https://github.com/blacksphere/blackmagic/wiki[Black Magic Probe]
:Buildah: https://buildah.io/[Buildah]
:Fedora: https://getfedora.org/[Fedora]
:Fedora-Silverblue: https://silverblue.fedoraproject.org/[Fedora Silverblue]
:fish: https://fishshell.com/[fish]
:Git: https://git-scm.com/[Git]
:OpenSSH: https://www.openssh.com/[OpenSSH]
:pre-commit: https://pre-commit.com/[pre-commit]
:Podman: https://podman.io/[Podman]
:SocketCAN-userspace-utilities-and-tools: https://github.com/linux-can/can-utils[SocketCAN userspace utilities and tools]
image:https://img.shields.io/github/workflow/status/jwillikers/can-utils-image/CI/main[GitHub Workflow Status]
image:https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white[pre-commit, link=https://github.com/pre-commit/pre-commit]
A container image for the {SocketCAN-userspace-utilities-and-tools}.
== Synopsis
Image:: https://quay.io/repository/jwillikers/can-utils[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.
[source,sh]
----
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.
. Install the {fish} shell.
+
[source,sh]
----
sudo rpm-ostree install fish
----
. Reboot to finish the installation.
+
[source,sh]
----
systemctl reboot
----
. Clone this repository.
+
[source,sh]
----
git -C ~/Projects clone [email protected]:jwillikers/can-utils-image.git
----
. Install {pre-commit}.
+
[source,sh]
----
pip install pre-commit
----
. Change into the project directory.
+
[source,sh]
----
cd ~/Projects/can-utils-image
----
. Install pre-commit's Git hooks.
+
[source,sh]
----
pre-commit install
----
. Run the shell script to build the image.
+
[source,sh]
----
buildah unshare ~/Projects/can-utils-image/build.fish
----
. Test the image with the `test.fish` shell script.
+
[source,sh]
----
~/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 link:CODE_OF_CONDUCT.adoc[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.
* https://asciidoctor.org/[Asciidoctor]
* {Buildah}
* {Fedora}
* {Fedora-Silverblue}
* {fish}
* {Git}
* https://www.linuxfoundation.org/[Linux]
* {OpenSSH}
* {Podman}
* {pre-commit}
* https://www.python.org/[Python]
* https://rouge.jneen.net/[Rouge]
* https://www.ruby-lang.org/en/[Ruby]
* {SocketCAN-userspace-utilities-and-tools}
== Code of Conduct
Refer to the project's link:CODE_OF_CONDUCT.adoc[Code of Conduct] for details.
== License
This repository is licensed under the https://www.gnu.org/licenses/gpl-3.0.html[GPLv3], a copy of which is provided in the link:LICENSE.adoc[license file].
© 2021 Jordan Williams
== Authors
mailto:{email}[{author}]