Compile in Docker Container

[1MisterT]

I am using this package to render pdf docs from a webserver. For the webserver i don't want to install typst on there so im i was wondering, if its possible to use a docker container to run the compiles.

I need to compile a doc with added values like in the following example: https://github.com/Dadido3/go-typst/tree/main/examples/passing-values

All help and ideas appreciated.

[Dadido3]

Hi,

it's already on my to do list, but i haven't got around implementing Docker support. I may have something ready in a few days or so, as it shouldn't be too hard to do. It's basically just another way to invoke the docker executable.

[1MisterT]

Hey Dadido,

thanks for the quick reply, I'll be happy of you give me a short example.

Wonderful package you made there 👌🏼

[Dadido3]

Alright, i updated this module, and it now supports the official Typst Docker image besides other improvement. Make sure you are using go-typst 0.7.0; then you can just run this to check if everything works correctly:

package main

import (
	"bytes"
	"log"
	"os"

	"github.com/Dadido3/go-typst"
)

func main() {
	markup := bytes.NewBufferString(`= Hello world`)

	// Compile the prepared markup with Typst and write the result it into `output.pdf`.
	f, err := os.Create("output.pdf")
	if err != nil {
		log.Panicf("Failed to create output file: %v.", err)
	}
	defer f.Close()

	typstCaller := typst.Docker{}
	if err := typstCaller.Compile(markup, f, nil); err != nil {
		log.Panic("failed to compile document: %w", err)
	}
}

This should create a new PDF document with the text "Hello World".

I also updated the README.md with everything you may need when running the Docker variant.

Feel free to write back if you encounter any other issues or problems. As the code is pretty new and untested (besides the unit tests). There may be bugs or rough edges.

[1MisterT]

The new package is working perfectly.

is there a chance to also run this against an already running container (for example deployed via docker compose)? in theory the commands should only be changed to docker exec instead of run?

Thanks again for the great work.

[1MisterT]

i just tested with docker, the syntax should be docker exec -i <container-name> typst --version or in theory stdin

maybe there could be another field in the typst Docker (definition typst.Docker{containerName: string} ) and when this is set, than the compile uses exec instead of run.

[Dadido3]

Alright, i added a new caller for that:

caller := typst.DockerExec{
    ContainerName: "typst",
}

Otherwise this would have made typst.Docker too complex, as some of the options (Volumes, WorkingDirectory) are not applicable anymore when you use docker exec.

I also added custom Docker CLI options, just in case.

[1MisterT]

Alright, thank you. I'll test it out tomorrow 👌🏼