Add prebuilt image to README

This commit is contained in:
2026-07-18 15:06:12 -04:00
parent 630b668760
commit be6dce4d4a
+45 -6
View File
@@ -1,6 +1,6 @@
# TypstDrive # TypstDrive
[![Version](https://img.shields.io/badge/version-1.4.8-blue.svg)](https://github.com/your-username/typstdrive) [![Version](https://img.shields.io/badge/version-1.4.8-blue.svg)](https://github.com/sirblobby/typstdrive)
[![Typst Version](https://img.shields.io/badge/Typst-0.14.2-239dad?logo=typst&logoColor=white)](https://typst.app/) [![Typst Version](https://img.shields.io/badge/Typst-0.14.2-239dad?logo=typst&logoColor=white)](https://typst.app/)
[![Rust](https://img.shields.io/badge/Rust-1.82+-orange?logo=rust&logoColor=white)](https://www.rust-lang.org/) [![Rust](https://img.shields.io/badge/Rust-1.82+-orange?logo=rust&logoColor=white)](https://www.rust-lang.org/)
[![SvelteKit](https://img.shields.io/badge/SvelteKit-5-ff3e00?logo=svelte)](https://kit.svelte.dev/) [![SvelteKit](https://img.shields.io/badge/SvelteKit-5-ff3e00?logo=svelte)](https://kit.svelte.dev/)
@@ -105,21 +105,60 @@ TypstDrive is completely self-hostable. A Docker image packages both the Rust ba
### Getting Started ### Getting Started
1. Clone the repository: 1. Pull the image:
```bash ```bash
git clone https://github.com/your-username/typstdrive.git docker pull ghcr.io/sirblobby/typstdrive:latest
cd typstdrive
``` ```
2. Start the application: 2. Save this as `docker-compose.yml`:
```yaml
services:
app:
image: ghcr.io/sirblobby/typstdrive:latest
container_name: typstdrive
restart: unless-stopped
ports:
- "3000:3000"
environment:
- DATABASE_URL=sqlite:///data/typstdrive.db?mode=rwc
- DB_TYPE=sqlite
# Generate with: openssl rand -hex 64
- COOKIE_SECRET=your-64-plus-byte-secret-here
- ALLOW_REGISTRATION=false
- RUST_LOG=info
volumes:
- appdata:/data
volumes:
appdata:
```
3. Start it:
```bash ```bash
docker compose up -d docker compose up -d
``` ```
3. Open your browser and navigate to `http://localhost:3000`. 4. Open your browser and navigate to `http://localhost:3000`.
On first launch with no users in the database, you will be redirected to the **Setup** page to create the initial admin account. On first launch with no users in the database, you will be redirected to the **Setup** page to create the initial admin account.
To update, pull the new image and recreate the container:
```bash
docker compose pull
docker compose up -d
```
### Building from Source
To build the image yourself instead of pulling it, clone the repository and use the bundled compose file, which builds from the local `Dockerfile`:
```bash
git clone https://github.com/sirblobby/typstdrive.git
cd typstdrive
docker compose up -d
```
### Data Storage ### Data Storage
By default, TypstDrive uses **SQLite** — no separate database container required. All data is stored in a single file persisted via the `appdata` Docker volume. By default, TypstDrive uses **SQLite** — no separate database container required. All data is stored in a single file persisted via the `appdata` Docker volume.