Docker

This guide provides detailed instructions on how to deploy Hoop using Docker, tailored for both beginners and experienced users. You will learn how to configure the Docker environment and integrate Hoop into your workflow.

Prerequisites:

Docker installed on your machine

Basic knowledge of Docker command-line tools

Step 1: Prepare the Docker Environment

docker

FROM python:3.9-slim
RUN mkdir /app
WORKDIR /app
RUN apt-get update -y && \
    apt-get install curl -y && \
    curl -s -L https://releases.hoop.dev/release/install-cli.sh | sh

This sets up the Python environment and installs necessary tools using curl.

Step 2: Install Dependencies

docker

RUN pip install --upgrade pip
COPY requirements.txt /app
RUN pip install -r requirements.txt
COPY . /app/

Here, we update pip and install the project dependencies defined in requirements.txt.

Step 3: Expose the Application and Set the Command

docker

EXPOSE 8000
CMD ["hoop", "run", "--command='python manage.py runserver 0.0.0.0:8000'"]

This command sets the server to listen on port 8000 and starts the application.

Running Hoop as a Standalone Agent

This section guides you through deploying Hoop as a standalone agent, which allows for the management of multiple connections independently of your main application. This setup is ideal for scenarios where you require a dedicated service handling various data interactions.

Prerequisites:

Docker installed on your system.

An active Hoop account with a generated authentication key.

Configuration and Deployment:

Step 1: Retrieve Your Authentication Key

Before deploying the agent, ensure you have your HOOP_KEY ready. This key is necessary for authenticating your standalone agent with the Hoop servers.

Step 2: Set Up the Docker Container

plain text
shellCopy code
docker run --name hoopagent -e HOOP_KEY=<AUTH-KEY> hoophq/hoopdev

Replace <AUTH-KEY> with your actual Hoop authentication key.

This command pulls the latest Hoop image suited for the amd64 architecture and starts the agent with your specified configurations.

Important Notes:

The Docker image hoophq/hoopdev is specifically built for the amd64 architecture. Ensure your deployment environment is compatible.

The container named hoopagent will run in the background and manage all specified connections.

Step 3: Verifying the Installation

To ensure your Hoop agent is running correctly, you can check the container's logs using:

plain text
shellCopy code
docker logs hoopagent

Look for any error messages or confirmations that the service has started successfully.

Troubleshooting Common Issues:

Authentication Failures: Ensure that the HOOP_KEY is correctly entered without any extra spaces or characters.

Container Does Not Start: Verify that your Docker environment is correctly set up and that there are no conflicts with existing containers or network settings.

Feedback and Support:

If you encounter issues or have suggestions for improving this documentation, please contact our support team at support@hoop.dev or leave feedback through our documentation site.