Skip to content

Commit

Permalink
update readme and info.xml to be clearer
Browse files Browse the repository at this point in the history
Signed-off-by: Anupam Kumar <kyteinsky@gmail.com>
  • Loading branch information
kyteinsky committed Jan 4, 2024
1 parent dacbd4c commit 3622105
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 20 deletions.
19 changes: 10 additions & 9 deletions appinfo/info.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,26 @@
<name>Context Chat Backend</name>
<summary>Python backend for Context Chat</summary>
<description>
<![CDATA[This is a Python backend for Context Chat. It exposes a REST API for the Nextcloud App to use.
It is useful for people who want to index their documents and ask questions about them.
<![CDATA[This is the Python backend for Context Chat.
Context Chat is useful for people who want to ask questions from a large language model but using their documents as context.
Note: The Context Chat app, the AppAPI app and a Text Processing OCP API consumer (the Assitant app is recommended for this purpose) from the Nextcloud App Store are required for this to work.
Three mandatory apps are required for this app to work (can be installed from the Apps page):
- AppAPI: https://apps.nextcloud.com/apps/app_api
- Context Chat: https://apps.nextcloud.com/apps/context_chat
- Assistant: https://apps.nextcloud.com/apps/assistant (The OCS API or the `occ` commands can also be used to interact with this app but it recommended to do that through a Text Processing OCP API consumer like the Assitant app.)
Install the AppAPI App from the [App Store](https://apps.nextcloud.com/apps/app_api)
Install the Context Chat App from the [App Store](https://apps.nextcloud.com/apps/context_chat)
Install the Assistant App from the [App Store](https://apps.nextcloud.com/apps/assistant)
This app then should be installed from the "External Apps" page.
]]></description>
<version>1.0.0</version>
<version>1.0.1</version>
<licence>agpl</licence>
<author mail="kyteinsky@gmail.com" homepage="https://github.com/kyteinsky">Anupam Kumar</author>
<namespace>Context Chat</namespace>
<category>integration</category>
<category>office</category>
<website>https://github.com/nextcloud/context_chat_backend</website>
<bugs>https://github.com/nextcloud/context_chat_backend/issues</bugs>
<repository type="git">https://github.com/nextcloud/context_chat_backend.git</repository>
<dependencies>
<nextcloud min-version="28" max-version="28"/>
<nextcloud min-version="28" max-version="29"/>
</dependencies>
<external-app>
<docker-install>
Expand Down
20 changes: 9 additions & 11 deletions readme.markdown
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
# Context Chat

## Install
## Simple Install

1. Install two mandatory apps for this app to work as desired in your Nextcloud install: Context Chat app and the AppAPI app
2. You can use the OCS API or the `occ` commands to interact with this app but it recommended to do that through a Text Processing OCP API consumer like the Assitant app.
1. Install three mandatory apps for this app to work as desired in your Nextcloud install from the "Apps" page:
- AppAPI: https://apps.nextcloud.com/apps/app_api
- Context Chat: https://apps.nextcloud.com/apps/context_chat
- Assistant: https://apps.nextcloud.com/apps/assistant (The OCS API or the `occ` commands can also be used to interact with this app but it recommended to do that through a Text Processing OCP API consumer like the Assitant app.)
2. Install this backend app (Context Chat Backend: https://apps.nextcloud.com/apps/context_chat_backend) from the "External Apps" page
3. Start using Context Chat from the Assistant UI

## Required Apps

Install the AppAPI App from the [App Store](https://apps.nextcloud.com/apps/app_api)
Install the Context Chat App from the [App Store](https://apps.nextcloud.com/apps/context_chat)
Install the Assistant App from the [App Store](https://apps.nextcloud.com/apps/assistant)

## Local Setup (without docker)
## Complex Install (without docker)

1. `python -m venv .venv`
2. `. .venv/bin/activate`
Expand All @@ -22,7 +20,7 @@ Install the Assistant App from the [App Store](https://apps.nextcloud.com/apps/a
7. `./main.py`
8. [Follow the below steps to register the app in the app ecosystem](#register-as-an-ex-app)

## Local Setup (with docker)
## Complex Install (with docker)

1. `docker build -t context_chat_backend_dev . -f Dockerfile.dev` (this is a good place to edit the example.env file before building the container)
2. `docker run --add-host=host.docker.internal:host-gateway -p10034:10034 context_chat_backend_dev`
Expand Down

0 comments on commit 3622105

Please sign in to comment.