Skip to content

Latest commit

 

History

History
117 lines (83 loc) · 3.6 KB

install.md

File metadata and controls

117 lines (83 loc) · 3.6 KB
Raw

Installation guide

There are two possible ways to install Mass Labeling:

Deploy with Docker

Prerequisites

  • Docker CE v18
  • docker-compose v1.20

It is possible to use newer versions, but the deploy was tested using the mentioned versions.

Preparation

Take the following steps to build Mass Labeling through Docker:

  1. Clone the repository and change the folder using the following commands:

    git clone https://github.com/ukitgroup/mass-labeling.git
cd mass-labelling

  2. Run the install script and follow its instructions:

    ./bin/install.sh

    During the installation process you will be asked to provide the following information:

    • Docker container name
    • MongoDB location
    • HTTP port for Mass Labeling service access
    • cookie secret to sign each user session ID

    As a result, this script generates two files: config/app.yml and docker-compose.yml.

Run

To run the container, use the following command:

docker-compose up -d --build

Note. Running container will start the Mass Labelling server application.

Warning. Files config/config.json and docker-compose.yml are created during the installation. Those files contain some options which will affect the service work. If you change some of them inside the container while working with the service, they will be reset after rebuilding the container.

Delpoy locally

Prerequisites

  • Node.js v9.10
  • MongoDB v3.6

Preparation

Take the following steps to build Mass Labeling locally:

  1. Clone the repository and change the folder using the following commands:

    git clone https://github.com/ukitgroup/mass-labeling.git
cd mass-labelling

  2. Run the install script and follow its instructions:

    ./bin/install.sh

    During the installation process you will be asked to provide the following information:

    • MongoDB URI
    • HTTP port for Mass Labeling service access
    • cookie secret to sign each user session ID

    As a result, this script generates two files: config/app.yml and config/app.env.

  3. Install the required npm modules using the following command:

    npm i --no-save

  4. Build front-end bundles using the following command:

    npm run build:front

Run

To run the Mass Labeling server application, use the following command:

npm start

After installation

After the installation, the system will require to create the first administrator. This step is obligatory. Read the cli user guide on how to do it.

English is the default language for the system but Mass Labeling has multilanguage support. If you want to add more languages into the web interface then read the multilanguage guide on how to do it.

FAQ

Q: What OS are supported?
A: The installation process with and without Docker was tested on Ubuntu 16.04 LTS and macOS 10.13.

Q: Can I use another version for Node.js or MongoDB?
A: The mentioned versions were tested. It is possible that it will work with Node.js v8.6+ and MongoDB v3.2+. But you should use them on your own.

Q: How to update a working copy of Mass Labeling?
A: If your working copy uses sources from the master branch, then it is better to make the reinstallation. If your working copy uses sources from the developer branch or other, then it may be enough to recompose the docker image or something similar.