Deployment

Deployment Guide for the PHYLOViZ Web Platform

Welcome to the Deployment Guide for the PHYLOViZ Web Platform! This guide will provide you with step-by-step instructions on how to deploy the platform in your own environment. By following this guide, you'll be able to set up and configure the PHYLOViZ Web Platform to meet your specific requirements.

Prerequisites

Before proceeding with the deployment, ensure that you have the following prerequisites in place:

• Have Docker installed and running on your system.
• Clone the PHYLOViZ Web Platform repository \cite{a2023_phyloviz}.
• Clone the FLOWViZ repository, configure and deploy it following their provided tutorial.
• Clone the PhyloDB repository, configure and deploy it following their provided tutorial.
• Set up S3 buckets and ensure the file repository is functional.

Deployment Steps

Follow the steps below to deploy the application in a production environment:

1. Start with the configuration of the access management system (Keycloak) as described in the section Authentication > Configuration.
2. Configure the application.yml files with the appropriate settings, including the FLOWViZ, S3, and PhyloDB credentials.
3. Ensure that the workflow templates of the application are also using the correct credentials for the respective data repositories. Tool templates should also be configured with the correct registry IP and network specific configurations.
4. Build the microservices.
5. Run "npm run build" in src/frontend.
6. Launch the Docker containers for the PHYLOViZ Web Platform using the docker-compose.yml file.

By following this deployment process, you will be able to set up and run our application in a production environment successfully. Make sure to carefully execute each step and address any configuration requirements specific to your deployment environment.

Conclusion

Congratulations! You have successfully deployed the PHYLOViZ Web Platform in your environment. By following the deployment guide and completing the necessary steps, you now have a functioning instance of the platform that you can utilize for genetic or epidemiological data analysis.

Remember to regularly update the platform with new releases and security patches to ensure the latest features and bug fixes are incorporated into your deployment.

If you encounter any difficulties during the deployment process or have further questions, don't hesitate to consult the platform's documentation or seek support from the development team.

Happy deploying and analyzing with the PHYLOViZ Web Platform!