Self-Hosted

Self-Hosted Deployment

Pre-requisites:

  1. Docker Installed on the machine used to deploy the container.
  2. BigGeo image in the docker registry.
  3. The directory /storage exists which will be used to persist collections.
  4. Port 50051 is not being used on the local machine.

This method of deployment will result in a running container of BigGeo search that communicates using gRPC protocol.

We will use the docker_compose.yml to deploy BigGeo as a container named bg-search.

version: '3.8'
services:

  bg-search:
    restart: always
    image: <docker-registry>/bg-search:latest
    container_name: bg-search
    ports:
      - 50051:50051
    networks:
      - bg-network
    environment:
      BGSEARCH_PSWD: bg-search-pass
      BGSEARCH_AUTH_ENABLED: false
      BGSEARCH_PATH_PREFIX: /storage/
    volumes:
      - bg-search-vol:/storage
volumes:
  bg-search-vol:
networks:
  bg-network:

To run the docker_compose.yml the user will need to run the following command in the terminal in the same directory where the docker compose file is placed.

foo@bar:~$ sudo docker compose up -d

To verify the container is working as expected, we expect to see logs similar to the following:

foo@bar:~$ sudo docker logs bg-search

gRPC authentication is disabled
Using /storage/ as path prefix
bgsearch version: 0.18.4.0
Server listening on 172.0.0.2
Getting current directory has failed

From here the container is now running and ready to accept requests over port 50051.