Manage the application lifecycle
In this guide, we'll show you how to manage the lifecycle of your pdf2Data Editor application using the native docker-compose command, as well as a helper script we've developed to simplify the process
Docker compose
We assume that all the commands below are executing in the Application directory, which contains docker-compose.yml and .env files.
You can start the application from command line you by execuing the following command
docker-compose up -d
To stop the application it is required to run the following command in the folder which contains the above-described docker-compose.yml and .env files.
docker-compose down
Helper script
If pdf2Data Editor is installed using the Kotlin helper script, we recommend you to continue using that script for the Application lifecycle management.
Stopping the application
kotlinc -script deploy-docker-compose-x.y.z.main.kts -- stop
Starting the application after it has been stopped
kotlinc -script deploy-docker-compose-x.y.z.main.kts -- start
Updating the application version
Please make sure to back up your data (as well as data of the SDK/API instances that you set up) before performing an update.
The containers will be recreated during the application update. The data that is not persisted to Docker volumes will be lost.
kotlinc -script deploy-docker-compose-x.y.z.main.kts -- update
While updating the application won't be available.
Undeploying / removing the application
These operations are irreversible and may cause data loss. Data in containers that are not persisted to Docker volumes will be lost.
To undeploy the application, i.e remove containers and networks from Docker, execute the following command:
kotlinc -script deploy-docker-compose-x.y.z.main.kts -- undeploy
To completely remove the application, including all the Docker volumes and data from the application directory, use the following command:
kotlinc -script deploy-docker-compose-x.y.z.main.kts -- remove
After completing, you can remove your application directory.