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.
Collabst allows you to collaborate on Typst projects and preview them while editing in your browser. Here are its main features:
And much more!
If you want to learn more about the design choices behind Collabst's interface, click here.
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 -dYour instance will be available at the WEB_URL you configured.
Tip: Generate a secure secret key with
openssl rand -hex 32.
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 -dFor the complete setup instructions, you can follow the SETUP.md file.
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.
This project could not exist without:
- The open source Typst Compiler
- Myriad-Dreamin's integrated language service Tinymist and JavaScript implementation typst.ts
- Codemirror
- Levi Zim's Code Mirror extension for Typst support codemirror-lang-typst
- Lucide's very clean icons.
For a more in-depth description of the tech used in Collabst, you can click here.
Contributors
Collabst was created by
|
Damien Guillotin Optimizations, Front & Backend |
Edgar Remy UX Design, Visuals & Frontend |
Maxime Vaillant CI/CD Setup |
Travis Seng Optimizations, Front & Backend |