![Zus.am]()
Zus.am
Container
Zusam is a free and open-source way to self-host private forums for groups of friends.
Image details
Source details
Configuration
TypeContainerlinuxzusam/zusam4180:8080/tcp/zusam/data : /portainer/Files/AppData/Config/ZusamINIT_USER=email@domain.exampleINIT_PASSWORD=initpass zusamunless-stoppedTemplate by xneo1
Standalone Install
Select an install method, to see config/commands for deploying Zus.am
Install on Portainer
Import all app templates into your Portainer instance, for easy 1-click deploys
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select Zus.am, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
More install options in our documentation, or see zusam/zusam for app-specific guidance.
Zusam
ZusamA 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.
Demo
You can test Zusam right now on https://demo.zusam.orgThe 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
Contributing
Zusam is free and open-source software licensed under AGPLv3.Head over to the github repository to open issues for bugs and features.
Serve Zus.am on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.
Proxying zus-am.example.com to http://Zusam:8080
Add this to your Caddyfile
zus-am.example.com {
reverse_proxy http://Zusam:8080
}Check the logs first
Nine times out of ten the logs tell you exactly what went wrong.
- In Portainer, go to Containers, click the container, then Logs. Or run
docker logs Zusam - Exit codes help too:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Port already in use
If deployment fails with "Bind for 0.0.0.0:4180 failed: port is already allocated", something else on your server is using that port.
- Find what's using it:
sudo ss -tlnp | grep :4180 - Stop the other service, or pick a different host port. In
4180:8080only the left number is yours to change, the right one belongs to the app.
Running but the page won't load
The container is up but nothing appears in your browser.
- Use your server's real IP:
http://your-server-ip:4180. The 0.0.0.0 link Portainer shows isn't a real address. - Give it a minute after first deploy, Zusam can take a while to initialise.
- Make sure your firewall allows the port, e.g.
sudo ufw allow 4180
Permission denied on volumes
If the logs show "permission denied", the app can't write to its data folder on the host.
- Fix the ownership:
sudo chown -R 1000:1000 /portainer/Files/AppData/Config/Zusam
Image won't pull
Test the pull directly on the host: docker pull zusam/zusam
- "manifest unknown" means the tag no longer exists. This template uses
latest, so try pinning a specific version instead. - "toomanyrequests" is the Docker Hub rate limit. Log in with
docker loginto raise it. - "no space left on device" means a full disk. Reclaim space with
docker system prune
"exec format error"
This means the image was built for a different CPU architecture than your server.
- This image supports:
amd64 - Check yours with
uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.
Container keeps restarting
The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.
- Check the logs right after a restart, the last few lines before it died are the useful ones.
- Get the exit code with
docker inspect Zusam --format '{{.State.ExitCode}}' - Still stuck? Redeploy once with the restart policy set to
noso the failure stays visible.
Raise an issue
Found something which isn't working as it should? Here's how to report it.
- Bug within the app: Open an issue on zusam/zusam
- Template not working: Open an issue on xneo1/portainer_templates
- This website not working: Open an issue on lissy93/portainer-templates
A single container
Zus.am runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.
The app image
An image is the app packed up ready to go, everything Zus.am needs bundled into one download. This template pulls zusam/zusam, which Docker fetches once (about 100 MB) and then starts your own copy from.
Where the image comes from
Docker pulls its images from registries, public libraries of ready-built apps. Zus.am's comes from Docker Hub, published by zusam.
Version tags
The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 0.6.1. Pin a specific tag if you would rather stay on one version.
Which machines it runs on
Every image is built for particular CPU types. This one ships for amd64, so it runs on regular x86 PCs and servers, though not ARM boards like a Raspberry Pi.
Ports
A port is the door the app answers on. A mapping like 4180:8080 means it's reachable on port 4180 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:4180 in a browser. It opens:
4180:8080, likely the web interface
Volumes
A volume is where Zus.am keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:
/zusam/datafrom/portainer/Files/AppData/Config/Zusamon the host
Environment variables
Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Zus.am takes 2 of them, all with defaults you can leave alone or tweak:
INIT_USER, defaults toemail@domain.exampleINIT_PASSWORD, defaults toinitpass zusam
Restart policy
The restart policy here is unless-stopped, so Docker restarts Zus.am after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).
Networking
Nothing custom is set, so Zus.am sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.
Container name
Once it's deployed, Portainer names the container Zusam. That's what you'll spot in the containers list and use in commands like docker logs Zusam.
Platform
The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.
Open source license
Zus.am is open source, released under the AGPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.
Portainer app templates
Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Zus.am up. Add the template list to Portainer once, then deploying Zus.am is a click rather than a wall of config.