How to Diagnose and Fix Installation, Authentication, or Execution Issues with BotCity Tools

How to Diagnose and Fix Installation, Authentication, or Execution Issues with BotCity Tools

Diagnosis

To assist in identifying these issues, starting from version 1.2.5, the Wizard now includes the Diagnostic tool, which aims to check:

  • Connectivity with BotCity services

  • Possible network blocks

  • Installed versions of Python and Java in the environment

How to use the Diagnostic:

  1. Run the Wizard as usual.

  2. Provide your Maestro credentials.

  3. Click "Run" in the Diagnostic section.

  4. The system will generate a detailed report about the execution environment.

Solution

BotCity operates through cloud services, and the Runner communicates with Maestro via HTTPS (port 443).
It is crucial to ensure that this port is open for communication, even if it is not actively occupied.

Network and environment requirements for restricted environments:

  • Firewall URL allowlist:

    • https://*.botcity.dev/ (port 443 - Maestro, Studio, APIs)

    • https://sdk.botcity.dev/ (port 443 - SDKs, templates)

  • If using Python for development:

    • Allow access to https://pypi.org/* (Python Package Index - PyPI)

    • Install Python 3.8 or higher (recommended: 3.10)

    • Install the following packages: pip, virtualenv, setuptools

  • If using Java for development:

    • Allow access to https://repo1.maven.org/maven2/ (Maven Central)

    • Allow access to https://devtools.botcity.dev:8081/ (BotCity Nexus)

Conclusion

If you are experiencing installation, authentication, or execution failures while using BotCity tools, it is highly recommended to run the Diagnostic tool and ensure that the domains and ports listed above are properly allowed through your company's firewall.