Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 1.67 KB

README.md

File metadata and controls

44 lines (31 loc) · 1.67 KB
Raw

Minerva

This is an online help editor software. The pages can be stored in the file system or in Gitlab. Minerva was programmed with Java 17 and is based on the web framework Amalia.

Configuration

Environment variables

  • MINERVA_MIGRATION=1: migration enabled
  • MINERVA_MIGRATIONSOURCEFOLDER: migration source folder, default is '/'
  • MINERVA_OLDURL: Confluence URL begin ( http://confluence-host/pages/viewpage.action?pageId= ), needed for migration
  • MINERVA_USERFOLDER: set user folder for any user to static value, only for file-system mode
  • MINERVA_KUNDE=1: customer version enabled (only 1 book allowed)
  • LOGLEVEL: logging level (DEBUG, INFO, WARN, ERROR)

AppConfig.properties

  • port: port number
  • app.name: unique application name
  • backend: 'gitlab' or 'file-system'
  • workspaces: absolute folder for workspaces
  • gitlab.url: http:// + host + post of Gitlab (no trailing slash)
  • gitlab.project: Gitlab user name + '/' + Gitlab project name

Build

gradlew -Pbau=1 -Pdockerhub=host:port/ -Ptarget=base dockerBuildImage dockerPushImage
gradlew -Pbau=1 -Pdockerhub=host:port/ -Ptarget=app  dockerBuildImage dockerPushImage

These commands build Docker images. You must specify host and port for your local Docker registry. Start the Docker container with this command:

docker run -d -p 8080:8080 -e TZ=Europe/Berlin -e LOGLEVEL=INFO \
    -v /home/user/minerva/AppConfig.properties:/AppConfig.properties \
    -v /home/user/minerva/data:/data \
    -e MINERVA_KUNDE=1 -e MINERVA_USERFOLDER=all-users \
    --name minerva host:port/minerva

Login

In file-system mode you can use any login. In Gitlab mode you must use your Gitlab credentials.

::