README.md

# linstt-controller

This is the repository for the linstt-controller project.

## Install Docker and Docker Compose

You will need to have Docker and Docker Compose installed on your machine. If they are already installed, you can skip this part.
Otherwise, you can install them referring to [https://docs.docker.com/engine/installation/](https://docs.docker.com/engine/installation/ "Install Docker"), and to [https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/ "Install Docker Compose").

## Get all the docker images

### Kaldi-gstreamer

**TODO**

### Speech Enhancement

**TODO**

### Controller

**TODO**

## Clone linstt-controller

Run `git clone https://ci.linagora.com/linagora/lgs/labs/linstt-controller`
You can build the docker image of linstt-controller running `docker build -t linagora/linstt-controller .` in the linstt-controller directory, but if you don't do it, the image will be built the first time you run `docker-compose up`.

Note that if you have an old docker image tagged `linagora/linstt-controller` on your machine, the image will never be built when you run `docker-compose up`, and the old image will be used. In order to have the latest version of the image, you must build it now. Every time you change some code in linstt-controller, you will need to build the image, because docker compose will use `linagora/linstt-controller` image if it exists. If you want the image to be built every time you run `docker-compose up`, remove the `image: linagora/linstt-controller` line in docker-compose.yml

## Environment variables

**TODO**

## Run linstt-controller

Be sure that you are in the linstt-controller directory, and run `docker-compose up`. You can set environment variables in the same command line, as explained above.