Local-development note: running `libsql-server` as a resource in a TDK landscape (and one question)

Open
#2,284 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 11 days

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Active
Tech stack
docker, node.js, rust
Domain
databases, devops

Research direction

Start with the setup described in this issue and inspect the linked TDK examples, including the Dockerfile and turso-app checks. Done means providing a maintainer-confirmed answer about the recommended local-development server image; the issue explicitly requests no documentation or code change.

Written by the indexing model from the issue text.

Description

Hello, and thank you for libSQL and Turso.

I help maintain TDK, an open-source (MIT) local multi-service runner: each service has a service.json and tdk up starts them with Docker, Tilt and Traefik on a developer's laptop. It is not a deploy tool. We keep runnable examples of other tools running inside it, and I added one for libSQL.

What we did (nothing is needed from you):

  • We run ghcr.io/tursodatabase/libsql-server:latest as a resource, wrapped in a three-line Dockerfile that only sets SQLD_HTTP_LISTEN_ADDR=0.0.0.0:$PORT, because TDK assigns each service a port and the image listens on 8080.
  • A small Node service connects to it with @libsql/client over HTTP. Its health route creates a table, inserts a row and reads it back, so a 200 means the database answered.
  • Both ran together through a real tdk up: the app reached the server by its name on the Docker network, and the round trip worked (sqld 0.24.33, checked on an Apple Silicon Mac).
  • The examples and the checks are here: https://github.com/tdk-landscape/tdk-cli-core/tree/main/examples/byo/turso (and turso-app next to it).

What we did not test: Turso Cloud and auth tokens, libsql:// and file URLs, embedded replicas and sync, persistence across container restarts, x86_64, and anything about performance or scale.

One question, if you have a moment: for local development in a container, is libsql-server still the image you would point people to, or is a server image of the newer Rust turso database planned? We used libsql-server because it is the published image, and we would rather point to the right one.

There is no request to add TDK anywhere in your docs. Feel free to close this whenever it has been answered, and thanks again for your time.

(Written with AI assistance, and I'm one of the TDK maintainers.)

Dominant language
C
Stars
17.3k
Forks
562
Avg merge
10d 15h
Merged PRs (30d)
1

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from tursodatabase/libsql

All issues in tursodatabase/libsql

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.