Comment on page

Local Deployment

Many developers prefer to deploy new software within their local environment to explore the new technology and kick the software tires around. Any License can be used for your Local deployment, while the Developer License is restricted to Local Deployments only. The License Keys enable developers to spin up and down instances of the platform locally on the developer's machine allowing for local development and testing without affecting the remotely deployed platform configuration.
Contact [email protected] to acquire a License

Docker Compose Local Deployment utilizes Docker Compose to define and run the containers necessary to locally install the Enterprise platform. It's recommended you review the Prepare Your Environment section of the Self-Hosted Deployment guide to learn more about Docker Desktop before continuing with the Local Deployment walkthrough.

Download The Docker Compose File

Now that we have Docker Desktop running, navigate to the Deploy repo. Click the deployments/compose folder and download the file which holds the necessary files to install and run the containers. Locate the zip file on your Local Machine and unzip it into a folder.

Setting The License Key

Open the zipped folder within your preferred IDE, click the .env file, and locate the following line.
Change YOURLICENSE to the Enterprise License key distributed to you by
Contact [email protected] to inquire about a license.

Installing Using Docker Compose

After saving the .env file, change your terminal directory to your deployment folder and run the following command.
docker-compose up --detach
This will start the platform containers and Mongo Database within your local machine.

Authenticating Into The Portal

After the installation process has been completed, navigate to the following URL to access the Local Deployment.
To authenticate into the platform, use the following credentials:
Edit the .env file to modify the authentication credentials for the local deployment.

Data Access Folder

All MongoDB data as well as PDF files are stored within the local data directory which is part of the deployment folder.

Additional Software and Technology

The next section will detail additional software you can install to facilitate things like File Storage and Container Management within your local environment.