https://github.com/zusam/zusam

Private groups to share messages, photos, videos, links with friends and family.
https://github.com/zusam/zusam

agplv3 family forum friends group photo php preact privacy private self-hosted selfhosted sharing sqlite symfony symfony-application video

Last synced: 3 months ago
JSON representation

Private groups to share messages, photos, videos, links with friends and family.

• Host: GitHub
• URL: https://github.com/zusam/zusam
• Owner: zusam
• License: agpl-3.0
• Created: 2017-12-03T16:41:04.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-04-12T15:01:49.000Z (7 months ago)
• Last Synced: 2024-04-13T09:08:14.715Z (7 months ago)
• Topics: agplv3, family, forum, friends, group, photo, php, preact, privacy, private, self-hosted, selfhosted, sharing, sqlite, symfony, symfony-application, video
• Language: PHP
• Homepage: http://zusam.org
• Size: 64.5 MB
• Stars: 169
• Watchers: 10
• Forks: 14
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    



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](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](https://symfony.com) and [Sqlite](https://sqlite.org),

the frontend is made with [Preact](https://preactjs.com) and [ParcelJS](https://parceljs.org).

Requirements:

- PHP 8.1+ (with iconv, mbstring, curl, xml, sqlite3 and imagick extensions)

- Ffmpeg 3+

Installation guides:

- [Debian buster with nginx](documentation/debian-buster-nginx.md)

- [Debian buster with apache](documentation/debian-buster-apache.md)

- [Docker](documentation/docker.md)

## 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](https://www.gnu.org/licenses/agpl.html).  

You can open issues for bugs you've found or features you think are missing.

You can also submit pull requests to this repository.

Zusam is being translated using [Weblate](https://hosted.weblate.org/projects/zusam/core/):