Documentation

Learn how to deploy and manage data tools with datax across your global infrastructure

Getting Started with datax

datax is a desktop application that helps you deploy and manage data tools across multiple hosts using Docker containers. This guide will help you get started quickly with our unique features including country-specific SCREEN technology and DATAX tools.

What you'll need:

  • ✓ A computer running Windows, macOS, or Linux
  • ✓ One or more remote servers with SSH access
  • ✓ Docker installed on your target servers
  • ✓ Basic understanding of containerization concepts

💡 Pro Tip

datax works best when you have consistent SSH access to your target hosts. Consider setting up SSH key-based authentication for smoother operation.

Installation

Downloading datax

Visit our downloads page to get the latest version of datax for your operating system. The application is completely free with no registration required.

First Launch

After installation, launch datax and you'll be greeted with the main interface. No registration or setup is required.

# Example launch command on Linux
./datax-app

# On Windows/macOS, simply double-click the application

Initial Configuration

On first launch, you may want to:

  • • Review the welcome tutorial
  • • Configure your preferred theme (light/dark)
  • • Set up keyboard shortcuts
  • • Connect to your first host

Host Management

Adding Hosts

To deploy applications, you first need to add remote hosts to datax:

  1. 1. Click the "Add Host" button in the main interface
  2. 2. Enter the host details (IP address, SSH port, credentials)
  3. 3. Test the connection to ensure SSH access works
  4. 4. Save the host configuration

Host Requirements

  • • SSH server running and accessible
  • • User account with Docker permissions
  • • Sufficient disk space for containers
  • • Firewall allowing Docker ports

Host Groups and Tags

Organize your hosts using groups and tags for easier management of large deployments:

  • • Create logical groups (e.g., "Production", "Development")
  • • Assign tags for specific attributes (e.g., "database", "web-server")
  • • Use groups and tags for targeted deployments

Application Deployment

Using the App Store

datax includes a curated collection of pre-configured data tools:

🗄️ Databases

  • • PostgreSQL 🐘
  • • MySQL 🐬
  • • Oracle Database 🔶
  • • IBM DB2 🔷

🛠️ Management Tools

  • • pgAdmin
  • • MySQL Client 💻

⚙️ DATAX Tools

  • • X0 Diagnosis 🔍
  • • X1 Simulation 🎯
  • • M3 Migration 📦
  • • T3 Sync 🔄
  • • V3 Comparison ⚖️

Deployment Process

  1. 1. Browse the app store and select an application
  2. 2. Choose target hosts for deployment
  3. 3. Configure application settings (ports, environment variables, volumes)
  4. 4. Click "Deploy" to start the installation
  5. 5. Monitor the deployment progress in real-time

Monitoring

Application Status

datax provides real-time monitoring of your deployed applications:

  • • Container status (running, stopped, error)
  • • Resource usage (CPU, memory, disk)
  • • Network connectivity
  • • Application logs

Host Metrics

Monitor the health and performance of your hosts through the dashboard interface:

  • • System resource utilization
  • • Disk space availability
  • • Network throughput
  • • Docker daemon status

Country SCREEN Technology

datax features unique country-specific SCREEN technology that optimizes performance and ensures compliance across global deployments.

Available SCREENs:

🇺🇸 US SCREEN

Optimized for North American data centers with enhanced security protocols and HIPAA compliance features.

🇪🇺 EU SCREEN

GDPR-compliant deployment with regional data sovereignty features and EU-specific security standards.

🇨🇳 CN SCREEN

Optimized for Chinese data centers with local compliance support and Great Firewall compatibility.

🇯🇵 JP SCREEN

High-performance deployment optimized for Asian infrastructure with local language support.

Selecting a SCREEN

When adding hosts, you can select the appropriate SCREEN for your region:

# During host setup, select your region
Region: United States (US SCREEN)
Compliance Profile: HIPAA
Optimization Level: Performance

DATAX Tools Suite

Our specialized DATAX tools provide enterprise-grade capabilities for data operations:

🔍 X0 Diagnosis

Performance analysis and bottleneck detection for your data systems.

  • • Query performance profiling
  • • Resource utilization analysis
  • • Index optimization recommendations

🎯 X1 Simulation

Load testing and scenario modeling for capacity planning.

  • • Custom workload simulation
  • • Stress testing capabilities
  • • Performance forecasting

📦 M3 Migration

Cross-platform data migration with validation and rollback.

  • • Schema and data transfer
  • • Incremental synchronization
  • • Automated verification

🔄 T3 Sync

Real-time data synchronization across distributed systems.

  • • Bidirectional replication
  • • Conflict resolution
  • • Scheduled synchronization

⚖️ V3 Comparison

Schema and data comparison for auditing and validation.

  • • Structural differences analysis
  • • Data discrepancy detection
  • • Change tracking reports

Troubleshooting

Common Issues

SSH Connection Failures

If you're unable to connect to a host:

  • • Verify SSH service is running on the target host
  • • Check firewall rules allow SSH connections
  • • Confirm username and credentials are correct
  • • Test manual SSH connection from terminal

Docker Deployment Errors

If applications fail to deploy:

  • • Ensure Docker is installed and running on target host
  • • Verify user has permissions to run Docker commands
  • • Check available disk space on host
  • • Review application logs for specific error messages

Performance Issues

If experiencing slow performance:

  • • Check host resource utilization (CPU, memory, disk)
  • • Verify network connectivity between hosts
  • • Consider selecting a different SCREEN for your region
  • • Review application-specific resource allocation

Getting Help

If you're still experiencing issues:

  • • Check our GitHub issues for known problems
  • • Review the application logs in the datax interface
  • • Contact our support team through the Help menu

Privacy & Logs

Data Privacy

datax is designed with privacy in mind:

  • • All data remains on your infrastructure
  • • No telemetry or usage data is collected
  • • Credentials are encrypted and stored locally
  • • No cloud dependencies for core functionality

Log Management

datax maintains comprehensive logs for troubleshooting:

  • • Application logs are stored locally
  • • Log retention is configurable
  • • Logs can be exported for analysis
  • • Sensitive information is redacted by default

⚠️ Important

While datax does not transmit your data, we recommend reviewing logs before sharing them with support to ensure no sensitive information is included.