Initial commit

.gitignore

@@ -0,0 +1,3 @@
+.idea/
+output/
+!output/.gitkeep

README.md

@@ -0,0 +1,41 @@
+# DB Documentation Generator for BTCPay Server
+This tool allows you to generate interactive documentation for BTCPay Server's database by using [SchemaSpy](https://github.com/schemaspy/schemaspy).
+
+## Requirements
+- A running database to analyse (settings are in `schemaspy.properties`)
+- Docker
+
+## How to generate?
+1. Start a local development setup of BTCPay Server (typically `docker-compose up dev`)
+2. Run the shell script `generate.sh`
+3. 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
+![Tables](images/screenshot1.png)
+
+### Columns
+![Columns screenshot](images/screenshot2.png)
+
+### Constraints
+![Constraints screenshot](images/screenshot3.png)
+
+### Relationships
+![Relationships screenshot](images/screenshot4.png)
+
+### Utility
+![Utility screenshot](images/screenshot5.png)
+
+### Anomalies
+![Anomalies screenshot](images/screenshot6.png)
+
+### Routines
+![Routines screenshot](images/screenshot7.png)

generate.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+cd "$DIR"
+
+mkdir -p output
+
+docker run -v "$PWD/output:/output" -v "$PWD/schemaspy.properties:/schemaspy.properties" -v "$PWD/drivers:/drivers" --network="host" schemaspy/schemaspy:snapshot

schemaspy.properties

@@ -0,0 +1,9 @@
+schemaspy.t=pgsql
+schemaspy.host=127.0.0.1
+schemaspy.port=39372
+schemaspy.db=btcpayserver
+schemaspy.u=postgres
+schemaspy.p=postgres
+schemaspy.s=public
+schemaspy.imageformat=svg
+schemaspy.hq=true