Installing Vireo

Requirements

• Operating System

  • UNIX-like

  • Windows

• Apache Maven

  • Versions 3.8.1 - 3.9.2

    • Maven version 3.9.3 and higher are not compatible with AngularJS.

• Java JDK

  • Version 11 or higher

• NodeJS

  • Version 16 or higher

• Database

  • PostgreSQL

  • MySQL

  • H2

    • May be used for development but is not recommended for production.

Building

Vireo is built with Maven. The build is configured with pom.xml and package.json. There are several command line arguments that can be used when packaging Vireo 4.

• -Dproduction will package production ready. Required for Tomcat deployment or running as a jar

• -DskipTests will skip tests.

• -Dassets.uri=file:/opt/vireo/ will configure where to store assets.

• -Dconfig.uri=file:/var/vireo/config/ will configure the external configuration directory for the WAR packaged application.

• -Dspring.config.location=file:/var/vireo/config/ will configure the external configuration directory for development using spring-boot:run.

Ending trailing slash is required for spring.config.location

The external configuration directory is where an application.yml file can be added to override default properties. When packaging the application define config.uri, which will template context.xml file with the spring.config.location system variable for container deployment.

When running for development, define spring.config.location to externalize the configuration. If running for development and using an external configuration, do not define assets.uri. It will have to be configured manually in the external application.yml.

External configuration is recommended for production deployment

Development

or run for development

or run for development with external configuration

or run for development with external assets

or run as production

Building or running with -Dproduction will change the index.html template at src/main/resources/templates/index.html

Production

If build succeeds, you should have both a vireo-4.2.7.war and a vireo-4.2.7-install.zip in the target/ directory. When building for production, required static assets are copied into the packaged war file and the index.html template is optimized for production. For development, a symlink is used to allow the application to access required static assets.

Apache Reverse Proxy Config

Testing

Server

Client

Server and Client

Deploying

Recommended Hardware Configuration

• 2 CPUs

• 2 GB RAM

Zip Package

Unzip package into preferred directory (or any directory you choose):

Directory Structure of installed package

• config - where the external config files reside

• logs - where vireo log files are stored

• webapp - the extracted WAR file

Configure application

Currently, in order to have Tomcat know where the external configuration directory is, webapp/META-INF/context.xml will have to be updated. Skip step 1 if package built defining config.uri.

1. Update context.xml to set external configuration directory

2. Update application.yml

Docker

A quick and easy deployment method using docker-compose is described in the Deployment Guide.

For advanced use cases, or when docker-compose is unavailable, the use of docker or npm/mvn is also described in the Deployment Guide.

Deployment, in general, may look something like this:

Tomcat

Easiest way to deploy from extracted zip file is to create a symlink in Tomcat webapps directory to the Vireo webapp directory.

or as root

WAR Package

Copy war file into Tomcat webapps directory (your location may vary -- this is an example):

or as root:

if not specifying assets.uri during build the assets will be stored under the vireo webapp's classpath, /opt/tomcat/webapps/vireo/WEB-INF/classes

if not specifying config.uri during build the application.yml will be under the Vireo webapp's classpath, /opt/tomcat/webapps/vireo/WEB-INF/classes/application.yml

if deployed from default WAR package and would like to externalize the config, you will have to edit /opt/tomcat/webapps/vireo/META-INF/context.xml*

Spring Boot

Run WAR as a stand-alone Spring Boot application.

Configuring

• application.yml

  • application configurations

• theme-defaults.json

  • default theme settings

• favicon.ico

  • browser favicon

You should configure the following properties for production. spring.jpa.hibernate.ddl-auto: create-drop will clear database on restart

Do not forget to provide your own custom values for the security related properties, such as auth.security.jwt.secret, auth.security.jwt.issuer, auth.security.jwt.duration, app.security.secret, and app.security.allow-access.

Customization of default values

Information on customizing default values can be found in the advanced customization documentation.