TCC-TRANSACTION Documentation

The dashboard provides two primary management interfaces:

• Event Management (事件管理): Used for monitoring and managing TCC transaction events.
• Task Management (任务管理): Used for managing transaction tasks.

TCC-TRANSACTION is an open-source solution for TCC-style (Try-Confirm-Cancel) distributed transactions in microservice architectures. It ensures high performance and eventual consistency across multiple services and databases using a three-phase approach:

1. Try: Executes the business logic, performs all necessary consistency checks, and reserves the required business resources (providing quasi-isolation).
2. Confirm: Executes the business logic using the resources reserved during the Try phase. It performs no additional business checks and must be idempotent.
3. Cancel: Releases the business resources reserved during the Try phase. This operation must also be idempotent.

If all Try operations succeed, the system proceeds to the Confirm phase. If any Try operation fails, the system proceeds to the Cancel phase to roll back the reserved resources.

To run the TCC transaction management system locally, you must start two separate services in order:

1. tcc-transaction-server: The backend service.
2. tcc-transaction-dashboard: The frontend management dashboard.

Ensure the server is running before attempting to access the dashboard.

Once the services are running, you can access the management dashboard at the following URL:

http://localhost:8888/tcc-transaction-dashboard

To begin using TCC-TRANSACTION, refer to the official documentation for setup guides, tutorials, and version-specific information:

• Official Website: https://changmingxie.github.io
• Quickstart Guide: https://changmingxie.github.io/zh-cn/docs/tutorial/quickstart.html
• Version 2.x Release Notes: https://changmingxie.github.io/zh-cn/blog/tcc-transaction-2.x-release.html
• FAQ: https://changmingxie.github.io/zh-cn/docs/faq.html

Use the following default credentials to log in to the dashboard:

• Username: admin
• Password: 123456

The development server is configured to serve physical files only from the public directory.

• To reference files in the public folder within index.html, use the %PUBLIC_URL% prefix (e.g., <link rel="icon" href="%PUBLIC_URL%/favicon.ico">).
• To access the public URL in JavaScript code, use process.env.PUBLIC_URL.

Note: It is recommended to import images and other assets directly from src via JavaScript/Webpack rather than placing them in public whenever possible.

To successfully run the dashboard via startup.sh, ensure the following:

1. Java Environment: JAVA_HOME must be set, or a valid java executable must be available in your path. JDK 8 or later is recommended.
2. Directory Structure: The script expects to be run from a location where it can resolve the ${BASE_DIR} (one level up from the bin directory) to find lib/, conf/, and logs/.
3. Permissions: Ensure the script has execution permissions (chmod +x startup.sh).

Use the startup.sh script located in the dashboard/bin/ directory to launch the TCC transaction dashboard. The script requires a Java environment (JDK 8 or later is recommended) and will automatically attempt to locate JAVA_HOME if it is not already set in your environment.

Logs are written to the ${BASE_DIR}/logs/start.out file. The dashboard runs in the background using nohup.

The tcc-transaction-admin-web development server can be configured using several environment variables to control the host and WebSocket connection for hot reloading:

• HOST: The hostname to serve the dev server on (defaults to 0.0.0.0).
• WDS_SOCKET_HOST: The hostname for the WebSocket connection used by the hot reloading server.
• WDS_SOCKET_PATH: The pathname for the WebSocket connection (defaults to /sockjs-node).
• WDS_SOCKET_PORT: The port for the WebSocket connection.
• DANGEROUSLY_DISABLE_HOST_CHECK: Set to true to force-disable the host check, which is useful for development in cloud environments or using subdomains when a proxy is configured.