Server Hardware Requirements¶
|CPU||Recent server-grade or high-end consumer-grade processor|
|Disk space||8GB or more.|
|Memory (RAM)||Minimum: 4GB, Recommended: >4GB|
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
- 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 ./mica-x-dist/bin/mica
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¶
A typical docker-compose file (including a MongoDB database) would be:
version: '3' services: mica: image: obiba/mica ports: - "8835:8445" - "8872:8082" links: - mongo environment: - JAVA_OPTS=-Xmx2G - MICA_ADMINISTRATOR_PASSWORD=password - MICA_ANONYMOUS_PASSWORD=password - MONGO_HOST=mongo - MONGO_PORT=27017 - OPAL_HOST=opal - OPAL_PORT=8443 - AGATE_HOST=agate - AGATE_PORT=8444 volumes: - /opt/mica:/srv mongo: image: mongo opal: image: obiba/opal ports: - "8833:8443" - "8870:8080" links: - mongo environment: - OPAL_ADMINISTRATOR_PASSWORD=password - MONGO_HOST=mongo - MONGO_PORT=27017 - AGATE_HOST=agate - AGATE_PORT=8444 volumes: - /opt/opal:/srv agate: image: obiba/agate ports: - "8834:8444" - "8871:8081" links: - mongo environment: - AGATE_ADMINISTRATOR_PASSWORD=password - MONGO_HOST=mongo - MONGO_PORT=27017 - RECAPTCHA_SITE_KEY=6Lfo7gYTAAAAAOyl8_MHuH-AVBzRDtpIuJrjL3Pb - RECAPTCHA_SECRET_KEY=6Lfo7gYTAAAAADym-vSDvPBeBCXaxIprA0QXLk_b volumes: - /opt/agate:/srv
Then environment variables that are exposed by this image are:
||Agate administrator password, required and set at first start.|
||Agate anonymous password, required and set at first start.|
||MongoDB server host.|
||MongoDB server port, default is
||MongoDB database nale, default is
||Opal server host (optional).|
||Opal server port, default is
||Agate server host.|
||Agate server port, default is
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.
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:
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.
||yes||Path to the Mica “home” directory.|
||no||Options for the Java Virtual Machine. For example: -Xmx4096m -XX:MaxPermSize=256m|
To change the defaults update:
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):