Files
aitbc/documentation/SETUP.md
aitbc 7035f09a8c docs: reorganize project structure and update root README
Project Organization:
- Moved configuration files to project-config/ directory
- Moved documentation files to documentation/ directory
- Moved security reports to security/ directory
- Moved backup files to backup-config/ directory
- Created PROJECT_ORGANIZATION_SUMMARY.md documenting changes
- Updated all script references to new file locations

Root README Simplification:
- Replaced 715-line detailed README with 95-line structure guide
2026-04-02 23:17:02 +02:00

4.0 KiB

AITBC Setup Guide

Quick Setup (New Host)

Run this single command on any new host to install AITBC:

sudo bash <(curl -sSL https://raw.githubusercontent.com/oib/aitbc/main/setup.sh)

Or clone and run manually:

sudo git clone https://gitea.bubuit.net/oib/aitbc.git /opt/aitbc
cd /opt/aitbc
sudo chmod +x setup.sh
sudo ./setup.sh

What the Setup Script Does

  1. Prerequisites Check

    • Verifies Python 3.13.5+, pip3, git, systemd
    • Checks for root privileges
  2. Repository Setup

    • Clones AITBC repository to /opt/aitbc
    • Handles multiple repository URLs for reliability
  3. Virtual Environments

    • Creates Python venvs for each service
    • Installs dependencies from requirements.txt when available
    • Falls back to core dependencies if requirements missing
  4. Runtime Directories

    • Creates standard Linux directories:
      • /var/lib/aitbc/keystore/ - Blockchain keys
      • /var/lib/aitbc/data/ - Database files
      • /var/lib/aitbc/logs/ - Application logs
      • /etc/aitbc/ - Configuration files
    • Sets proper permissions and ownership
  5. Systemd Services

    • Installs service files to /etc/systemd/system/
    • Enables auto-start on boot
    • Provides fallback manual startup
  6. Service Management

    • Creates /opt/aitbc/start-services.sh for manual control
    • Creates /opt/aitbc/health-check.sh for monitoring
    • Sets up logging to /var/log/aitbc-*.log

Runtime Directories

AITBC uses standard Linux system directories for runtime data:

/var/lib/aitbc/
├── keystore/     # Blockchain private keys (700 permissions)
├── data/         # Database files (.db, .sqlite)
└── logs/         # Application logs

/etc/aitbc/       # Configuration files
/var/log/aitbc/   # System logging (symlink)

Security Notes

  • Keystore: Restricted to root/aitbc user only
  • Data: Writable by services, readable by admin
  • Logs: Rotated automatically by logrotate

Service Endpoints

Service Port Health Endpoint
Wallet API 8003 http://localhost:8003/health
Exchange API 8001 http://localhost:8001/api/health
Coordinator API 8000 http://localhost:8000/health
Blockchain RPC 8545 http://localhost:8545

Management Commands

# Check service health
/opt/aitbc/health-check.sh

# Restart all services
/opt/aitbc/start-services.sh

# View logs (new standard locations)
tail -f /var/lib/aitbc/logs/aitbc-wallet.log
tail -f /var/lib/aitbc/logs/aitbc-coordinator.log
tail -f /var/lib/aitbc/logs/aitbc-exchange.log

# Check keystore
ls -la /var/lib/aitbc/keystore/

# Systemd control
systemctl status aitbc-wallet
systemctl restart aitbc-coordinator-api
systemctl stop aitbc-exchange-api

Troubleshooting

Services Not Starting

  1. Check logs: tail -f /var/lib/aitbc/logs/aitbc-*.log
  2. Verify ports: netstat -tlnp | grep ':800'
  3. Check processes: ps aux | grep python
  4. Verify runtime directories: ls -la /var/lib/aitbc/

Missing Dependencies

The setup script handles missing requirements.txt files by installing core dependencies:

  • fastapi
  • uvicorn
  • pydantic
  • httpx
  • python-dotenv

Port Conflicts

Services use these default ports. If conflicts exist:

  1. Kill conflicting processes: kill <pid>
  2. Modify service files to use different ports
  3. Restart services

Development Mode

For development with manual control:

cd /opt/aitbc/apps/wallet
source .venv/bin/activate
python simple_daemon.py

cd /opt/aitbc/apps/exchange
source .venv/bin/activate
python simple_exchange_api.py

cd /opt/aitbc/apps/coordinator-api/src
source ../.venv/bin/activate
python -m uvicorn app.main:app --host 0.0.0.0 --port 8000

Production Considerations

For production deployment:

  1. Configure proper environment variables
  2. Set up reverse proxy (nginx)
  3. Configure SSL certificates
  4. Set up log rotation
  5. Configure monitoring and alerts
  6. Use proper database setup (PostgreSQL/Redis)