mirror of https://github.com/Cinnamon/kotaemon.git synced 2025-06-26 23:19:56 +00:00

Tuan Anh Nguyen Dang (Tadashi_Cin) 1c5849c711

docs: improve installation instructions (#620 ) #none

* 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>

2025-01-13 07:42:47 +07:00

2.1 KiB

Raw Blame History

Getting Started with Kotaemon

This page is intended for end users who want to use the kotaemon tool for Question Answering on local documents. If you are a developer who wants contribute to the project, please visit the development page.

Installation (Online HuggingFace Space) - easy (10 mins)

Visit this guide.

Installation (Offline) - intermediate (20 mins)

Download

Download the kotaemon-app.zip file from the latest release.

Run setup script

Unzip the downloaded file.
Navigate to the scripts folder and start an installer that matches your OS:
- Windows: run_windows.bat. Just double click the file.
- macOS: run_macos.sh
  1. Right click on your file and select Open with and Other.
  2. Enable All Applications and choose Terminal.
  3. NOTE: If you always want to open that file with Terminal, then check Always Open With.
  4. From now on, double click on your file and it should work.
- Linux: run_linux.sh. Please run the script using bash run_linux.sh in your terminal.
After the installation, the installer will ask to launch the ktem's UI, answer to continue.
If launched, the application will be open automatically in your browser.
Default login information is: username: admin / password: admin. You should change this credential right after the first login on the UI.

Launch

To launch the app after initial setup or any change, simply run the run_* script again.

A browser window will be opened and greets you with this screen:

Usage

For how to use the application, see Usage. This page will also be available to you within the application.

Feedback

Feel free to create a bug report or a feature request on our repo.

2.1 KiB Raw Blame History