Distributed, No-code Performance Testing within Your Own Infrastructure

This README provides instructions for installing and an overview of the system requirements for Ddosify Self-Hosted. For further information on its features, please refer to the "What is Ddosify" section in the main README, or consult the complete documentation.

Effortless Installation

✅ Arm64 and Amd64 Support: Broad architecture compatibility ensures the tool works seamlessly across different systems on both Linux and MacOS.

✅ Dockerized: Containerized solution simplifies deployment and reduces dependency management overhead.

✅ Helm Chart: Helm chart for Kubernetes deployments.

✅ Easy to Deploy: Automated setup processes using Docker Compose and Helm Charts.

🛠 Prerequisites

• Git
• Docker
• Docker Compose (docker-compose or docker compose)

Recommended System Requirements

• Operating System: macOS 10.15 Catalina or later, or Linux (Ubuntu 20.04 LTS, Debian 10, CentOS 8 or later). Windows is not supported.
• Processor: Quad-core CPU (4 cores) at 2.5 GHz or higher, ARM-based processors are also supported (e.g., Apple M1, M2)
• Memory: 8 GB RAM or more
• Storage: At least 5 GB of available hard drive space (preferably SSD for faster load times)

⚡️ Quick Start (Recommended)

You can quickly deploy Ddosify Self Hosted by running the following command. This script clones the Ddosify repository to your $HOME/.ddosify directory, and deploys the services using Docker Compose. Please check the install.sh file to see what it does. You can also run the commands manually by following the Manual Installation section.

Only Linux and MacOS are supported at the moment. Windows is not supported.

Ddosify Self Hosted starts in the background. You can access the dashboard at http://localhost:8014. The system is started always on boot if Docker is started. You can stop the system in the Stop/Start the Services section.

curl -sSL https://raw.githubusercontent.com/ddosify/ddosify/master/selfhosted/install.sh | bash

🚀 Deploy on Kubernetes

You can deploy Ddosify Self Hosted on Kubernetes using the Helm chart.

📖 Manual Installation

1. Clone the repository

git clone https://github.com/ddosify/ddosify.git
cd ddosify/selfhosted

2. Update the environment variables (optional)

The default values for the environment variables are set in the .env file. You can modify these values to suit your needs. The following environment variables are available:

• DOCKER_INFLUXDB_INIT_USERNAME: InfluxDB username. Default: admin
• DOCKER_INFLUXDB_INIT_PASSWORD: InfluxDB password. Default: ChangeMe
• DOCKER_INFLUXDB_INIT_ADMIN_TOKEN: InfluxDB admin token. Default: 5yR2qD5zCqqvjwCKKXojnPviQaB87w9JcGweVChXkhWRL
• POSTGRES_PASSWORD: Postgres password. Default: ChangeMe

3. Deploy the services

docker-compose up -d

4. Access the dashboard

The dashboard is available at http://localhost:8014

5. Show the logs

docker-compose logs

🔧 Add New Engine

The Ddosify Engine is responsible for generating load to the target URL. You can add multiple engines to scale your load testing capabilities.

The Ddosify Self Hosted includes a default engine out of the box. To integrate additional engines, simply run a Docker container for each new engine. These engine containers will automatically register with the service and become available for use. Before adding new engines, ensure that you have enabled the distributed mode by clicking the Unlock the Distributed Mode button in the dashboard.

In case you have modified the default values like InfluxDB password in the .env file, utilize the --env flag in the docker run command to establish the necessary environment variables.

Make sure the new engine server can access the service server. Use the DDOSIFY_SERVICE_ADDRESS environment variable to specify the service server address where the install.sh script was executed.

The engine server must connect to the following ports on the DDOSIFY_SERVICE_ADDRESS:

• 9901: Hammer Manager service. The service server utilizes this port to register the engine.
• 6672: RabbitMQ server. The engine server connects to this port to send and receive messages to and from the service server.
• 9086: InfluxDB server. The engine server accesses this port to transmit metrics to the backend.
• 8333: Object storage server. The engine server uses this port to retrieve the object files like CSV and multipart files.

The NAME environment variable is used to specify the name of the engine container. You can change this value to whatever you want. It is also used in the Remove New Engine section for removing the engine container.

Example 1: Adding the engine to the same server

NAME=ddosify_hammer_1
docker run --name $NAME -dit \
    --network selfhosted_ddosify \
    --restart always \
    ddosify/selfhosted_hammer:1.0.0

Example 2: Adding the engine to a different server

Set DDOSIFY_SERVICE_ADDRESS to the IP address of the service server. Set IP_ADDRESS to the IP address of the engine server.

# Make sure to set the following environment variables
DDOSIFY_SERVICE_ADDRESS=SERVICE_IP
IP_ADDRESS=ENGINE_IP
NAME=ddosify_hammer_1

docker run --name $NAME -dit \
    --env DDOSIFY_SERVICE_ADDRESS=$DDOSIFY_SERVICE_ADDRESS \
    --env IP_ADDRESS=$IP_ADDRESS \
    --restart always \
    ddosify/selfhosted_hammer:0.1.0

You should see mq_waiting_new_job log in the engine container logs. This means that the engine is waiting for a job from the service server. After the engine is added, you can see it in the Engines page in the dashboard.

Example 3: Adding the engine to Kubernetes

You can deploy the engine on Kubernetes using the Helm chart. Please check the Ddosify Helm chart repository for more information.

🧹 Remove New Engine

If you added new engines, you can remove them by running the following command. Change the docker container name ddosify_hammer_1 to the name of the engine you added.

docker rm -f ddosify_hammer_1

🛑 Stop/Start the Services

If you installed the project using the install.sh script, you must first change the directory to the $HOME/.ddosify directory before running the commands below.

cd $HOME/.ddosify/selfhosted
docker compose down

If you want to remove the complete data like databases in docker volumes, you can run the following command. ⚠️ Warning: This will remove all the data for Ddosify Self Hosted.

cd $HOME/.ddosify/selfhosted
docker compose down --volumes

You may encounter the following error when running the docker compose down command if you did not remove the engine containers. This is completely fine. The network selfhosted_ddosify is not removed from docker. If you do not want to see this error, you can remove the engine containers first then run the docker compose down command again.

failed to remove network selfhosted_ddosify: Error response from...

If you want to start the project again, run the script in the Quick Start section again.

🧩 Services Overview

Service	Description
Hammer	The engine responsible for executing load tests. You can add multiple hammers to scale your load testing capabilities.
Hammer Manager	Manages the engines (Hammers) involved in load testing.
Backend	Handles load test management and stores results.
InfluxDB	Database that stores metrics collected during testing.
Postgres	Database that preserves load test results.
RabbitMQ	Message broker enabling communication between Hammer Manager and Hammers.
SeaweedFS Object Storage	Object storage for multipart files and test data (CSV) used in load tests.
Nginx	Reverse proxy for backend and frontend services.

📝 License

Ddosify Self Hosted is licensed under the AGPLv3: https://www.gnu.org/licenses/agpl-3.0.html