Public/kotaemon
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: improve installation instructions (#620) #none

Browse Source 
* docs: update instructions

* fix: typo in CONTRIBUTING.md (#614)

* fix: typo in usage.md (#598)

minor typo fix (tt -> it)

---------

Co-authored-by: Varun Sharma <contactvarun27@gmail.com>
Co-authored-by: natowi <natowi@users.noreply.github.com>
This commit is contained in:
Tuan Anh Nguyen Dang (Tadashi_Cin) 2025-01-13 07:42:47 +07:00 committed by GitHub
parent 5343d0d3ee
commit 1c5849c711
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -33,7 +33,7 @@ git checkout -b descriptive-name-for-your-changes
4. **Setup the development environment**: If you are working on the code, make sure to install the necessary dependencies for development 4. **Setup the development environment**: If you are working on the code, make sure to install the necessary dependencies for development
```sh ```sh
pip install -e "libs/kotaemon[dev] pip install -e "libs/kotaemon[dev]"
``` ```
5. **Make your changes**: Ensure your code follows the project's coding style and passes all test cases. 5. **Make your changes**: Ensure your code follows the project's coding style and passes all test cases.

3
README.md
View File

@ -101,6 +101,7 @@ documents and developers who want to build their own RAG pipeline.
docker run \ docker run \
-e GRADIO_SERVER_NAME=0.0.0.0 \ -e GRADIO_SERVER_NAME=0.0.0.0 \
-e GRADIO_SERVER_PORT=7860 \ -e GRADIO_SERVER_PORT=7860 \
-v ./ktem_app_data:/app/ktem_app_data \
-p 7860:7860 -it --rm \ -p 7860:7860 -it --rm \
ghcr.io/cinnamon/kotaemon:main-lite ghcr.io/cinnamon/kotaemon:main-lite
``` ```
@ -111,6 +112,7 @@ documents and developers who want to build their own RAG pipeline.
docker run \ docker run \
-e GRADIO_SERVER_NAME=0.0.0.0 \ -e GRADIO_SERVER_NAME=0.0.0.0 \
-e GRADIO_SERVER_PORT=7860 \ -e GRADIO_SERVER_PORT=7860 \
-v ./ktem_app_data:/app/ktem_app_data \
-p 7860:7860 -it --rm \ -p 7860:7860 -it --rm \
ghcr.io/cinnamon/kotaemon:main-full ghcr.io/cinnamon/kotaemon:main-full
``` ```
@ -122,6 +124,7 @@ documents and developers who want to build their own RAG pipeline.
docker run \ docker run \
-e GRADIO_SERVER_NAME=0.0.0.0 \ -e GRADIO_SERVER_NAME=0.0.0.0 \
-e GRADIO_SERVER_PORT=7860 \ -e GRADIO_SERVER_PORT=7860 \
-v ./ktem_app_data:/app/ktem_app_data \
-p 7860:7860 -it --rm \ -p 7860:7860 -it --rm \
--platform linux/arm64 \ --platform linux/arm64 \
ghcr.io/cinnamon/kotaemon:main-lite ghcr.io/cinnamon/kotaemon:main-lite

1
docs/index.md
View File

@ -28,6 +28,7 @@ Download the `kotaemon-app.zip` file from the [latest release](https://github.co
- Linux: `run_linux.sh`. Please run the script using `bash run_linux.sh` in your terminal. - Linux: `run_linux.sh`. Please run the script using `bash run_linux.sh` in your terminal.
2. After the installation, the installer will ask to launch the ktem's UI, answer to continue. 2. After the installation, the installer will ask to launch the ktem's UI, answer to continue.
3. If launched, the application will be open automatically in your browser. 3. If launched, the application will be open automatically in your browser.
4. Default login information is: `username: admin / password: admin`. You should change this credential right after the first login on the UI.
## Launch ## Launch

2
docs/usage.md
View File

@ -5,7 +5,7 @@
- The tool uses Large Language Model (LLMs) to perform various tasks in a QA pipeline. - The tool uses Large Language Model (LLMs) to perform various tasks in a QA pipeline.
So, you need to provide the application with access to the LLMs you want So, you need to provide the application with access to the LLMs you want
to use. to use.
- You only need to provide at least one. However, tt is recommended that you include all the LLMs - You only need to provide at least one. However, it is recommended that you include all the LLMs
that you have access to, you will be able to switch between them while using the that you have access to, you will be able to switch between them while using the
application. application.