Skip to content
Projects

eseifert/altero has 235 GitHub stars and 8 forks. GitHot measured +1 stars in 24 hours. Last checked 2026-11-15 23:42 UTC. Last push 2026-11-15.

How these counts are measured

Measured star growth

in 24h
+1
in 7 days
Collecting history
in 15 days
Collecting history
in 1 month
Collecting history

Net star changes over overlapping periods, not daily totals. Missing measurements are left blank. Stars measure attention, not software quality.

About

Self-hosted sync server for Zotero — keep libraries, groups, notes and attachments on your own infrastructure using the unmodified desktop client

Self-hosted

README.md

Original

altero

Your Zotero library. Your server.

Release candidate: 1.0.0-rc.1. Feature work is frozen for 1.0.0; remaining changes are fixes, documentation and translations. See the release notes and validation record.

CI License: AGPL-3.0-or-later Python 3.14+ GitHub stars Documentation

altero is a self-hosted synchronization server for Zotero. Use the normal Zotero Desktop application to keep personal and group libraries on infrastructure you control. A browser interface lets you manage references, notes, attachments, collections and accounts alongside it.

  • Synchronize library data and files, including notes and annotations.
  • Use SQLite for a small installation or PostgreSQL for concurrent users.
  • Share collections by link and manage group membership and permissions.
  • Set up institutional sign-in and limited access for other applications.
  • Offer verified-email account requests with administrator approval, domain restrictions and durable abuse limits.
  • Run one application, one database and one attachment directory.

[!WARNING] This is the first release candidate for 1.0.0, ready for final testing before the stable release. Keep current backups of your libraries. Back up the server database and attachment storage together before upgrading.

Try it locally

With Docker and Docker Compose installed:

mkdir altero && cd altero
curl -fsSLO https://raw.githubusercontent.com/eseifert/altero/master/docker/compose.yaml
docker compose up -d

Open http://localhost:8000/app/ and register the first account. That account administers the instance. Claim it before exposing a fresh instance publicly. The default image tag is latest, including prereleases.

[!IMPORTANT] Set the streaming URL too. Leaving it unchanged can send your altero API key to zotero.org. A profile that has synced before also needs special handling.

In a test Zotero Desktop profile, open Settings → Advanced → Config Editor and set both preferences:

extensions.zotero.api.url = http://localhost:8000/
extensions.zotero.streaming.url = ws://localhost:8000/stream

Keep the API URL's trailing slash and restart Zotero. Then open Settings → Sync → Link Account, sign in through the browser and approve.

This setup is local to your computer. Follow Deployment before making it available to other people. That guide also covers source installation, image pinning, HTTPS, upgrades and backups.

Is it right for you?

altero hosts the synchronization service itself. WebDAV hosts only personal attachment files while library data still goes through zotero.org. See Why altero exists for the tradeoffs.

The desktop application works without patches. Official mobile apps do not offer a server setting and need a separate build; altero does not distribute one. See client setup.

The browser covers everyday reference management. Use Zotero Desktop for offline access, PDF annotation and other reader workflows. What works describes features, known limits and links to recorded compatibility checks.

Documentation

Read the full documentation at https://altero.run/, or start here:

Goal Guide
Install and connect Zotero Getting started
Use altero in a browser Web interface
Run and maintain a server Deployment
Manage accounts and policies Administration
Find a setting Configuration
Develop or help test Contributing

Help improve altero

Testing another operating system, reviewing these guides or improving a translation is as useful as writing code. The contributor guides explain how to get started.

For a bug report, include what you expected, what happened, steps to reproduce, and the altero and client versions, operating system and deployment method. Remove credentials and private library content from logs before opening an issue.

Relationship to Zotero

altero is independent and is not supported by the Zotero project. It implements the published Zotero Web API and follows the behavior clients expect, using the open-source desktop client and reference server.

Hosted sync at zotero.org remains convenient and helps fund Zotero's development. altero is another option for people who need to operate their own service.

License

GNU Affero General Public License, version 3 or later.