Skip to main content

Help Guide

1. Create an Issue on Gitee Repository​

2. Frequently Asked Questions (FAQ)​

2.2 What to Do If Docker Installation Fails?​

  • Linux/Mac: Ensure commands are executed with administrator privileges (sudo) and check your network connection. Please refer to the official installation guide.
  • Windows: Confirm that WSL 2 and Hyper-V are enabled (requires Windows 10/11 Pro). Home edition users need to configure WSL 2 manually.

2.3 Getting a 404 Error When Downloading Configuration Files?​

  • Verify that the Gitee repository URL is correct and that the files docker-compose.yml and .env exist.
  • Temporary Workaround: Manually create these files by copying the repository content.

2.4 "Permission denied" Error When Running docker-compose up -d?​

  • Linux: Run sudo usermod -aG docker $USER and then log out/log back in.
  • Mac/Windows: Ensure Docker Desktop is running and that you have appropriate terminal permissions.

2.5 Cannot Access localhost:9898 After Starting the Service?​

  • Check service status: docker-compose ps (all services should show as running).
  • Confirm that your firewall/antivirus software is not blocking port 9898.
  • Try clearing your browser cache or accessing via incognito/private mode.

2.6 "Organization Already Exists" or Invalid Email During Registration?​

  • The free version only allows creating one organization.
  • Organization names must be unique, please try a different name.
  • Ensure the email format is valid (e.g., user@example.com). If already registered, please log in directly.

2.7 How to Backup or Migrate Data?​

  • Data is stored in the ./data folder. Simply copy this folder to create a backup. Place it at the same path on a new device to complete migration.

2.8 How to Update to the Latest Version?​

# Pull the latest images and restart services
docker-compose pull && docker-compose up -d

2.9 System Running Slow or Crashing?​

  • Ensure your device meets the minimum requirements (1GB RAM + 1GB disk space).
  • Use docker stats to monitor resource usage. Close unnecessary applications to free up resources.