Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time

A truly private space for you and your friends

What is Zusam ?

Zusam (/tsuˈzam/) is a free and open-source way to self-host private forums for groups of friends. Composed of a server written in PHP exposing a REST API and a lightweight webapp, Zusam is extensible and easy to install.
The goal is to make a stable, extensible, lightweight and user-friendly way to self-host private social groups.

More screenshots here

Demo

You can test Zusam right now on https://demo.zusam.org
The login is "zusam" and the password is "zusam". The instance is reset every hour.

Features

  • Links preview and embedded youtube, vimeo, imgur, soundcloud, twitch, bandcamp...
  • Video and image upload
  • Photo albums
  • Public link generation for messages
  • Completely responsive and mobile friendly
  • Low server footprint

Deployment

Zusam is composed of a PHP server and a single-page-application. The backend uses Symfony and Sqlite, the frontend is made with Preact and ParcelJS.

Requirements:

  • PHP 8.0+ (with iconv, mbstring, curl, xml, sqlite3 and imagick extensions)
  • Ffmpeg 3+

Installation guides:

Status

The project has the goal of being really stable for the backend once 1.0 is hit. That means no database structure changes, an update system and a stable API.
The webapp can still change a lot after that point.
For now, Zusam is completely usable in a day-to-day basis but is subject to significative evolutions with upcoming updates and doesn't guarantee backwards compatibility.
I try my best to make updates as easy as possible.

Webapp compatibility

The webapp targets Firefox ESR and at most one-year old Chrome.
It should work on the latest versions of Edge and Safari but is not tested on them.

Contributing

Zusam is free and open-source software licensed under AGPLv3.
You can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository.