Running Panache Legal with Docker¶
The easiest way to get the Panache Legal Platform up and running is to use Docker. Docker provides a way of packaging applications in a container which can be run locally, in an on premise environment, or via a platform like Microsoft Azure App Service. When running Panache Legal via docker everything you need is included within the container meaning that as long as you have Docker installed you have everything you need to run Panache Legal.
All Panache Legal Platform containers are distributed via the Panache Software Docker Hub, here you can find docker containers for all the components of the Panache Legal platform distributed as Linux containers (that can be run on Windows, Mac or Linux) as well as Linux ARM32 containers suitable for running on ARM platforms like the Raspberry Pi.
0 to LegalTech in 3 minutes¶
Once you have Docker installed on your system and have a database available it’s possible to get Panache Legal up and running in as little as 3 minutes, just watch this video to see an example of getting Panache Legal up and running on a Raspberry Pi.
This guide provides you with details to get you up and running with Panache Legal in a Windows 10 environment. The principal will be the same in other enviornemnts (like Mac and Linux) so you should be able to adapt these instructions by making adjustments to the docker compose file.
Panache Legal is currently in early alpha development and is not suitable for production environments, it should only be used for early testing.
Panache Legal containers currently include a development build of the software and do not support features like HTTPS to prevent complications with certificates.
The current build of Panache Legal supports Microsoft SQL Server and MySQL.
What follows is a step by step guide to running Panache Legal using Docker on Windows but the TL;DR is.
For Windows you will need to install the Docker Desktop application. Under Windows Docker requires that Hyper-V is installed (Available in Windows 10 Pro).
You can enable Hyper-V via Windows ‘Apps and Features’.
- Right click on the Windows button and select ‘Apps and Features’.
- Select Programs and Features on the right under related settings.
- Select Turn Windows Features on or off.
- Select Hyper-V and click OK.
Setup Database Server¶
The Panache Legal Platform requires either a Microsoft SQL Server or MySQL database. Depending on your situation you may have a local database server installation, an on premise server that you have access to, or a hosted database server provided through a service like Microsoft Azure.
Usage of Microsoft SQL Server requires a licence and so your use case will be specific to you and/or your organisation.
In this example we will use a MySQL Linux docker container. You could alternatively use a Microsoft SQL Server Linux container with the free developer licence. This licence includes some limitations on how it can be deployed and you should make sure to read the licence details on the docker hub page, as well as checking which edition will be suitable for your use case.
If you are not using the docker container version of MySQL or Microsoft SQL Server as per this guide and instead will connect to your own database installation you will need to ensure you have a valid connection string to access your database.
Download Docker compose file¶
You can download an example docker compose file via the following link.
Steps to run:
Place downloaded docker-compose.yml file in a directory of your choosing.
Right clieck on the Windows button and select ‘Windows PowerShell’.
In Windows Powershell navigate to the directory where you stored docker-compose.yml.
Type the following command:
docker-compose up -d
This will download all the containers from the Docker Hub and start them up.
Time to download and start all containers will depend on your internet connection and the performance of your computer.
This docker compose file will download and start a Linux based MySQL container to store the Panache Legal Platform databases, because several of the containers require this to be in place before they can run correctly if you open the docker dashboard (via the docker desktop application) after running the command above you may see containers that fail to start.
If this happens simply click on the Start button next to any containers that are not running until all have started correctly
Once all containers are running open a web browser and navigate to http://host.docker.internal:55001 to open the Panache Legal Platform. You can use the following details to login (assuming you did not change the PanacheSoftware__StartDomain environment variable to a different domain).