{"id":18929195,"url":"https://github.com/jwillikers/can-utils-image","last_synced_at":"2025-04-15T15:30:52.629Z","repository":{"id":104838331,"uuid":"388128283","full_name":"jwillikers/can-utils-image","owner":"jwillikers","description":"A container image for the SocketCAN userspace utilities and tools","archived":true,"fork":false,"pushed_at":"2021-08-15T13:40:04.000Z","size":20,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-06T21:52:12.646Z","etag":null,"topics":["canbus","container","docker","linux","podman","quayio","socketcan"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jwillikers.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.adoc","code_of_conduct":"CODE_OF_CONDUCT.adoc","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-21T13:37:25.000Z","updated_at":"2024-10-01T12:31:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"a7d6c306-1f0f-470f-82d2-d7d26677f7a8","html_url":"https://github.com/jwillikers/can-utils-image","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwillikers%2Fcan-utils-image","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwillikers%2Fcan-utils-image/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwillikers%2Fcan-utils-image/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwillikers%2Fcan-utils-image/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jwillikers","download_url":"https://codeload.github.com/jwillikers/can-utils-image/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249097799,"owners_count":21212355,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["canbus","container","docker","linux","podman","quayio","socketcan"],"created_at":"2024-11-08T11:31:03.518Z","updated_at":"2025-04-15T15:30:52.621Z","avatar_url":"https://github.com/jwillikers.png","language":"Shell","readme":"= can-utils Image\nJordan Williams \u003cjordan@jwillikers.com\u003e\n:experimental:\n:icons: font\nifdef::env-github[]\n:tip-caption: :bulb:\n:note-caption: :information_source:\n:important-caption: :heavy_exclamation_mark:\n:caution-caption: :fire:\n:warning-caption: :warning:\nendif::[]\n:Black-Magic-Probe: https://github.com/blacksphere/blackmagic/wiki[Black Magic Probe]\n:Buildah: https://buildah.io/[Buildah]\n:Fedora: https://getfedora.org/[Fedora]\n:Fedora-Silverblue: https://silverblue.fedoraproject.org/[Fedora Silverblue]\n:fish: https://fishshell.com/[fish]\n:Git: https://git-scm.com/[Git]\n:OpenSSH: https://www.openssh.com/[OpenSSH]\n:pre-commit: https://pre-commit.com/[pre-commit]\n:Podman: https://podman.io/[Podman]\n:SocketCAN-userspace-utilities-and-tools: https://github.com/linux-can/can-utils[SocketCAN userspace utilities and tools]\n\nimage:https://img.shields.io/github/workflow/status/jwillikers/can-utils-image/CI/main[GitHub Workflow Status]\nimage:https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white[pre-commit, link=https://github.com/pre-commit/pre-commit]\n\nA container image for the {SocketCAN-userspace-utilities-and-tools}.\n\n== Synopsis\n\nImage:: https://quay.io/repository/jwillikers/can-utils[quay.io/jwillikers/can-utils]\n\nTags::\n* `latest`\n\nSupported architectures::\n* `amd64` _(x86_64)_\n* `arm64` _(aarch64)_\n\nUser:: The default user inside the container is named `user`.\n\nWorking directory:: `/home/user`\n\nLabels::\n`io.containers.autoupdate=registry`::: Enables automatic updates when using Podman and the _fully-qualified_ image name.\n\n== Quick Start\n\nTo connect to a CAN network interface from within this container, use host networking as shown in the following {Podman} command.\n\n[source,sh]\n----\npodman run \\\n    --rm \\\n    --network host \\\n    --name can-utils \\\n    -it quay.io/jwillikers/can-utils:latest\n----\n\n== Build\n\nThis project uses {Buildah} and {Podman} for building and testing the image.\nA set of {pre-commit} checks are readily available to ensure your code is up-to-spec at the time it is committed.\nInstructions for setting up a development environment, building the image, and testing the image follow.\nThese instructions are intended for users of {Fedora-Silverblue}, where the packages `buildah`, `git`, and `podman` are already available.\nMoreover, I use the {fish} shell.\n\n. Install the {fish} shell.\n+\n[source,sh]\n----\nsudo rpm-ostree install fish\n----\n\n. Reboot to finish the installation.\n+\n[source,sh]\n----\nsystemctl reboot\n----\n\n. Clone this repository.\n+\n[source,sh]\n----\ngit -C ~/Projects clone git@github.com:jwillikers/can-utils-image.git\n----\n\n. Install {pre-commit}.\n+\n[source,sh]\n----\npip install pre-commit\n----\n\n. Change into the project directory.\n+\n[source,sh]\n----\ncd ~/Projects/can-utils-image\n----\n\n. Install pre-commit's Git hooks.\n+\n[source,sh]\n----\npre-commit install\n----\n\n. Run the shell script to build the image.\n+\n[source,sh]\n----\nbuildah unshare ~/Projects/can-utils-image/build.fish\n----\n\n. Test the image with the `test.fish` shell script.\n+\n[source,sh]\n----\n~/Projects/can-utils-image/test.fish\n----\n\n== Contributing\n\nContributions in the form of issues, feedback, and even pull requests are welcome.\nMake sure to adhere to the project's link:CODE_OF_CONDUCT.adoc[Code of Conduct].\n\n== Open Source Software\n\nThis project is built on the hard work of countless open source contributors.\nSeveral of these projects are enumerated below.\n\n* https://asciidoctor.org/[Asciidoctor]\n* {Buildah}\n* {Fedora}\n* {Fedora-Silverblue}\n* {fish}\n* {Git}\n* https://www.linuxfoundation.org/[Linux]\n* {OpenSSH}\n* {Podman}\n* {pre-commit}\n* https://www.python.org/[Python]\n* https://rouge.jneen.net/[Rouge]\n* https://www.ruby-lang.org/en/[Ruby]\n* {SocketCAN-userspace-utilities-and-tools}\n\n== Code of Conduct\n\nRefer to the project's link:CODE_OF_CONDUCT.adoc[Code of Conduct] for details.\n\n== License\n\nThis 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].\n\n© 2021 Jordan Williams\n\n== Authors\n\nmailto:{email}[{author}]\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwillikers%2Fcan-utils-image","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjwillikers%2Fcan-utils-image","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwillikers%2Fcan-utils-image/lists"}