Helpful Tips & Troubleshooting

Use this guide to manage your Clarity Connect environment, perform connectivity tests, and resolve common container issues.

Common Docker Management

Always run these commands from the directory containing your configuration file to ensure the correct stack is targeted.

# View running containers and health status
docker ps

# Stop the entire stack
docker-compose down

# Force a recreate/update of all containers
docker-compose up -d --force-recreate

Network & Firewall Whitelisting

If you encounter ECR or Network Timeout errors, ensure your firewall permits outbound traffic to the following endpoints on port 443:

• https://your-tenant.claritysecurity.io

• https://auth.docker.io

• https://public.ecr.aws/d7a3o6p2

• https://production.cloudflare.docker.com/

Advanced Connectivity Troubleshooting

When the host OS has connectivity but the application fails to sync, you must test from within the container environment.

Testing LDAP/AD Connectivity

# Enter the container shell
docker exec -it clarityconnectmain /bin/sh

# Install LDAP tools inside the container
apk add openldap-clients

# Run a search test (Replace values with your server info)
ldapsearch -x -H ldap://[SERVER-IP] -D "[BIND-DN]" -W -b "[SEARCH-BASE]"

Testing Port Access (Telnet)

Use this to verify if ports like 389, 636, or 1433 are being blocked by an internal firewall.

# Install telnet tools
apk add busybox-extras

# Attempt connection to server on port 389, 636, or 1433
busybox-extras telnet [IP-ADDRESS] [PORT]

Internal Diagnostics (Tinker)

The Tinker shell allows you to run internal application logic to verify configuration credentials.

# Open the internal shell
docker-compose exec clarityconnectmain php artisan tinker

# Inside tinker, test connection logic for a specific App ID
ADService::getConnection(YOUR_APP_ID)

Log Inspection

If you are working with Clarity Support, you may be asked to provide a tail of the application logs to see detailed error stack traces. Check the Laravel logs for detailed error stack traces regarding connection attempts to Clarity Security.

# View live application logs
tail -f storage/logs/laravel-$(date +%Y-%m-%d).log