Mica is a stand-alone Java server application that requires MongoDB as database engine.


Server Hardware Requirements

Component Requirement
CPU Recent server-grade or high-end consumer-grade processor
Disk space 8GB or more.
Memory (RAM) Minimum: 4GB, Recommended: >4GB

Server Software Requirements

Software Suggested version Download link Usage
Java 8 OpenJDK 8 downloads Java runtime environment
MongoDB <= 6.0.x MongoDB Community downloads Database engine

While Java is required by Mica server application, MongoDB can be installed on another server.


Mica is distributed as a Debian/RPM package and as a zip file. The resulting installation has default configuration that makes Mica ready to be used (as soon as a MongoDB server is available). Once installation is done, see Configuration instructions.

Debian Package Installation

Mica is available as a Debian package from OBiBa Debian repository. To proceed installation, do as follows:

  • Install Debian package. Follow the instructions in the repository main page for installing Mica.
  • Manage Mica Service: after package installation, Mica server is running: see how to manage the Service.

RPM Package Installation

Mica is available as a RPM package from OBiBa RPM repository. To proceed installation, do as follows:

  • Install RPM package. Follow the instructions in the RPM repository main page for installing Mica.
  • Manage Mica Service: after package installation, Mica is running: see how to manage the Service.

Zip Distribution Installation

Mica is also available as a Zip file. To install Mica zip distribution, proceed as follows:

  • Download Mica distribution
  • Unzip the Mica distribution. Note that the zip file contains a root directory named mica-x.y.z-dist (where x, y and z are the major, minor and micro releases, respectively). You can copy it wherever you want. You can also rename it.
  • Create an MICA_HOME environment variable
  • Separate Mica home from Mica distribution directories (recommended). This will facilitate subsequent upgrades.

Set-up example for Linux:

mkdir mica-home
cp -r mica-x-dist/conf mica-home
export MICA_HOME=`pwd`/mica-home

Launch Mica. This step will create/update the database schema for Mica and will start Mica: see Regular Command.

For the administrator accounts, the credentials are “administrator” as username and “password” as password. See User Directories Configuration to change it.

Docker Image Installation

OBiBa is an early adopter of the Docker technology, providing its own images from the Docker Hub repository.

A typical docker-compose file (including a MongoDB database) would be:

version: '3'
              image: obiba/mica
                      - "8872:8082"
                      - mongo
                      - agate
                      - opal
                      - JAVA_OPTS=-Xmx2G
                      - MONGO_HOST=mongo
                      - MONGO_PORT=27017
                      - OPAL_URL=http://opal:8080
                      - AGATE_URL=http://agate:8081
                      - /opt/mica:/srv
              image: mongo:6.0
              image: obiba/opal
                      - "8870:8080"
                      - mongo
                      - rock
                      - agate
                      - MONGO_HOST=mongo
                      - MONGO_PORT=27017
                      - AGATE_URL=http://agate:8081
                      - ROCK_HOSTS=rock:8085
                      - /opt/opal:/srv
              image: obiba/rock
              image: obiba/agate
                      - "8871:8081"
                      - mongo
                      - MONGO_HOST=mongo
                      - MONGO_PORT=27017
                      - RECAPTCHA_SITE_KEY=${RECAPTCHA_SITE_KEY}
                      - /opt/agate:/srv

Then environment variables that are exposed by this image are:

Environment Variable Description
MICA_ADMINISTRATOR_PASSWORD Mica administrator password, required and set at first start.
MONGO_HOST MongoDB server host.
MONGO_PORT MongoDB server port, default is 27017.
MONGO_DB MongoDB database nale, default is mica.
OPAL_URL Opal server URL (optional).
OPAL_HOST [Deprecated, use OPAL_URL] Opal server host (optional).
OPAL_PORT [Deprecated, use OPAL_URL] Opal server port, default is 8443.
AGATE_URL Agate server URL.
AGATE_HOST [Deprecated, use AGATE_URL] Agate server host.
AGATE_PORT [Deprecated, use AGATE_URL] Agate server port, default is 8444.


The upgrade procedures are handled by the application itself.

Debian Package Upgrade

If you installed Mica via the Debian package, you may update it using the command:

apt-get install mica

RPM Package Upgrade

If you installed Mica via the RPM package, you may update it using the command:

yum install mica

Zip Distribution Upgrade

Follow the Installation of Mica Zip distribution above but make sure you don’t overwrite your mica-home directory.


Server launch


When Mica is installed through a Debian/RPM package, Mica server can be managed as a service.

Options for the Java Virtual Machine can be modified if Mica service needs more memory. To do this, modify the value of the environment variable JAVA_ARGS in the file /etc/default/mica.

Main actions on Mica service are: start, stop, status, restart. For more information about available actions on Mica service, type:

service mica help

The Mica service log files are located in /var/log/mica directory.


The Mica server can be launched from the command line. The environment variable MICA_HOME needs to be setup before launching Mica manually.

Environment variable Required Description
MICA_HOME yes Path to the Mica “home” directory.
JAVA_OPTS no Options for the Java Virtual Machine. For example: -Xmx4096m -XX:MaxPermSize=256m

To change the defaults update: bin/mica or bin/mica.bat

Make sure Command Environment is setup and execute the command line (bin directory is in your execution PATH)):


Executing this command upgrades the Mica server and then launches it.

The Mica server log files are located in MICA_HOME/logs directory. If the logs directory does not exist, it will be created by Mica.


To access Mica with a web browser the following urls may be used (port numbers may be different depending on HTTP Server Configuration):


If you encounter an issue during the installation and you can’t resolve it, please report it in our Mica Issue Tracker.

Mica logs can be found in /var/log/mica. If the installation fails, always refer to this log when reporting an error.