Skip to content

Commit 5f8aa37

Browse files
committed
docs: update README
1 parent 2246c00 commit 5f8aa37

File tree

2 files changed

+10
-14
lines changed

2 files changed

+10
-14
lines changed

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -96,18 +96,7 @@ documents and developers who want to build their own RAG pipeline.
9696

9797
### With Docker (recommended)
9898

99-
1. We support both `lite` & `full` version of Docker images. With `full`, the extra packages of `unstructured` will be installed as well, it can support additional file types (`.doc`, `.docx`, ...) but the cost is larger docker image size. For most users, the `lite` image should work well in most cases.
100-
101-
- To use the `lite` version.
102-
103-
```bash
104-
docker run \
105-
-e GRADIO_SERVER_NAME=0.0.0.0 \
106-
-e GRADIO_SERVER_PORT=7860 \
107-
-v ./ktem_app_data:/app/ktem_app_data \
108-
-p 7860:7860 -it --rm \
109-
ghcr.io/cinnamon/kotaemon:main-lite
110-
```
99+
1. We support both `lite` & `full` version of Docker images. With `full` version, the extra packages of `unstructured` will be installed, which can support additional file types (`.doc`, `.docx`, ...) but the cost is larger docker image size. For most users, the `lite` image should work well in most cases.
111100

112101
- To use the `full` version.
113102

@@ -124,9 +113,16 @@ documents and developers who want to build their own RAG pipeline.
124113

125114
```bash
126115
# change image name to
127-
ghcr.io/cinnamon/kotaemon:feat-ollama_docker-full
116+
docker run <...> ghcr.io/cinnamon/kotaemon:main-ollama
128117
```
129118

119+
- To use the `lite` version.
120+
121+
```bash
122+
# change image name to
123+
docker run <...> ghcr.io/cinnamon/kotaemon:main-lite
124+
```
125+
130126
2. We currently support and test two platforms: `linux/amd64` and `linux/arm64` (for newer Mac). You can specify the platform by passing `--platform` in the `docker run` command. For example:
131127

132128
```bash

docs/online_install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Installation (Online HuggingFace Space)
22

33
1. Go to [HF kotaemon_template](https://huggingface.co/spaces/cin-model/kotaemon_template).
4-
2. Use Duplicate function to create your own space.
4+
2. Use Duplicate function to create your own space. Or use this [direct link](https://huggingface.co/spaces/cin-model/kotaemon_template?duplicate=true).
55
![Duplicate space](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/duplicate_space.png)
66
![Change space params](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/change_space_params.png)
77
3. Wait for the build to complete and start up (apprx 10 mins).

0 commit comments

Comments
 (0)