Install Now
How to install BigBodyCobain/Shadowbroker. Official installation instructions. Project installation guide. Framework or library installation. Build installation instructions. How to setup and install from GitHub. Installation steps and setup instructions. Official docs and installation instructions GitHub.
BigBodyCobain/Shadowbroker Installation Guide
How to install BigBodyCobain/Shadowbroker. Official project installation instructions and setup guide.
⚡
Automated Install (Recommended)
Quick installation instructions for BigBodyCobain/Shadowbroker. This is the fastest way to complete project installation and setup.
Install via curl
curl -fsSL https://hexmos.com/ipm-install | bash &&
ipm i BigBodyCobain/Shadowbrokeror
Install via npx
npx @hexmos/ipm i BigBodyCobain/ShadowbrokerPrerequisites
Docker Desktop or Docker Engine
softwareNode.js
softwareVersion: 18+
npm
softwarePython
softwareVersion: 3.10-3.12
pip
softwareGit
softwareManual Installation Methods
Manual installation instructions. How to install from GitHub source.
Docker Setup (Recommended)
git clone https://github.com/BigBodyCobain/Shadowbroker.git
cd Shadowbroker
docker compose pull
docker compose up -dStandalone Deploy (Portainer, Uncloud, NAS, etc.)
wget https://raw.githubusercontent.com/BigBodyCobain/Shadowbroker/main/docker-compose.yml -O docker-compose.yml
echo "AIS_API_KEY=your_aisstream_key" >> .env
docker compose pull
docker compose up -dDeveloper Setup
git clone https://github.com/BigBodyCobain/Shadowbroker.git
cd Shadowbroker
cd backend
python -m venv venv
source venv/bin/activate
pip install -e .
cd ../frontend
npm ci
npm run devQuick Start (No Code Required)
wget https://github.com/BigBodyCobain/Shadowbroker/releases/download/v0.9.79/ShadowBroker_v0.9.79.zip
unzip ShadowBroker_v0.9.79.zip
cd Shadowbroker
chmod +x start.sh
dos2unix start.sh
./start.shPost Installation Steps
- Open http://localhost:3000 to view the dashboard.
- Ensure you have necessary API keys for optimal data feed functionality.