EEveon Documentation
A lightweight, bash-based continuous deployment system that automatically deploys code from GitHub to your production server.
Installation
Install EEveon directly from PyPI (recommended) or from source.
From PyPI
pip install eeveon
From Source
git clone https://github.com/adarsh-crypto/eeveon.git
cd eeveon
./install.sh
source ~/.bashrc
Quick Start
Get a pipeline running in seconds.
1. Initialize a Pipeline
eeveon init \
--repo https://github.com/username/repo.git \
--name myproject \
--path /var/www/myproject \
--branch main
2. Start Monitoring
eeveon start myproject
How It Works
EEveon simplifies the deployment process into a linear flow:
- Push: You push code to GitHub.
- Poll: EEveon checks for new commits every 2 mins.
- Detect: It detects hash changes between local and remote.
- Deploy: Automatically pulls, rsyncs to production, and runs hooks.
Configuration
EEveon uses standard configuration files inside your project.
.deployignore
Exclude files from being deployed to production (like .git, node_modules).
.git
node_modules
*.log
.env.template
.env
Environment variables are securely copied to the production folder.
NODE_ENV=production
PORT=3000
API_KEY=secret_key
Web Dashboard (v0.4.0+)
EEveon now includes a real-time web dashboard for monitoring and managing your deployments.
Launching the Dashboard
eeveon dashboard
The dashboard will start on http://localhost:8000 by default. You'll receive an
authentication token in the terminal output.
Dashboard Features
- Live Metrics: Real-time pipeline status, uptime, memory usage, and node count
- Interactive Controls: Deploy, rollback, approve, and remove projects from the browser
- Notification Management: Configure Slack, Teams, Discord, Telegram, and custom webhooks
- Multi-Node View: Monitor all registered edge nodes in your cluster
Authentication
The dashboard uses token-based authentication. Copy the token from the terminal and access:
http://localhost:8000/?token=YOUR_TOKEN_HERE
Multi-Node Orchestration (v0.4.0+)
Deploy to multiple servers simultaneously with cluster-wide atomic switching.
Register a Node
eeveon nodes add 192.168.1.100 deploy-user --name production-1
List Nodes
eeveon nodes list
When you deploy a project, EEveon will automatically sync to all registered nodes and perform an atomic blue-green switch across the entire cluster.
CLI Commands
| Command | Description |
|---|---|
eeveon init |
Initialize a new deployment pipeline |
eeveon list |
List all configured pipelines |
eeveon start <project> |
Start monitoring a pipeline |
eeveon stop <project> |
Stop a running pipeline |
eeveon deploy <project> |
Trigger immediate deployment |
eeveon logs [project] |
View deployment logs |
eeveon remove <project> |
Remove a pipeline configuration |
Troubleshooting
Pipeline not detecting changes
# Check logs
eeveon logs myproject -n 50
# Manually trigger
eeveon deploy myproject
Permission Issues
Ensure your user has write access to the deployment directory.
sudo chown -R $USER:$USER /var/www/myproject