hogepodge commited on
Commit
55c284c
1 Parent(s): 299d5e1

Update the README with cloud storage information

Browse files
Files changed (1) hide show
  1. README.md +41 -14
README.md CHANGED
@@ -62,11 +62,7 @@ resources including tutorials and documentation.
62
 
63
  ![Gif of Label Studio annotating different types of data](https://raw.githubusercontent.com/heartexlabs/label-studio/master/images/annotation_examples.gif)
64
 
65
- Have a custom dataset? You can customize Label Studio to fit your needs. Read
66
- an [introductory blog post](https://towardsdatascience.com/introducing-label-studio-a-swiss-army-knife-of-data-labeling-140c1be92881)
67
- to learn more.
68
-
69
- ### Configuring Label Studio Spaces for Secure Use
70
 
71
  By default this space allows for the unrestricted creation of new accounts
72
  will full access to all projects and data. This is great for trying out
@@ -98,13 +94,13 @@ Postgres. We strongly recommend setting these as secrets to prevent leaking
98
  information about your database service to the public in your spaces
99
  definition.
100
 
101
- ENV DJANGO_DB=default
102
- ENV POSTGRE_NAME=<postgres_name>
103
- ENV POSTGRE_PORT=<db_port>
104
- ENV POSTGRE_USER=<postgres_user>
105
- ENV POSTGRE_PASSWORD=<password>
106
- ENV POSTGRE_PORT=<db_port>
107
- ENV POSTGRE_HOST=<db_host>
108
 
109
  Add the following environment variable to remove the warning about ephemeral
110
  storage.
@@ -114,8 +110,39 @@ storage.
114
  Note that you will need to connect cloud storage to host data items that you
115
  want to annotate, as local storage will not be preserved across a space reset.
116
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
117
  ## Questions? Concerns? Want to get involved?
118
 
119
  Email the community team at [[email protected]](mailto:[email protected])
120
-
121
- </body>
 
62
 
63
  ![Gif of Label Studio annotating different types of data](https://raw.githubusercontent.com/heartexlabs/label-studio/master/images/annotation_examples.gif)
64
 
65
+ ### Making your Label Studio Hugging Face Space production-ready
 
 
 
 
66
 
67
  By default this space allows for the unrestricted creation of new accounts
68
  will full access to all projects and data. This is great for trying out
 
94
  information about your database service to the public in your spaces
95
  definition.
96
 
97
+ DJANGO_DB=default
98
+ POSTGRE_NAME=<postgres_name>
99
+ POSTGRE_PORT=<db_port>
100
+ POSTGRE_USER=<postgres_user>
101
+ POSTGRE_PASSWORD=<password>
102
+ POSTGRE_PORT=<db_port>
103
+ POSTGRE_HOST=<db_host>
104
 
105
  Add the following environment variable to remove the warning about ephemeral
106
  storage.
 
110
  Note that you will need to connect cloud storage to host data items that you
111
  want to annotate, as local storage will not be preserved across a space reset.
112
 
113
+ By default the only data storage enabled for this space is local. In the case
114
+ of a space reset, all data will be lost. To enable permanent storage, you
115
+ must enable a cloud storage connector. We also strongly recommend enabling
116
+ configuration persistence to preserve project data, annotations, and user
117
+ settings. Choose the appropriate cloud connector and configure the secrets
118
+ for it.
119
+
120
+ #### Amazon S3
121
+ STORAGE_TYPE=s3
122
+ STORAGE_AWS_ACCESS_KEY_ID="<YOUR_ACCESS_KEY_ID>"
123
+ STORAGE_AWS_SECRET_ACCESS_KEY="<YOUR_SECRET_ACCESS_KEY>"
124
+ STORAGE_AWS_BUCKET_NAME="<YOUR_BUCKET_NAME>"
125
+ STORAGE_AWS_REGION_NAME="<YOUR_BUCKET_REGION>"
126
+ STORAGE_AWS_FOLDER=""
127
+
128
+ #### Google Cloud Storage
129
+
130
+ STORAGE_TYPE=gcs
131
+ STORAGE_GCS_BUCKET_NAME="<YOUR_BUCKET_NAME>"
132
+ STORAGE_GCS_PROJECT_ID="<YOUR_PROJECT_ID>"
133
+ STORAGE_GCS_FOLDER=""
134
+ GOOGLE_APPLICATION_CREDENTIALS="/opt/heartex/secrets/key.json"
135
+
136
+ Azure Blob Storage
137
+ ==================
138
+
139
+ STORAGE_TYPE=azure
140
+ STORAGE_AZURE_ACCOUNT_NAME="<YOUR_STORAGE_ACCOUNT>"
141
+ STORAGE_AZURE_ACCOUNT_KEY="<YOUR_STORAGE_KEY>"
142
+ STORAGE_AZURE_CONTAINER_NAME="<YOUR_CONTAINER_NAME>"
143
+ STORAGE_AZURE_FOLDER=""
144
+
145
+
146
  ## Questions? Concerns? Want to get involved?
147
 
148
  Email the community team at [[email protected]](mailto:[email protected])