btcpayserver/db-doc-generator

[BREAKGLASS] Append-only mirror of github.com/btcpayserver/db-doc-generator

Go to file

Wouter Samaey 7db2b222eb Initial commit		2021-06-30 10:25:02 +02:00
drivers	Initial commit	2021-06-30 10:25:02 +02:00
images	Initial commit	2021-06-30 10:25:02 +02:00
output	Initial commit	2021-06-30 10:25:02 +02:00
.gitignore	Initial commit	2021-06-30 10:25:02 +02:00
generate.sh	Initial commit	2021-06-30 10:25:02 +02:00
README.md	Initial commit	2021-06-30 10:25:02 +02:00
schemaspy.properties	Initial commit	2021-06-30 10:25:02 +02:00

README.md

DB Documentation Generator for BTCPay Server

This tool allows you to generate interactive documentation for BTCPay Server's database by using SchemaSpy.

Requirements

A running database to analyse (settings are in schemaspy.properties)
Docker

How to generate?

Start a local development setup of BTCPay Server (typically docker-compose up dev)
Run the shell script generate.sh
The output will be generated in /output

How to view?

Navigate to /output/index.html with your browser.

Notes

This script generates output with SVG images. If you prefer PNG, you can change schemaspy.properties to do so.
A full DB drawing is available at /output/diagrams/summary/relationships.real.large.svg

Screenshots

Some screenshots of the output you'll get.

Tables

Columns

Constraints

Relationships

Utility

Anomalies

Routines