Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add better minio documentation #7177

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

docs: Add better minio documentation #7177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae41f66
Update persistent_storage.md to include minio documentation
lucasra1 Mar 6, 2025
716b75e
Update storedata.md to include minio documentation
lucasra1 Mar 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/source/guide/persistent_storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,3 +573,42 @@ STORAGE_AZURE_FOLDER=""

</div>
</div>

## Set up Minio

Set up Minio as the persistent storage for Label Studio using Docker Compose.

### Starting the container

An example docker-compose file for this is available in the [Label Studio repository](https://github.com/HumanSignal/label-studio).
To run MinIO alongside your Label Studio instance, use the following command:

````bash
# Add sudo on Linux if you are not a member of the docker group
docker compose -f docker-compose.yml -f docker-compose.minio.yml up -d
````

The MinIO server will be accessible at http://localhost:9000.

To configure MinIO settings, create a `.env` file. Remember to override the default credentials.

````.dotenv
MINIO_ROOT_USER=minio_admin_do_not_use_in_production
MINIO_ROOT_PASSWORD=minio_admin_do_not_use_in_production
````

### Create the bucket

Create a bucket in minio. e.g. name the bucket `labelstudio`

### Configure the correct connection settings

For labelstudio to connect to minio configure the correct env variables

````.dotenv
STORAGE_TYPE=s3
STORAGE_AWS_ACCESS_KEY_ID=${MINIO_ROOT_USER:-minio_admin}
STORAGE_AWS_SECRET_ACCESS_KEY=${MINIO_ROOT_PASSWORD:-minio_password}
STORAGE_AWS_BUCKET_NAME=labelstudio
STORAGE_AWS_ENDPOINT_URL=http://minio:9000
````
12 changes: 12 additions & 0 deletions docs/source/guide/storedata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,18 @@ MINIO_ROOT_USER=minio_admin_do_not_use_in_production
MINIO_ROOT_PASSWORD=minio_admin_do_not_use_in_production
````

### Configure the correct connection settings

For labelstudio to connect to minio configure the correct env variables

````.dotenv
STORAGE_TYPE=s3
STORAGE_AWS_ACCESS_KEY_ID=${MINIO_ROOT_USER:-minio_admin}
STORAGE_AWS_SECRET_ACCESS_KEY=${MINIO_ROOT_PASSWORD:-minio_password}
STORAGE_AWS_BUCKET_NAME=labelstudio
STORAGE_AWS_ENDPOINT_URL=http://minio:9000
````

### Connect Label Studio to local MinIO

If you do not have a static IP address, create an entry in your hosts file so that both the Label Studio container and
Expand Down
Loading