Skip to content

Commit 96f8f87

Browse files
committed
docs: update online installation instruction #none
1 parent 88d577b commit 96f8f87

File tree

8 files changed

+34
-2
lines changed

8 files changed

+34
-2
lines changed

docs/images/change_space_params.png

209 KB
Loading

docs/images/close_logs_space.png

361 KB
Loading

docs/images/cohere_api_key.png

434 KB
Loading

docs/images/duplicate_space.png

369 KB
Loading

docs/images/initial_startup.png

269 KB
Loading

docs/images/set_api_key_space.png

315 KB
Loading

docs/images/space_build.png

216 KB
Loading

docs/index.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,43 @@
55
This page is intended for **end users** who want to use the `kotaemon` tool for Question
66
Answering on local documents. If you are a **developer** who wants contribute to the project, please visit the [development](development/index.md) page.
77

8-
## Download
8+
## Installation (Online HuggingFace Space)
9+
10+
<details>
11+
12+
<summary>View instruction</summary>
13+
14+
1. Go to [kotaemon_template](https://huggingface.co/spaces/cin-model/kotaemon_template)
15+
16+
2. Use Duplicate function to create your own space
17+
18+
![Duplicate space](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/duplicate_space.png)
19+
20+
![Change space params](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/change_space_params.png)
21+
22+
3. Wait for the build to complete and start up (apprx 10 mins).
23+
24+
![Wait space build](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/space_build.png)
25+
26+
![Close space build](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/close_logs_space.png)
27+
28+
4. Follow the first setup instructions (and register for Cohere API key if needed)
29+
30+
![Cohere API](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/cohere_api_key.png)
31+
32+
5. Complete the setup and use your own private space!
33+
34+
![App Startup](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/initial_startup.png)
35+
36+
</details>
37+
38+
## Installation (Offline)
39+
40+
### Download
941

1042
Download the `kotaemon-app.zip` file from the [latest release](https://github.com/Cinnamon/kotaemon/releases/latest/).
1143

12-
## Installation
44+
### Run setup script
1345

1446
0. Unzip the downloaded file.
1547
1. Navigate to the `scripts` folder and start an installer that matches your OS:

0 commit comments

Comments
 (0)