README.md

Cometa - Complete Meta Test Platform

Codeless & Code-Based Testing Across Systems. Cloud & On-Prem Ready.

Created for DevOps, QA Engineers, SDETs, Developers & Business Teams

---

Admin Documentation

This section contains all the information needed for system administrators to deploy, configure, and maintain Cometa.

Core Administrative Guides:

1. System Administration

   • Deployment Guide - Complete installation and setup guide
   • User Management - Managing users, roles, and permissions
   • System Configuration - Backend resources and configuration
   • Backup & Recovery - Data backup and restore procedures
   • Security & Authentication - SSO setup and security best practices

2. Maintenance & Monitoring

   • Browser Management - Installing and managing browser versions
   • System Resources - Hardware requirements and optimization
   • Troubleshooting - Common issues and solutions

---

Quick Deployment

1. Local Installation

   git clone https://github.com/cometa-rocks/cometa.git
   cd cometa
   ./cometa.sh

   Access the UI at https://localhost:443

   • Default ports: 443 (HTTPS) and 80 (HTTP)
   • Customize ports in docker-compose.yml if needed
   • Installation typically completes in 8 minutes. If you face any issues, contact us
   • In corporate environments, review Internet access and SSO provider setup requirements.

See the Deployment Guide for manual installation steps and corporate environment requirements.

↑ Back to top

---

User Management

Cometa supports multiple user roles with granular permissions:

• SUPERUSER/ADMIN: Full system access, can manage all departments and users
• DEVOPS: Technical role with advanced capabilities
• ANALYSIS: Analysis and reporting focused role
• Department Admin: Department-specific administration rights

Role Capabilities:

• Access to edit departments
• User management within departments
• Feature creation and modification
• Test execution permissions
• Reporting and analysis access

Department-Wise Administration:

• Create department-specific admin roles
• Assign users to multiple departments
• Manage permissions at department level
• Share resources between departments

Default Superuser:

• Default superuser is created at runtime as admin:admin
• Create additional superusers via Django admin interface
• Access Django admin at http://localhost:8000/admin

User Account Operations:

• GET /backend/api/accounts/ – Retrieve all accounts (requires permissions)
• PATCH /backend/api/accounts/<user_id>/ – Modify account information
• DELETE /backend/api/accounts/<user_id>/ – Delete user account
• GET /backend/api/account_roles/ – Retrieve account roles

↑ Back to top

---

System Configuration

Backend Resources:

• Selenoid Grid: http://localhost:4444/wd/hub
• Selenoid Dashboard: http://localhost:4444/dashboard/
• Django Admin: http://localhost:8000/admin

Directory Layout:

./behave                # Behave related files
./crontabs              # Crontab files for Django & Behave
./selenoid              # Selenoid related files
./front                 # Apache and Angular files
./src                   # Django related files
./src/backend           # Backend code for URLs
./src/cometa_pj         # Django configuration
./ws-server             # WebSocket server related files

System Requirements:

• Minimum: 16GB RAM, 8 CPUs, 28GB disk space
• Recommended: Higher specs for production
• ulimit: Set to 8192 for corporate environments using proxy
• Server Time: Must be synchronized with NTP (max 10-minute deviation)
• Operating System: Linux recommended (native environment)
• CPU Architecture: AMD vs amd64 – What does it mean?

↑ Back to top

---

Security & Authentication

Cometa supports multiple SSO providers:

Google OAuth Setup:

1. Go to Google Developer Console
2. Create an OAuth application
3. Add your domain to allowed hosts
4. Retrieve client_id and secret_id
5. Paste credentials in ./front/apache-conf/metadata/accounts.google.com.client
6. Set redirect_uri to https://<domain>/callback

GitLab OAuth Setup:

1. Go to git.amvara.de
2. Create a new account
3. Settings > Application > Add new application
4. Add your domain to allowed hosts
5. Retrieve client_id and secret_id
6. Paste credentials in ./front/apache-conf/metadata/accounts/git.amvara.de.client
7. Set redirect_uri to https://<domain>/callback

Corporate Environment Configuration:

• Configure Docker to use corporate proxy:

  {
    "proxies": {
      "default": {
        "httpProxy": "http://<host>:<port>",
        "httpsProxy": "http://<host>:<port>",
        "noProxy": "localhost,127.0.0.1,172.0.0.1/8,cometa_socket,cometa_zalenium,cometa_front,cometa_behave,cometa_django,cometa_postgres,behave"
      }
    }
  }

• Required domain whitelist:

  Domain	Reason
  git.amvara.de	GitLab-runner updates
  d.amvara.de	Discord notifications
  github.com, raw.githubusercontent.com	GitHub dependencies
  hub.docker.com	Docker images
  registry.npmjs.org	Node.js packages
  pypi.org	Python libraries
  deb.debian.org	Debian packages

↑ Back to top

---

Backup & Recovery

Creating Backups:

• Execute backup script from root folder:

  ./backup.sh

• Backup includes database, features metadata, screenshots, and is timestamped.

Restoring Backups:

1. Unzip db_data.zip and copy contents to folder db_data
2. Unzip features.zip and screenshots.zip directly inside behave folder
3. Restart containers: docker-compose restart

↑ Back to top

---

Browser Management

Installing Browser Versions:

• Install latest browser versions (optional):

  ./backend/selenoid/deploy_selenoid.sh -n 3

• This configures and pulls the three newest Docker images with virtual browsers.

Browser Configuration:

• Selenoid images are the browsers available in Cometa
• Parse new browser images: https://localhost/backend/parseBrowsers/
• Support for BrowserStack, HeadSpin, or SauceLabs browsers (advanced setup)

↑ Back to top

---

Troubleshooting

Common Issues:

• Installation typically takes 8-10 minutes
• If stuck for more than 5 minutes, contact support
• Check logs: docker-compose logs -f --tail=10

Debug Mode:

• Enable frontend debug mode:

  docker exec -it cometa_front bash
  root@cometa_front:/code# ./start.sh serve

• Access debug mode at https://localhost/debug/

Import Actions:

• On first start, manually parse actions:
  • Visit https://localhost/backend/parseActions/
  • Import option also available in Admin Section

↑ Back to top

---

🆘 Need Help?

We're here to support you:

• Discord Community - Join for instant access and support
• YouTube Channel - Video tutorials and demos
• GitHub Issues - Report bugs and request features

---

🧑‍🤝‍🧑 Sponsors

• Mercedes-Benz AG
• Daimler Trucks AG

↑ Back to top