Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
proycon committed Apr 5, 2022
1 parent 86f183c commit 33968a6
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,12 @@ Builds upon [kaldi](http//kaldi-asr.org) and [phonetisaurus](https://github.com/
## Installation

For end-users and hosting partners, we provide a container image that ships with a web interface based on
[CLAM](https://proycon.github.io/clam/). Through this application some of our pretrained models are directly available
for end-users. You can pull a prebuilt image from the Docker Hub registry using docker as follows:
[CLAM](https://proycon.github.io/clam/). You can pull a prebuilt image from the Docker Hub registry using docker as follows:

```
$ docker pull proycon/forcedalignment2
```

You can also build the container image yourself using a tool like ``docker build``, which is the recommended option if
you are deploying this in your own infrastructure. In that case will want set some of the environment variables defined
in ``Dockerfile``.

Run the container as follows:

```
Expand All @@ -27,3 +22,6 @@ Ensure that the directory you pass is writable.

Assuming you run locally, the web interface can then be accessed on ``http://127.0.0.1:8080/``.

If you want to deploy this service on your own infrastructure, you will want to set some of the environment variables
defined in the `Dockerfile` when running the container, most notably the ones regarding authentication, as this is by
default disabled and as such *NOT* suitable for production deployments.

0 comments on commit 33968a6

Please sign in to comment.