Getting Started - TL;DR

Tip

If you are lazy, use Docker. Do a git clone ; copy .env.sample to .env ; docker compose up then go to localhost:5000.

docker compose versionDocker Compose version v2.5.0git clone https://github.com/stanfrbd/cyberbrocd cyberbrocp .env.sample .envdocker compose up --build
Go to http://127.0.0.1:5000/

Getting Started

• Clone the repository:

git clone https://github.com/stanfrbd/cyberbro
cd cyberbro

• Create your environment file:

cp .env.sample .env

• Fill your .env values (API keys, proxy, runtime options).

Note

No API keys yet? Keep .env mostly empty and start with free engines.

Warning

Do not commit .env in Git.

Danger

For production/team use, store .env secrets with SOPS, Vault, or an equivalent secrets manager.

See Advanced options for deployment for the full list of variables and migration guidance.

Launch the app

Lazy and easy - use Docker

Warning

Make sure you install the compose plugin as docker compose and not docker-compose.

docker compose up # use -d to run in background and use --build to rebuild the image

• Go to http://127.0.0.1:5000 and enjoy.

Using the docker image from GitHub Packages and a custom docker compose file

• See more in Advanced deployment options

The old way

• Clone the repository and install the requirements.

You might want to create a venv before installing the dependencies.

pip install -r requirements.txt

• Run the app with gunicorn (clean mode).

gunicorn -c prod/gunicorn.conf.py app:app

Note

When running without Docker, gunicorn behavior is controlled by environment variables such as FLASK_PORT, FLASK_HOST, GUNICORN_WORKERS_COUNT, GUNICORN_THREADS_COUNT, and GUNICORN_TIMEOUT.

• Run the app in development mode.

python3 app.py