Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): Info on using local resources/troubleshooting podman macos #11

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore(docs): Info on using local resources/troubleshooting podman macos #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,32 @@ docker compose --profile all down --volumes

## Advanced 👷

### Development
If you are a developer on `bee-api` or `bee-ui` and want to run only the supporting infrastructure,
use the profile `infra`, e.g.:

```shell
docker compose --profile infra up -d
```
### Connecting to host resources
Copy link
Collaborator

@jezekra1 jezekra1 Dec 6, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please move this to troubleshooting guide

The generic comments are not necessary we only need to access host for ollama, the guide is organized by error messages, please add it under the specific error message which occurs when you cannot connect to ollama.

You can also improve the error message in ./bee-stack.sh directly


There are many networking options in both [Podman](https://github.com/containers/podman/blob/main/docs/tutorials/basic_networking.md) and [Docker](https://docs.docker.com/engine/network/)

The bee stack does not explicitly configure a network, so by default typically a bridge network is generated automatically. Additionally a specific host name is made available to the container which represents the host. This can be used to access other services on that host, such as ollama running locally.

The hostnames are:
* host.containers.internal (podman)
* host.docker.internal (docker)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As author I'll add a note that it seems recent versions of podman do also support the docker host ( containers/podman#19361 )but I've left the text as-is for now


Below is an example `.env` configuration for a podman environment which will allow the bee stack to connect back to ollama running on the host
```
LLM_BACKEND=ollama
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this section, this is already in example.env and it's configured automatically with the ./bee-stack.sh script

EMBEDDING_BACKEND=ollama
WATSONX_PROJECT_ID=
WATSONX_API_KEY=
WATSONX_REGION=us-south
OLLAMA_URL=http://host.containers.internal:11434
```

# Contributing

Expand Down