Install Guide

Ledger requires a modern local server for testing, because servers like XAMPP ship an old MariaDB, and Ledger is configured to use a modern Unicode 14 collation that isn’t available in older server software.

For this reason, Ledger runs locally on Ledger Server, a purpose build server that makes it super simple to test and run Ledger on your PC, before deciding if you want to use it on a live environment.

Ledger is packaged with everything included.

You can still try installing on some other local servers, like WAMP, though I never bothered to test because trying to make Ledger work with XAMPP became an unsolvable nightmare, which made me give up and build something that improves the user experience.

Essentially, the goal was to create a server that more effectively demonstrated how Ledger will perform on a live server environment.

---

Install using Ledger Server (Dev Installer)

Faster install, no config settings, up and running in less than 2 minutes.

1. Download the full Ledger package
2. Create a folder anywhere on your computer, better for a drive with 1GB+ of space
3. Move the zipped file to this folder and extract the contents
4. Rename the file .env.example to .env
5. Open the folder control and double-click the install.ps1 file and allow the installer to complete
6. The installer ran successfully if a new browser window opens with an empty instance of Ledger
7. Use the menu to login (credentials below).

Using the Server

If you have PHP and database software installed on your computer, Ledger will run automatically once it's installed.

If you don't have PHP or database software installed on your computer;

1. Open the folder control and double-click the server.ps1 file
2. This will start a portable instance of PHP and the MariaDB database software.

Login Credentials

email: admin@ledger-demo.local

password: ZpfS40JwVi

Change these if desired once logged in.

Known Issues

Reinstallation

If for what ever reason you want to reinstall Ledger using install.ps1 visit the bin/mariadb folder, and delete the data folder.

Connection Issues

MariaDB can sometimes struggle to connect. This will result in a failed installation. 

When this happens, you will see a php error.

Try to reinstall, delete the data folder as above.

---

PowerShell Server and Other files

More info on Ledger ps1 system

---

Live Installation

A more traditional method of installation.

As above, Ledger doesn't run on XAMPP, 

1. Download the full Ledger package 
2. Create a database within your environment and keep the details safe for later use
3. Create or save the details of your email account - read more on email notifications
4. Open the zipped folder, and navigate to the site folder
5. Move the zipped file to this server location and extract the contents
6. Rename the file .env.example to .env
7. Open the browser to your site domain url /install/index.php 
8. Complete all fields on the form and hit Install
9. Log in using the credential you provided during installation

---

Support

Any problems, report to the Troubleshooting section of the forums.

---

Is this document high quality? Or does it need improvement? High ranking articles display in the footer, admin notified if improvements required.