Skip to content

README.md

Latest commit

 

History

History
117 lines (77 loc) · 2.55 KB

README.md

File metadata and controls

117 lines (77 loc) · 2.55 KB

Synkronus Quickstart

Welcome! This repository provides a ready-to-run setup of ODE: Synkronus, including a Postgres database, so you can try it out quickly or use it as a starting point for your own deployments.

Features

  • Fully containerized Synkronus server
  • Includes Postgres database
  • Supports local usage and GitHub Codespaces
  • Easy environment variable configuration

Quick Start

Local Installation

  1. Clone this repo:
git clone https://github.com/OpenDataEnsemble/synkronus-quickstart.git
cd synkronus-quickstart
  1. Adjust env variables the docker-compose.yml file.
  • In the postgres service:
    • POSTGRES_PASSWORD
  • In the synkronus service:
    • DB_CONNECTION (update to match POSTGRES_PASSWORD)
    • JWT_SECRET (generate a new one with: 'openssl rand -base64 32')
    • ADMIN_USERNAME
    • ADMIN_PASSWORD
  1. Start the services:
docker compose up -d
  1. Verify the server is running:
curl http://localhost:8080/health
# Should return "OK"

Optionally you can choose to map the volumes to specific mountpoints on the host.

Follow the steps from above, but after step 2 do:

  1. Prepare a database for synkonus

Start only the db service from Docker Compose:

docker compose up db

This will start the database container and keep it running in the foreground.

In a separate terminal, make the create_sync_db.sh script executable:

chmod +x ./create_sync_db.sh

Then run the script to create the Synkronus database and user:

./create_sync_db.sh

The script will connect to the running db container and set up the required database and user account.

  1. Start the rest of the services:
docker compose up -d
  1. Verify the server is running:
curl http://localhost:8080/health
# Should return "OK"

Using GitHub Codespaces

  1. Click “Open in Codespaces” on this repository.
  2. Codespaces will automatically start Synkronus + Postgres.
  3. Check the Ports tab for the forwarded port to access the API.
  4. Test the server:
curl <forwarded-url>/health

Notes:

  • No UI yet — the API is used with 'Formulus' or 'synkronus-cli'.
  • Perfect for experimenting or as a base for production setups.

Contributing / Feedback

We welcome feedback! Feel free to open issues or pull requests. If you’re trying this out for the first time, check the Codespaces instructions for the quickest setup.

Enjoy exploring Synkronus!