Getting Started

Venn is billing system that you can deploy on your own infrastructure. This all starts with the Venn Agent.

The agent is a standalone application that can be easily configured to talk to billing vendors and databases. It is also the primary ingress for billing events. Written in Clojure, it comes in two flavors: a Docker image or a standalone, pre-built JAR file.

Clojure currently supports all LTS version of Java. Those versions are currently Java 8, Java 11, and Java 17. We run CI again Java 11 and Java 17 but official releases of the agent only target Java 17. Java 8 is not supported at this time.

Using the Venn Agent as a library is not supported at this time.

Installing via Docker

The preferred way to run the agent is via Docker. We have three tagged versions of our image:

• main which refers to a snapshot of what is on the main branch. This tag is updated on ever PR merge, so use at your own risk.
• latest which refers to the latest release
• A specific SEMVER that points an individual release

Images are currently pushed to our GitHub Docker Registry.

To run the agent via Docker, first follow the instructions on GitHub to pull the image. Remember, the main tag points to whatever is on the main branch which could be unstable. The recommended tags are either latest or a specific release.

Once you pulled the image, the agent can be started via docker run like so:

docker run agent:TAG

Using the Stand-alone JAR

A standalone release jar file is also included with every release and can be downloaded. We build the jar for all LTS versions of Java.

Once downloaded, you can run your jar like so:

java -jar target/agent-standalone.jar