https://github.com/f18m/go-baresip

https://github.com/f18m/go-baresip

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/f18m/go-baresip
• Owner: f18m
• License: bsd-3-clause
• Created: 2025-11-02T21:37:55.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2025-11-20T17:51:35.000Z (9 months ago)
• Last Synced: 2026-01-22T12:12:20.003Z (7 months ago)
• Language: Go
• Size: 22.8 MB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/f18m/go-baresip/main.yaml)

[![Go Reference](https://pkg.go.dev/badge/github.com/f18m/go-baresip.svg)](https://pkg.go.dev/github.com/f18m/go-baresip)

# go-baresip

This repository provides a tiny wrapper around [baresip](https://github.com/baresip/baresip)

in the form of a few Golang packages.

An example golang application using these packages is available as [example](./example/main.go).

## How it works

* allocating the `Baresip` struct, an instance of the `baresip` binary will be started in the background; such binary is not provided from this repository, see [baresip](https://github.com/baresip/baresip) for information on how to install it; the `baresip` instance will live as much time as the golang `Baresip` type;

* the `baresip` binary will process a number of configuration files like `~/.baresip/accounts`, `~/.baresip/config`, etc (see https://github.com/baresip/baresip/wiki/Configuration); such configuration files are not provided by this repository; however this repository will read the `ctrl_tcp_listen` parameter from `~/.baresip/config` to locate the TCP port for controlling baresip;

* the golang `Baresip` type will connect to the TCP port and will listen to `baresip` notifications (e.g. "incoming call", etc) and provides easy methods to send commands to the `baresip` binary

## Typical Application

Since `baresip` has many dependencies (mainly to support a wide variety of audio and video CODECs), several config files, and is not widely available as native package (e.g. RPM, Debian pkg), the intended usecase for this library

is to run your golang application within a Docker container containing also your custom build of the `baresip` binary with all required dynamic libraries and configuration files.

```mermaid

---

config:

      theme: redux

---

flowchart TD

      CLIENT("Actual client")

      subgraph docker [Docker container]

      BARESIP("baresip VOIP client")

      DEPENDENCIES(["Baresip dependencies:
audio codecs, modules, etc"])

      GOLANGAPP("Your golang app
(using go-baresip)")

      BARESIP --Uses--> DEPENDENCIES

      GOLANGAPP --TCP socket--> BARESIP

      end

      CLIENT --Your Interface (TCP, HTTP, WebSocket, etc)--> GOLANGAPP

```

Of course the `Actual client` and the `golang app` are up to you to design to fit your needs.

Please check the [example](./example/main.go) as a starting point.

## Golang Reference docs

Please check [go-baresip reference docs](https://pkg.go.dev/github.com/f18m/go-baresip) page 

and the [Baresip type docs](https://pkg.go.dev/github.com/f18m/go-baresip/pkg/gobaresip#Baresip) in particular.

## Original project

This repository was born as a fork from https://github.com/negbie/go-baresip, which is unmaintained.

A number of large refactors were done so the project now looks quite different compared to that

starting base.