Running a local version of the Honcho API Server
This guide was made using a M1 Macbook Pro. For any compatibility issues on different platforms please raise an Issue.
3.9
The minimum poetry version is 0.4.9
uv
will create a virtual environment
when you sync your dependencies in the project.
Putting this together:
honcho/.venv
. Activate the
virtual environment via:
docker-compose
template is also available with a database configuration
available.
.env
file for managing runtime environment variables. A
.env.template
file is included for convenience. Several of the configurations
are not required and are only necessary for additional logging, monitoring, and
security.
Below are the required configurations
Note that theThe template has the additional functionality disabled by default. To ensure that they are disabled you can verify the following environment variables are set to false.CONNECTION_URI
must have the prefixpostgresql+psycopg
to function properly. This is a requirement brought bysqlalchemy
pgvector
,
and the environment variables setup you can now launch a local instance of
Honcho. The following command will launch the storage API for Honcho
docker-compose
template is included for running Honcho.
As an alternative to running Honcho locally it can also be run with the compose
template.
Copy the template and update the appropriate environment variables before
launching the service.