Admin Guide

For the most up to date documentation please visit docs.brix.ch

Setup

In oder to run corvus, you'll need:

  • A recent version of Java (8 or higher)
  • An SQL database (whatever JDBC supports)
  • A storage location for templates and user files
  • A configuration file, e.g. application-example.yml

To start corvus, you'll need to provide the above configuration file as an argument:

java -jar corvus.jar --spring.profiles.active=default,example

Using default,example ensures that the default properties (built-in) are applied first, and then example overwrites the ones it specifies. That way you don't have to add all of the properties to your file, but only the ones you want to change. Here's an example of how a application-example.yml might look like:

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/corvus?useUnicode=true&characterEncoding=utf8&useSSL=false
    username: corvus
    password: ********
  mail:
    host: localhost
    port: 2525
    test-connection: false
server:
  port: 8888
corvus:
  defaultLocale: de
  entryLocales: de,en,fr,it
  templateLocation: file:templates
  userFilesLocation: file:userfiles
  cors:
    allowedOrigin: 'http://corvus.local'
  debug:
    printStackTrace: false
logging:
  level:
    ch.brix.corvus: DEBUG

Service

In order to start corcus as a systemd service, put the following into /etc/systemd/system/corvus.service (adapt the paths and the profile):

[Unit]
Description=corvus
After=syslog.target network.target

[Service]
User=www-data
WorkingDirectory=/some/where/corvus
ExecStart=/usr/bin/java -jar /some/where/corvus/corvus.jar --spring.profiles.active=default,example
SuccessExitStatus=143

[Install]
WantedBy=multi-user.target

and execute a systemctl daemon-reload so that the new service is picked up.

You can now start the service though systemctl start corvus and have it start automatically with systemctl enable corvus.