Skip to content

Commit

Permalink
docs: fix commands for windows & add info about openblas issue
Browse files Browse the repository at this point in the history
  • Loading branch information
farioas committed Oct 19, 2022
1 parent 36df0c9 commit acc5044
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 11 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,14 @@ Run Label Studio in a Docker container and access it at `http://localhost:8080`.

```bash
docker pull heartexlabs/label-studio:latest
docker run -it -p 8080:8080 -v `pwd`/mydata:/label-studio/data heartexlabs/label-studio:latest
docker run -it -p 8080:8080 -v $(pwd)/mydata:/label-studio/data heartexlabs/label-studio:latest
```
You can find all the generated assets, including SQLite3 database storage `label_studio.sqlite3` and uploaded files, in the `./mydata` directory.

#### Override default Docker install
You can override the default launch command by appending the new arguments:
```bash
docker run -it -p 8080:8080 -v `pwd`/mydata:/label-studio/data heartexlabs/label-studio:latest label-studio --log-level DEBUG
docker run -it -p 8080:8080 -v $(pwd)/mydata:/label-studio/data heartexlabs/label-studio:latest label-studio --log-level DEBUG
```

#### Build a local image with Docker
Expand Down
16 changes: 13 additions & 3 deletions docs/source/guide/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,16 +55,23 @@ Label Studio is also available as a Docker container. Make sure you have [Docker
### Install with Docker on *nix
To install and start Label Studio at [http://localhost:8080](http://localhost:8080), storing all labeling data in `./my_project` directory, run the following:
```bash
docker run -it -p 8080:8080 -v `pwd`/mydata:/label-studio/data heartexlabs/label-studio:latest
docker run -it -p 8080:8080 -v $(pwd)/mydata:/label-studio/data heartexlabs/label-studio:latest
```

### Install with Docker on Windows
Or for Windows, you have to modify the volumes paths set by `-v` option.

#### Override the default Docker install
You can override the default Docker install by appending new arguments:
You can override the default Docker install by appending new arguments.

In Windows Command Line (cmd):
```bash
docker run -it -p 8080:8080 -v `pwd`/mydata:/label-studio/data heartexlabs/label-studio:latest label-studio --log-level DEBUG
docker run -it -p 8080:8080 -v %cd%/mydata:/label-studio/data heartexlabs/label-studio:latest label-studio --log-level DEBUG
```

In PowerShell:
```bash
docker run -it -p 8080:8080 -v ${PWD}/mydata:/label-studio/data heartexlabs/label-studio:latest label-studio --log-level DEBUG
```

### Build a local image with Docker
Expand Down Expand Up @@ -162,6 +169,9 @@ If you see any other errors during installation, try to rerun the installation.
pip install --ignore-installed label-studio
```

### OpenBLAS blas_thread_init: pthread_create failed for thread X of Y: Operation not permitted

Upgrade Docker Engine to the latest available version(>= [20.10.12](https://docs.docker.com/engine/release-notes/#201012)).

## Upgrade Label Studio
To upgrade to the latest version of Label Studio, reinstall or upgrade using pip.
Expand Down
6 changes: 3 additions & 3 deletions docs/source/guide/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ LABEL_STUDIO_PORT = 9001

To run Label Studio on Docker with a port other than the default of 8080, use the port argument when starting Label Studio on Docker. For example, to start Label Studio in a Docker container accessible with port 9001, run the following:
```bash
docker run -it -p 9001:8080 -v `pwd`/mydata:/label-studio/data heartexlabs/label-studio:latest label-studio
docker run -it -p 9001:8080 -v $(pwd)/mydata:/label-studio/data heartexlabs/label-studio:latest label-studio
```

Or, if you're using Docker Compose, update the `docker-compose.yml` file that you're using to expose a different port for the NGINX server used to proxy the connection to Label Studio. For example, this portion of the [`docker-compose.yml`](https://github.com/heartexlabs/label-studio/blob/master/docker-compose.yml) file exposes port 9001 instead of port 80 for proxying Label Studio:
Expand All @@ -130,10 +130,10 @@ To run Label Studio on Docker and reference persistent local storage directories

The following command starts a Docker container with the latest image of Label Studio with port 8080 and an environment variable that allows Label Studio to access local files. In this example, a local directory `./myfiles` is mounted to the `/label-studio/files` location.
```bash
docker run -it -p 8080:8080 -v `pwd`/mydata:/label-studio/data \
docker run -it -p 8080:8080 -v $(pwd)/mydata:/label-studio/data \
--env LABEL_STUDIO_LOCAL_FILES_SERVING_ENABLED=true \
--env LABEL_STUDIO_LOCAL_FILES_DOCUMENT_ROOT=/label-studio/files \
-v `pwd`/myfiles:/label-studio/files \
-v $(pwd)/myfiles:/label-studio/files \
heartexlabs/label-studio:latest label-studio
```

Expand Down
4 changes: 2 additions & 2 deletions docs/themes/htx/layout/partials/index.ejs
Original file line number Diff line number Diff line change
Expand Up @@ -96,13 +96,13 @@ menu && menu.classList.add('main__page__header')
<div class="content__elem content2" style="display:none;">
<div class="desktop__code">
<p class="title__code"><span class="counter">1</span># Run latest Docker version </p>
<p class="code__content"><span class="counter">2</span>docker run -it -p 8080:8080 -v `pwd`/mydata:/label-studio/data heartexlabs/label-studio:latest</p>
<p class="code__content"><span class="counter">2</span>docker run -it -p 8080:8080 -v $(pwd)/mydata:/label-studio/data heartexlabs/label-studio:latest</p>
<p class="spacer"><span class="counter">3</span></p>
<p class="title__code"><span class="counter">4</span># Now visit http://localhost:8080/</p>
</div>
<div class="mobile__code">
<p class="title__code"><span class="counter">1</span># Run latest Docker version </p>
<p class="code__content"><span class="counter">2</span>docker run -it -p 8080:8080 -v `pwd`/mydata:/label-studio/data heartexlabs/label-studio:latest</p>
<p class="code__content"><span class="counter">2</span>docker run -it -p 8080:8080 -v $(pwd)/mydata:/label-studio/data heartexlabs/label-studio:latest</p>
<p class="spacer"><span class="counter">3</span></p>
<p class="title__code"><span class="counter">4</span># Now visit http://localhost:8080/</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion scripts/build_docker_and_start.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ if bash ${SCRIPT_DIR}/../deploy/prebuild.sh; then
fi

if [ $? -eq 0 ]; then
docker run -it -p 8080:8080 -v `pwd`/mydata:/label-studio/data heartexlabs/label-studio:latest
docker run -it -p 8080:8080 -v $(pwd)/mydata:/label-studio/data heartexlabs/label-studio:latest
else
echo "Docker build failed."
fi

0 comments on commit acc5044

Please sign in to comment.