mirror of
https://github.com/StanGirard/quivr.git
synced 2024-08-16 16:40:40 +03:00
docs: Remove reference to Ollama in README and update installation steps
This commit is contained in:
parent
4d730448af
commit
fef60ab7c1
@ -75,7 +75,6 @@ You can find the installation video [here](https://www.youtube.com/watch?v=cXBa6
|
||||
|
||||
You just need to update the `OPENAI_API_KEY` variable in the `.env` file. You can get your API key [here](https://platform.openai.com/api-keys). You need to create an account first. And put your credit card information. Don't worry, you won't be charged unless you use the API. You can find more information about the pricing [here](https://openai.com/pricing/).
|
||||
|
||||
> Don't want to use OpenAI and want to use Ollama instead for a completely private experience? You can find the instructions [here](https://docs.quivr.app/developers/contribution/llm/ollama).
|
||||
|
||||
- **Step 4**: Launch the project
|
||||
|
||||
|
@ -52,9 +52,14 @@ You can find the installation video [here](https://www.youtube.com/watch?v=cXBa6
|
||||
- **Step 4**: Launch the project
|
||||
|
||||
```bash
|
||||
cd backend && supabase start
|
||||
```
|
||||
and then
|
||||
|
||||
```bash
|
||||
cd ../
|
||||
docker compose pull
|
||||
docker compose up --build # if OPENAI
|
||||
# docker compose -f docker-compose-ollama.yml up --build # Only if using Ollama. You need to run `ollama run llama2` first.
|
||||
docker compose up
|
||||
```
|
||||
|
||||
If you have a Mac, go to Docker Desktop > Settings > General and check that the "file sharing implementation" is set to `VirtioFS`.
|
||||
@ -63,12 +68,12 @@ You can find the installation video [here](https://www.youtube.com/watch?v=cXBa6
|
||||
|
||||
- **Step 5**: Login to the app
|
||||
|
||||
Connect to the supabase database at [http://localhost:8000/project/default/auth/users](http://localhost:8000/project/default/auth/users) with the following credentials: admin/admin in order to create new users. Auto-confirm the email.
|
||||
|
||||
You can now sign in to the app with your new user. You can access the app at [http://localhost:3000/login](http://localhost:3000/login).
|
||||
You can now sign in to the app with `admin@quivr.app` & `admin`. You can access the app at [http://localhost:3000/login](http://localhost:3000/login).
|
||||
|
||||
You can access Quivr backend API at [http://localhost:5050/docs](http://localhost:5050/docs)
|
||||
|
||||
You can access supabase at [http://localhost:54323](http://localhost:54323)
|
||||
|
||||
## Updating Quivr 🚀
|
||||
|
||||
- **Step 1**: Pull the latest changes
|
||||
@ -77,15 +82,9 @@ You can find the installation video [here](https://www.youtube.com/watch?v=cXBa6
|
||||
git pull
|
||||
```
|
||||
|
||||
- **Step 2**: Use the `migration.sh` script to run the migration scripts
|
||||
- **Step 2**: Update the migration
|
||||
|
||||
```bash
|
||||
chmod +x migration.sh # You need to install Gum & postgresql (brew install gum for example)
|
||||
./migration.sh
|
||||
# Select 2) Run migrations
|
||||
supabase migration up
|
||||
```
|
||||
|
||||
Alternatively, you can run the script on the Supabase database via the web
|
||||
interface (SQL Editor -> `New query` -> paste the script -> `Run`)
|
||||
|
||||
All the scripts can be found in the `scripts/` folder
|
||||
|
Loading…
Reference in New Issue
Block a user