Personal Typst Browser

Browse your personal typst files. Written in Rust with axum.

You can preview or download every file you want. Typst files are compiled on the fly and sent over as a pdf.

Example of the root page:

Note that nothing is cached, meaning it could take up to a few seconds to compile and download a typst file. But most of the times the request will complete in under a second.

Deploy

The easiest way to deploy this is with Docker Compose:

services:
  typst-browser:
    image: ghcr.io/theblckbird/personal-typst-browser
    ports:
      - 80:3000 # Choose whatever port you want
    volumes:
      - /local/path/to/files:/files # Example mount for the files that are to be served.
      - ./.env:/app/.env

Example .env file:

# root directory of the typst content
ROOT_DIR=/files

# Comma seperated values of ignored files
EXCLUDE_FILES=.DS_Store,.git

# Prefix of the URL this is ultimately served on
URL_PREFIX=http://example.com

# Host and port. Set to 0.0.0.0:3000 by default
HOST=0.0.0.0:3000

License

This code is licensed under MIT