Skip to content

Commit

Permalink
Expand Ollama documentation (#32)
Browse files Browse the repository at this point in the history
* Expand Ollama documentation

* Separate configuration options and environment variables. Remove table.
  • Loading branch information
hgohel authored Dec 24, 2024
1 parent d897894 commit cd0ec92
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/install_setup/chat.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,9 @@ volumes:
ollama_data:
```
and then set the `LLM_BASE_URL` configuration parameter to `http://ollama:11434/v1` and the `LLM_MODEL` to a model supported by Ollama.
and then set the `LLM_BASE_URL` configuration parameter to `http://ollama:11434/v1`. Set `LLM_MODEL` to a model supported by Ollama, and pull it down in your container with `ollama pull <model>`. Finally, set `OPENAI_API_KEY` to `ollama`.

To troubleshoot problems with Ollama, you can enable debug logging by setting environment variable `OLLAMA_DEBUG=1` in the Ollama service environment.

!!! info
If you are using Ollama for Gramps Web AI chat, please support the community by completing this documentation with any missing details.
Expand Down
1 change: 1 addition & 0 deletions docs/install_setup/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ Key | Description
`LLM_BASE_URL` | Base URL for the OpenAI-compatible chat API. Defaults to `None`, which uses the OpenAI API.
`LLM_MODEL` | The model to use for the OpenAI-compatible chat API. If unset (the default), chat is disabled.
`VECTOR_EMBEDDING_MODEL` | The [Sentence Transformers](https://sbert.net/) model to use for semantic search vector embeddings. If unset (the default), semantic search and chat are disabled.
`LLM_MAX_CONTEXT_LENGTH` | Character limit for the family tree context provided to the LLM. Defaults to 50000.


## Example configuration file
Expand Down

0 comments on commit cd0ec92

Please sign in to comment.