Local Instance

COCONUT can be deployed within your organisation's network without exposing it to outer networks for your own needs. This would require a server to host the application and its data. COCONUT, being an open source application, makes its code available at GitHub. You may use the following command to clone it. Clone the Repository

git clone https://github.com/Steinbeck-Lab/coconut.git

The Dockerfile in the code base has the necessary instructions to build the required image for COCONUT. The docker-compose.yml file has the necessary instructions to pull and run this image and the other dependent images in respective containers.

Documentation:

Docs related to this application are also provided to facilitate your internal documentation requirements.

Deployment

• On to a VM: Use the docker-compose.yml file

Helm Chart (Optional)

COCONUT can be packaged and published as Helm charts for container orchestration deployment, which makes the installation easy to define, install, and upgrade. You need to install Helm first to use the charts. Please refer to the Helm's documentation to get started.

The chart comes with following optional dependencies which you can opt to have in your deployment if you wish to:

• Meilisearch (Search Engine)
• RabbitMQ (Message Broker)
• Redis (Cache)

Once Helm has been set up correctly, add the repo as follows:

helm repo add repo-helm-charts https://nfdi4chem.github.io/repo-helm-charts/

If you had already added this repo earlier, run helm repo update to retrieve the latest versions of the packages. You can then run helm search repo repo-helm-charts to see the charts.

Before you install generate your own application key and provide that value in the .Values.appProperties.key property.

To install the coconut-app chart:

helm install my-coconut-app repo-helm-charts/coconut-app

To uninstall the chart:

helm delete my-coconut-app

To learn more about the structure of the chart, visit our Github repo.