Skip to content

collabst/collabst

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

262 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

collabst logo

(pronounced collapsed, /kΙ™ΛˆlΓ¦pst/)
Self-host a collaborative workspace for Typst.

GitHub License Β  GitHub Repo stars


Authors Note:
Collabst is aimed at personal collaborative projects and research labs. It is not affiliated in any way with the Typst brand.
We are aware of the delicate balance of the business model behind Typst development. As such, this project does not aim to compete with Typst's official web app.
Furthermore, as stated in the license, we do not provide any guarantees regarding the use of Collabst: If your organization needs to set up a reliable service with professional technical support, we recommend contacting the Typst team directly in order to get a proper paid plan for self-hosting the official web app.

The Collabst project's goal is to help and accelerate Typst adoption, especially in research labs and scientific production. We believe we can contribute to creating the conditions for scientific knowledge to be entirely produced using sovereign tools, with open source software and easy collaboration in mind.


Caution

We recommend using Collabst only in environments where all users are trusted.


πŸ’₯ Features

Collabst allows you to collaborate on Typst projects and preview them while editing in your browser. Here are its main features:

Elegant Light and Dark Theme

dark themed editor screenshot

Dashboard for managing your Projects

dashboard screenshot

Collaborative Editing & Comments

collab editing screenshot comments screenshot

Sweet & snappy animations

file-list animation menubar animation
newfile buttons animation theme toggle animation

And much more!

If you want to learn more about the design choices behind Collabst's interface, click here.

πŸ—οΈ How to Install

Quick SetupπŸƒβ€β™€οΈβ€βž‘οΈ

Make sure you have Docker and Docker Compose installed, then run:

# 1. Download the compose file and env template
curl -o docker-compose.yml https://raw.githubusercontent.com/collabst/collabst/main/docker-compose.yml
curl -o .env https://raw.githubusercontent.com/collabst/collabst/main/.env.example

# 2. Fill in your values (URLs, passwords, secret key)
nano .env

# 3. Start
docker compose up -d

Your instance will be available at the WEB_URL you configured.

Tip: Generate a secure secret key with openssl rand -hex 32.

Nightly builds πŸŒ™

Warning

Nightly builds are built from the latest commit on main and may be unstable or broken. Use them at your own risk.

If you want to try the latest features before a stable release, you can run the nightly image by setting COLLABST_TAG=nightly in your .env file, or by passing it inline:

COLLABST_TAG=nightly docker compose up -d

Detailed SetupπŸ“œ

For the complete setup instructions, you can follow the SETUP.md file.

πŸ‘‹ Contributing

We are looking for contributions to the Collabst project! There are many features that can still be added or refined, and certainly some bugs that could be fixed.

If you want to contribute, please check the CONTRIBUTING.md Guidelines.

πŸ™ Acknowledgements

This project could not exist without:

For a more in-depth description of the tech used in Collabst, you can click here.

πŸ§‘β€πŸ”§ Credits

Contributors


Collabst was created by

Damien Guillotin
Damien Guillotin
Optimizations, Front & Backend
Edgar Remy
Edgar Remy
UX Design, Visuals & Frontend
Maxime Vaillant
Maxime Vaillant
CI/CD Setup
Travis Seng
Travis Seng
Optimizations, Front & Backend


About

Self-hosted collaborative workspace for Typst.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Sponsor this project

Contributors