Docs/review docker readme

.github/workflows/argilla-server.build-docker-images.yml

@@ -139,7 +139,7 @@ jobs:
           username: ${{ env.DOCKER_USERNAME }}
           password: ${{ env.DOCKER_PASSWORD }}
           repository: $${{ env.SERVER_DOCKER_IMAGE }}
-          readme-filepath: argilla-server/README.md
+          readme-filepath: argilla-server/docker/server/README.md
 
       - name: Docker Hub Description for `argilla-hf-spaces`
         uses: peter-evans/dockerhub-description@v4

argilla-server/docker/argilla-hf-spaces/README.md

@@ -13,3 +13,16 @@ Argilla is a **collaboration tool for AI engineers and domain experts** that req
 ## Why use Argilla?
 
 Whether you are working on monitoring and improving complex **generative tasks** involving LLM pipelines with RAG, or you are working on a **predictive task** for things like AB-testing of span- and text-classification models. Our versatile platform helps you ensure **your data work pays off**.
+
+### Environment variables
+
+Besides the common environment variables defined in docs, this Docker image provides a set of variables to simplify the server startup:
+
+- `USERNAME`: If provided, the owner username. This can be combined with HF OAuth to define the argilla server owner (Default to `$SPACE_AUTHOR_NAME`).
+
+- `PASSWORD`: If provided, the owner password. If `USERNAME` and `PASSWORD` are provided, the owner user will be created with these credentials on the server startup (Default: `""`).
+
+- `API_KEY`: If provided, the owner api key. When `USERNAME` and `PASSWORD` are provided and `API_KEY` is empty, a new random value will be generated (Default: `""`).
+
+- `REINDEX_DATASET`: If `true` or `1`, the datasets will be reindexed in the search engine. This setting must be kept enabled when running in HF spaces (Default: `1`).
+

argilla-server/docker/server/README.md

@@ -0,0 +1,28 @@
+<h1 align="center">
+  <a href=""><img src="https://github.com/dvsrepo/imgs/raw/main/rg.svg" alt="Argilla" width="150"></a>
+  <br>
+  Argilla
+  <br>
+</h1>
+
+
+Argilla is a **collaboration tool for AI engineers and domain experts** that require **high-quality outputs, data ownership, and overall efficiency**.
+
+## Why use Argilla?
+
+Whether you are working on monitoring and improving complex **generative tasks** involving LLM pipelines with RAG, or you are working on a **predictive task** for things like AB-testing of span- and text-classification models. Our versatile platform helps you ensure **your data work pays off**.
+
+
+### Environment variables
+
+Besides the common environment variables defined in docs, this Docker image provides a set of variables to simplify the server startup:
+:
+
+- `USERNAME`: If provided, the owner username. This can be combined with HF OAuth to define the argilla server owner (Default: `""`).
+
+- `PASSWORD`: If provided, the owner password. If `USERNAME` and `PASSWORD` are provided, the owner user will be created with these credentials on the server startup (Default: `""`).
+
+- `API_KEY`: If provided, the owner api key. When `USERNAME` and `PASSWORD` are provided and `API_KEY` is empty, a new random value will be generated (Default: `""`).
+
+- `REINDEX_DATASET`: If `true` or `1`, the datasets will be reindexed in the search engine. This is needed when some search configuration changed or data must be refreshed (Default: `0`).
+