sbujacic/congracnet repository overview

⁠CongracNet Docker Image

A containerized environment for running the CongracNet application. This image provides a robust and consistent platform for using the service, whether for local development, testing, or production deployment.

CongracNet offers functionalities that may optionally integrate with a Neo4j graph database and the Sketch Engine API.

⁠🚀 Getting Started

⁠Pull the Image

To get the latest version of the CongracNet image from Docker Hub, use the docker pull command:

docker pull sbujacic/congracnet:latest

⁠Run the Container Locally

The service inside the container runs on port 8501. When running the container on your local machine, it's recommended to map this port to the same port on your host for easy access:

docker run -d \
  --name congracnet_service \
  -p 8501:8501 \
  sbujacic/congracnet:latest

After running the command, the CongracNet service should be accessible on your host machine at http://localhost:8501.

⁠⚙️ Configuration

CongracNet supports configuration through environment variables. These can be set directly in the docker run command using the -e flag or via an .env file when using Docker Compose.

⁠Database Configuration (Neo4j)

By default, the container is pre-configured to connect to our hosted Neo4j database. If you wish to use your own self-hosted Neo4j instance, you can override these defaults by setting the following environment variables:

Example: Using your own Neo4j DB

docker run -d \
  --name congracnet_custom_db \
  -p 8501:8501 \
  -e GRAPH_USER="your_db_user" \
  -e GRAPH_PASS="your_db_password" \
  -e GRAPH_URL="bolt://your-db-host:7687" \
  sbujacic/congracnet:latest

⁠Sketch Engine API Configuration

If your application utilizes the Sketch Engine API, you will need to provide your credentials:

Example: Enabling Sketch Engine API

docker run -d \
  --name congracnet_sketch_api \
  -p 8501:8501 \
  -e SKETCH_USER="your-sketch-engine-username" \
  -e SKETCH_API_KEY="your-sketch-engine-api-key" \
  sbujacic/congracnet:latest