Kolo 0.1.0 beta is out

Kolo 0.1.0 is a beta with 21 Go libraries, four example apps and starters. Here is what beta means, where to start and what is not there yet.

A ring drawn only part of the way, with two peers on it and a third place still empty.

Kolo 0.1.0 is out, and it is a beta. Kolo is a set of small Go libraries for building peer-to-peer apps. Peers find each other, connect directly and keep a signed log, with no server in the path of your data. This post says what is in 0.1.0 and what beta means, so you can decide how much to rely on it today.

What is in 0.1.0

  • 21 libraries. Each is its own Go module with its own docs, and none needs the whole stack. Together they cover peer identity, a signed log and its storage, finding peers, encrypted connections, sync, files, and live audio and video. The Stack page lists them all.
  • Four example apps: Kolo Chat, Kolo Share, Kolo Meet and Kolo Board, a chat, a file sharing app, a video call app and a shared board. The Kolo team wrote them to show the libraries working together. They are demonstrations, not products, and they are beta too.
  • Starters for the chat app, the video call app and a shared document in two terminals. Each starter is the scaffold of a tutorial in the docs.

The libraries are MIT or Apache-2.0, your choice. The open source page lists what they are built on.

What beta and experimental mean

  • The API can change before 1.0.0. Plan to update when a new release comes out.
  • Only the latest 0.x release of a library receives security fixes.
  • The docs give no speed or connection time figures for real networks, and Kolo makes no promise about them yet. Measure it for your case before you rely on it.
  • By default peers meet through two public entry nodes that Ciranda runs, free, with no uptime guarantee while Kolo is a beta. You can run your own entry node instead.
  • There is no public relay and no public pin. A relay helps two peers that cannot reach each other, and it is off unless you turn it on. You run your own.

The security model is written down in the docs, with every limit, and the Security page has the short version. Read it before you rely on Kolo.

Where to start

Start with the docs. The main tutorial, Build a chat in your terminal, takes two peers on your computer from nothing to a working chat, step by step. Each library has its own page with its API and its limits, and the examples are on Built with Kolo.

What is not there yet

  • The gossip and MLS libraries. They are still in development and come later.
  • IPv6. Kolo is IPv4 only, and the docs say so on every page where it matters.
  • A stable API. It is for 1.0.0.

Report a problem

Open an issue in the repository of the library or the app, under github.com/ciranda-dev. Say what you did, what you expected and what happened. Issues are answered as time allows, and a response time is not guaranteed. For a security problem, do not open a public issue: use the private security report of the repository.