thirdweb Engine Deploy Locally

Let's deploy thirdweb Engine locally in easiest way possible. This repository is maintained by thirdweb community team.

Warning

Use this for demo / preview purposes only. This is not recommended for production use. If you wanna use thirdweb Engine in production, try cloud-hosted version or deploy a self-hosted version.

Requirements

• Docker
• NodeJS
• Postgres (only supports v14+)
• Redis (only supports v7.2.4+)
• thirdweb API secret key
• Wallet address

Usage

1. Clone the repository.
2. Configure the .env.example file with your API secret key, wallet address, and ngrok auth token.
3. Start Docker on your local machine.
4. Run npm run start to deploy the engine locally, wait for it to finish.
5. A new tab will open in your browser if you provided ngrok auth token in the .env file.
   • This will be your ngrok URL to access the engine from anywhere. You can use this URL to import it to your thirdweb dashboard.
6. If not, visit https://localhost:3005 in your browser.
7. That's it!

For detailed guide, visit here.

Note

We recommend to use the versioned image instead of latest tag in the docker-compose.yml file. You can find the versioned image list in the Docker Hub.

Get Help

• Documentation
• Submit a ticket
• Join Discord