diff --git a/README.md b/README.md index d8a586c3746e26903c4834e9d56ffb0a7642ed37..80866c8cc53f048b729100976c5f3120c68d5dbf 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,55 @@ +# VIPSCore This is the server component that hosts the models. It is accessible via VIPSCoreManager over http/REST. Models that are on the component's classpath -are autodetected, indexed and made available through the REST service \ No newline at end of file +are autodetected, indexed and made available through the REST service. The service is used by [VIPSLogic](https://gitlab.nibio.no/VIPS/VIPSLogic) when running models. It can also be contacted directly by any client. + +## VIPSCoreManager +[VIPSCoreManager](https://gitlab.nibio.no/VIPS/VIPSCoreManager) is a layer in front of VIPSCore that handles authentication of clients and logging of usage. All services available in VIPSLogic are transparently accessible via VIPSCoreManager. Add this layer if you want to limit and log usage, and also if you want to set up e.g. scaling of VIPSCore instances. + + + +## Build and deploy +You need Maven installed. + +Clone and build the [VIPSCommon package](https://gitlab.nibio.no/VIPS/VIPSCommon) + +Clone and build this project + +Download and install [WildFly](https://www.wildfly.org/) >= 16 + +Deploy the build from this project in Wildfly + +### Adding models +To add models, create this folder in WildFly: +`[WILDFLY_ROOT]/modules//no/nibio/vips/modelcontainer/main/` +Add the model jar file, and edit module.xml accordingly. + +``` xml +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + © 2019 NIBIO + Author: Tor-Einar Skog <tor-einar.skog@nibio.no> + --> + +<module xmlns="urn:jboss:module:1.1" name="no.nibio.vips.modelcontainer"> + <resources> + <resource-root path="PsilaRosaeTempModel-1.0-SNAPSHOT.jar"/> + </resources> + <dependencies> + <module name="no.nibio.vips.VIPSCommon" export="false"/> + <module name="com.fasterxml.jackson.core.jackson-core" export="false"/> + <module name="com.fasterxml.jackson.core.jackson-databind" export="false"/> + <module name="com.vividsolutions.jts" export="false"/> + </dependencies> + +</module> + +``` + +You also need to make sure you have the dependency modules available. + + + +## Create client for a model +See [create_client.md](./docs/create_client.md) diff --git a/docs/illustrations/VIPS_whole_architecture.png b/docs/illustrations/VIPS_whole_architecture.png new file mode 100644 index 0000000000000000000000000000000000000000..6b4f1d748bac1f713206b8204ce343a000883f02 Binary files /dev/null and b/docs/illustrations/VIPS_whole_architecture.png differ