Skip to content
This repository has been archived by the owner on Feb 7, 2024. It is now read-only.

Zeroed-Books/zeroed-books-api

Repository files navigation

Note: This project is not progressing and has been archived.


Zeroed Books API

GitHub workflow publish status GitHub Container Registry package

A potential replacement for the Zeroed Books API written in Rust using Rocket.

Run Locally

Using docker compose, you can stand up a local version of the application with:

docker compose -f ./docker-compose.base.yml -f ./docker-compose.standalone.yml up

Configuration

For a full list of configuration options, see the help command of the application binary.

zeroed-books-api help

Environment Variables

These attributes are commonly provided through environment variables rather than as CLI flags:

DATABASE_URL: The connection string used to connect to the primary Postgres database.

JWT_AUDIENCE: The identifier for the application that will be used to verify that JWTs are intended for consumption by the application.

JWT_AUTHORITY: The accepted issuer for JWTs.

Deployment

The database must have the uuid-ossp extension enabled:

CREATE EXTENSION IF NOT EXISTS "uuid-ossp";