This repository provides guidance and tools for the community to quickly get started with TRON network and development.
This repository includes Docker configurations to quickly start a single TRON FullNode connected to the Mainnet or NileNet. Simply follow the instructions to get your node up and running in no time.
You can also use this repository to set up a private TRON blockchain network. This is useful for development and testing purposes. The provided configurations make it straightforward to deploy and manage your own private chain.
Monitoring the health and performance of your TRON nodes is made easy with integrated Prometheus and Grafana services. The repository includes configurations to set up these monitoring tools, allowing you to visualize and track various metrics in real time.
We also provide tools to facilitate the CI and testing process:
- Gradle Docker: Using Gradle to automate the build and test processes for java-tron image.
- DB Fork: This tool helps launch a private Java-Tron network based on the state of the Mainnet database to support shadow fork testing.
- Docker
- Docker Compose
-
Clone the repository:
git clone https://github.com/tronprotocol/tron-docker.git cd tron-docker -
Start the services: Navigate to the corresponding directory and follow the instructions in the respective README. Then you can easily start the services.
- To start a single FullNode, use the folder single_node.
- To set up a private TRON network, use the folder private_net.
- To monitor the TRON node, use the folder metric_monitor.
- To use Gradle with Docker, check gradle docker.
- To do shadow fork testing, check db fork guidance.
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.
All contributions are welcome. Check contribution for more details.
This repository is released under the LGPLv3 license.
