germanorizzo/ws4sqlite repository overview

⁠🌱 ws4sqlite

ws4sqlite is a server-side application that, applied to one or more SQLite files, gives the possibility to perform SQL queries and statements on them via REST (or better, JSON over HTTP).

Possible use cases are the ones where remote access to a SQLite db is useful/needed, for example a data layer for a remote application, possibly serverless or even called directly from a web page (after security considerations of course).

Please read the full docs⁠, a tutorial⁠ is also provided.

⁠Docker image

The image is based on distroless/static-debian11. It's a multiarch image for amd64, ARM/v7 and ARM64/v8.

Here are the relevant configurations:

⁠Example

docker run -d \
 --restart=unless-stopped \
 --name=ws4sqlite \
 -p 8080:12321 \
 -v /mnt/DockerHome/myDir:/data \
 --user 1000:1001 \
 -e TZ=Europe/Rome \
 germanorizzo/ws4sqlite:latest \
 --db /data/testDb.db

This command will install and run ws4sqlite, configuring it to:

• Use port 8080 (Line 4);
• Map a local dir to path /data in the docker environment (Line 5);
• Starts ws4sqlite as user 1000, group 1001 (Line 6);
• Sets the time zone (Line 7);
• Use free cli arguments, as it was the ws4sqlite binary (Line 9).

The rest of the lines in this example are standard Docker.

⁠Important

• It's important to use --user, otherwise ws4sqlite will start with root privileges! You don't want this, as it creates files; for example, backups may potentially overwrite some file or wreak havoc in unpredictable ways (which are actually very predictable, but only after they happen).

⁠Caveats

• You have to reference database and companion files that are in the directory mapped to /data as they were in /data;
• The path for the database file should be absolute, i.e. /data/....