🚀 Remote control and automated testing for iOS & Android devices
GADS is a platform for remote device control and Appium test execution on mobile devices. It consists of two main components:
- Hub: A web interface for remote device control and provider management.
- Provider: Handles device setup and makes them available for remote access.
- 🔐 Authentication System
- User login with session management
- Admin user management
- 📱 Device Control
- Real-time video streaming (MJPEG)
- Remote interactions: tap, swipe, text input
- App installation/uninstallation
- High-quality screenshots
- Device reservation system
- 🔄 Backend Capabilities
- Web interface serving
- Provider communication proxy
- Experimental Selenium Grid replacement
- 🛠️ Easy Setup
- UI-based device management
- 🤖 Automated Device Provisioning
- Per-device Appium server configuration
- 📡 Remote Control
- iOS streaming via WebDriverAgent
- Android streaming via GADS-Android-stream
- Comprehensive Appium-based device interaction
- 🧪 Testing Integration
- Individual Appium server endpoints
- Optional Selenium Grid 4 node registration
| OS | Android Support | iOS Support | Notes |
|---|---|---|---|
| macOS | ✅ | ✅ | Full support |
| Linux | ✅ | Limited iOS support due to Xcode dependency | |
| Windows | ✅ | Limited iOS support due to Xcode dependency |
Before getting started, make sure you have the following:
- A MongoDB instance (v6.0 recommended)
- Network connectivity between Hub, Providers, MongoDB, and Selenium Grid
- Go to the releases page and download the latest binary for your platform.
# Clone the repository
git clone https://github.com/shamanec/GADS
# Build the UI
cd hub/gads-ui
npm install
npm run build
# Build the application
cd ../..
go build .The project uses MongoDB for storing logs and for synchronization of some data between hub and providers. You can either run MongoDB in a docker container:
- You need to have Docker(Docker Desktop on macOS, Windows) installed.
- Execute
docker run -d --restart=always --name mongodb -p 27017:27017 mongo:6.0. This will pull the official MongoDB 6.0 image from Docker Hub and start a container binding ports27017for the MongoDB instance. - You can use MongoDB Compass or another tool to access the db if needed.
or
- Start MongoDB instance in the way you prefer
For detailed instructions on setting up the Hub, refer to the Hub Setup Docs
For detailed instructions on setting up the Provider, refer to the Provider Setup Docs.
To ensure that GADS runs continuously and can be managed easily, it is recommended to execute it as a service on your operating system. Running GADS as a service allows it to start automatically on boot, restart on failure, and be managed through standard service commands.
For detailed instructions on how to create a service for Linux using systemd, please refer to the Linux Service Documentation.
Note: Service implementation for Windows is yet to be documented.
Note: Service implementation for macOS is yet to be documented.
The FAQ (Frequently Asked Questions) section has been created to provide quick answers to the most common questions about GADS. If you have any questions regarding installation, setup, or functionality, check out the answers in our documentation.
For more details, refer to the full FAQ.
| About | |
|---|---|
| go-ios | Many thanks for creating this CLI tool to communicate with iOS devices, perfect for installing/reinstalling and running WebDriverAgentRunner without Xcode |
| Appium | It would be impossible to control the devices remotely without Appium for the control and WebDriverAgent for the iOS screen stream, kudos! |
