Installation
Overviewβ
This section shows you available options for running Weaviate, and how to install and configure Weaviate with each option.
Options for running Weaviateβ
βWeaviate versions on the Weaviate Cloud Service (WCS) and Weaviate open source are identical, with the only difference that the WCS manages your Weaviate instance for you and comes with a specific SLA, whereas Weaviate open source comes with a BSD-3 license.
You have three options to run Weaviate, all come with their own installation guides.
Both Docker Compose and Kubernetes setups use a yaml file for customizing Weaviate instances, typically called docker-compose.yml
or values.yml
respectively. These files will be referred to throughout the documentation as 'configuration yaml files'.
- Weaviate Cluster Service β advised for users who want to use a managed Weaviate service.
- Docker Compose β advised for those who want to develop on Weaviate.
- Kubernetes β advised for production setups.
When self-hosting, we recommend starting with the Docker Compose configurator and set up to get a feel for how Weaviate operates. You can later adopt this knowledge when you are creating your Helm charts.
Run an unreleased versionβ
You can run Weaviate with docker-compose
, building your own container off the master
branch. Note that this is not an officially released Weaviate version, so this might contain bugs.
git clone https://github.com/weaviate/weaviate.git
cd weaviate
docker build --target weaviate -t name-of-your-weaviate-image .
Then, make a docker-compose.yml
file with this new image. For example:
version: '3.4'
services:
weaviate:
image: name-of-your-weaviate-image
ports:
- 8080:8080
environment:
CONTEXTIONARY_URL: contextionary:9999
QUERY_DEFAULTS_LIMIT: 25
AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED: 'true'
PERSISTENCE_DATA_PATH: './data'
ENABLE_MODULES: 'text2vec-contextionary'
DEFAULT_VECTORIZER_MODULE: 'text2vec-contextionary'
AUTOSCHEMA_ENABLED: 'false'
contextionary:
environment:
OCCURRENCE_WEIGHT_LINEAR_FACTOR: 0.75
EXTENSIONS_STORAGE_MODE: weaviate
EXTENSIONS_STORAGE_ORIGIN: http://weaviate:8080
NEIGHBOR_OCCURRENCE_IGNORE_PERCENTILE: 5
ENABLE_COMPOUND_SPLITTING: 'false'
image: semitechnologies/contextionary:en0.16.0-v1.0.2
After the build is complete, you can run this Weaviate build with docker-compose: docker-compose up
.
More Resourcesβ
If you can't find the answer to your question here, please look at the:
- Frequently Asked Questions. Or,
- Knowledge base of old issues. Or,
- For questions: Stackoverflow. Or,
- For issues: Github. Or,
- Ask your question in the Slack channel: Slack.