Skip to content

Installation

  1. Set up a Fabric Server for 1.17
  2. Install Fabric API
  3. Install Fabric Language Kotlin
  4. Install Ledger
  5. Run the server
  6. Adjust config as needed

Run into any issues? Join our Discord for support!

Other Databases

Ledger supports other databases like MySQL, PostgreSQL and H2 with the help of the Ledger Databases extension.

H2

H2 is another flat-file database like the default sqlite that may yield faster results but is more experimental.

Add the following to the bottom of your Ledger config file:

[database_extensions]
database = "H2"

MySQL

MySQL requires running a separate MySQL database and more setup than just plug and play SQLite, but can support much larger databases at faster speeds. It also supports MySQL based databases like MariaDB.

Add the following to the bottom of your Ledger config file:

[database_extensions]
database = "MYSQL"
url = ""
username = ""
password = ""
properties = []

url: Must be URL of database with /<database_name> appended. An example URL would be localhost/ledger. You can optionally add port information such as localhost:3000/ledger

PostgreSQL

PostgreSQL requires running a separate PostgreSQL database and more setup than just plug and play SQLite, but can support much larger databases at faster speeds. It is more experimental the MySQL but may yield faster performance.

Add the following to the bottom of your Ledger config file:

[database_extensions]
database = "POSTGRESQL"
url = ""
username = ""
password = ""
properties = []

url: Must be URL of database with /<database_name> appended. An example URL would be localhost/ledger. You can optionally add port information such as localhost:3000/ledger

Connector properties

For some databases, such as MySQL, you can provide properties to the database connector. For each property, add a string entry to the properties array.

properties = ["useJDBCCompliantTimezoneShift=true", "useLegacyDatetimeCode=false", "serverTimezone=UTC"]