TRON Docker

This repository provides tools and guidance to help the community quickly get started with the TRON network and development.

Features

🚀 Quick start for single FullNode

Easily deploy a single TRON FullNode connected to Mainnet or Nile testnet using Docker. Follow the instructions to get your node up and running in minutes.

🔗 Private chain setup

Set up your own private TRON blockchain network for development and testing. The provided configurations simplify deployment and management, making it ideal for custom use cases.

📊 Node monitoring with Prometheus and Grafana

Monitor the health and performance of your TRON nodes with integrated Prometheus and Grafana services. Real-time metrics and visualizations are just a few steps away.

🛠️ Tools

We also provide tools to facilitate the CI and testing process:

• Gradle Docker: Automate the build and testing of the java-tron Docker image using Gradle.
• DBFork: Launch a private java-tron network based on the Mainnet database state, enabling shadow fork testing.

Getting Started

Prerequisites

• Docker
• Docker Compose

Start the services

First clone the repository:

git clone https://github.com/tronprotocol/tron-docker.git
cd tron-docker

Then, navigate to the relevant directory and follow the instructions in the respective README to start the services：

• TRON network deployment related:

  • Single FullNode: Use the single_node folder.
  • Private TRON network: Use the private_net folder.
  • Node monitoring: Use the metric_monitor folder.

• Tools:

  • Gradle Docker: Automate Docker image builds and testing. Check the gradle docker documentation.
  • DBFork: Perform shadow fork testing. Follow the DBFork guidance.

Troubleshooting

If you encounter any difficulties, please refer to the Issue Work Flow, then raise an issue on GitHub. For general questions, please use Discord or Telegram.

Contributing

All contributions are welcome. Check contribution for more details.

License

This repository is released under the LGPLv3 license.