Skip to content

docs: add initial README.md #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rwaffen merged 2 commits into from
Nov 26, 2025
Merged

docs: add initial README.md #10

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
230658e
docs: add initial README.md
rwaffen Nov 24, 2025
d19e208
Merge branch 'main' into add_readme
rwaffen Nov 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# OpenVoxProject OpenBolt Container

[![CI](https://github.com/openvoxproject/container-openbolt/actions/workflows/ci.yaml/badge.svg)](https://github.com/openvoxproject/container-openbolt/actions/workflows/ci.yaml)
[![License](https://img.shields.io/github/license/openvoxproject/container-openbolt.svg)](https://github.com/openvoxproject/container-openbolt/blob/main/LICENSE)
[![Sponsored by betadots GmbH](https://img.shields.io/badge/Sponsored%20by-betadots%20GmbH-blue.svg)](https://www.betadots.de)

## Introduction

This repository contains a containerized version of [OpenBolt](https://github.com/openvoxproject/openbolt) and plugins to facilitate orchestration with OpenBolt.

## Usage

You can run the container using a container runtime like Podman or Docker.
Here is an example command to run OpenBolt in an interactive terminal, mounting the current directory to `/data` inside the container:

```shell
podman run -it --rm -v $PWD:/data:Z ghcr.io/openvoxproject/openbolt:latest
```

For OpenBolt usage have a look at the upstream documentation <https://github.com/openvoxproject/openbolt>.

## Versions

To see which tool versions are included in the container see:

[build_versions.yaml](build_versions.yaml)

## How to release?

see [RELEASE.md](RELEASE.md)