To install the server, first clone the git repository to a directory on disk and then perform these steps:
- Anaconda is the recommended way to manage your Python environment. Install it first.
- Open an Anaconda Command Prompt and create a new Python 3.11 environment named
owl
with this command:conda create -n owl python=3.11
- Switch to the environment:
conda activate owl
- In the root of the source tree, where
requirements-windows.txt
is, install the required packages:pip install -r requirements-windows.txt
- FFmpeg is used by the server to convert audio formats. Install it and ensure it is in the path and can be run from the command line as
ffmpeg
. - Test that you can run the server by issuing this command from the root directory, which will print usage instructions:
python -m owl.core.cli --help
Once installed, you will need to also configure the server (API tokens, etc.)
To run the server:
- Open up an Anaconda Command Prompt and switch to the
ai
environment, if you have not already done so:conda activate owl
- Start the server with the
serve
command and make sure to specify the host as0.0.0.0
so it is accessible remotely:python -m owl.core.cli serve --host=0.0.0.0
. By default, the configuration inowl/sample_config.yaml
is used, but this may be overridden with the--config
option. It will likely be necessary to create a customizedconfig.yaml
based on the sample, in which case the command line would change to:python -m owl.core.cli serve --host=0.0.0.0 --config=config.yaml
.