> For the complete documentation index, see [llms.txt](https://docs.envio.dev/llms.txt). # Deploying Your Indexer Envio Cloud provides a seamless git-based deployment workflow, similar to modern platforms like Vercel. This enables you to easily deploy, update, and manage your blockchain indexers through your normal development workflow. ## Prerequisites & Important Information ### Requirements - **Version Support**: We strongly advise using the latest [release version](https://github.com/enviodev/hyperindex/releases) for improved deployment performance. Envio Cloud requires a minimum version of at least `2.21.5`. Additionally, the following versions are not supported on Envio Cloud: - `2.29.x` - **PNPM Support**: the deployment must be compatible with pnpm version `10.32.0` - **Repository Folder**: - **Package.json**: a `package.json` file must be present in the root folder and support the above two requirements, with the envio version explicitly configured in the dependencies. - **Configuration file**: a HyperIndex [configuration file](/docs/HyperIndex/configuration-file) must be present. The root folder and configuration file name can be set in the [indexer settings](#configure-your-indexer). - **GitHub Repository**: The repository must be no larger than `100MB`. Caching between deployments is supported for paid plans using the [Effects Api](/docs/HyperIndex/effect-api#cache-on-envio-cloud). - **Node Version**: It is strongly recommended that the indexer is compatible with node version [24 or higher](https://github.com/nodejs/node/tags). :::note Fair use and limitations Before deploying your indexer, please be aware of the below limits and policies ::: ### Deployment Limits - **3 development plan indexers** per organization - **Deployments per indexer**: 3 deployments per indexer - Deployments can be deleted in Envio Cloud to make space for more deployments ### Development Plan Fair Usage Policy The free development plan includes automatic deletion policies to ensure fair resource allocation: #### Automatic Deletion Rules: - **Hard Limits**: - Deployments that exceed 20GB of storage will be automatically deleted - Deployments older than 30 days will be automatically deleted - **Soft Limits** (whichever comes first): - 100,000 events processed - 5GB storage used - no requests for 7 days **When soft limits are breached, the two-stage deletion process begins** #### Two-Stage Deletion Process _Applies to development deployments that breach the soft limits_ 1. **Grace Period (7 days)** - Your indexer continues to function normally, you receive notification about the upcoming deletion 2. **Read-Only Access (3 days)** - Indexer stops processing new data, existing data remains accessible for queries 3. **Full Deletion** - Indexer and all data are permanently deleted :::warning Timeline Subject to Change The grace period durations (7 + 3 days) are subject to change. Always monitor your deployment status and upgrade when approaching limits. ::: :::tip For complete pricing details and feature comparison, see our [Pricing & Billing page](./hosted-service-billing.mdx). ::: ## Step-by-Step Deployment Instructions ### Initial Setup 1. **Log in with GitHub**: Visit the [Envio App](https://envio.dev/app/login) and authenticate with your GitHub account 2. **Select an Organization**: Choose your personal account or any organization you have access to 3. **Install the Envio Deployments GitHub App**: Grant access to the repositories you want to deploy ### Configure Your Indexer 4. **Connect a Repo**: Select the repository containing your indexer code 5. **Add the Indexer**: Click "Add Indexer" and configure your indexer 6. **Configure Deployment Settings**: - Specify the config file location - Set the root directory (important for monorepos) - Choose the deployment branch :::tip Multiple Indexers Per Repository You can deploy multiple indexers from a single repository by configuring them with different config file paths, root directories, and/or deployment branches. ::: :::warning Monorepo Configuration If you're working in a monorepo, ensure all your imports are contained within your indexer directory to avoid deployment issues. ::: ### Deploy Your Code 7. **Create a Deployment Branch**: Set up the branch you specified during configuration 8. **Deploy via Git**: Push your code to the deployment branch 9. **Monitor Deployment**: Track the progress of your deployment in the Envio dashboard ### Manage Your Deployment 10. **Version Management**: Once deployed, you can: - View detailed logs - Switch between different deployed versions - Rollback to previous versions if needed ## Updating Your Deployment After your initial deployment, you can update your indexer by pushing new commits to the deployment branch. Each push creates a new deployment version. ### What happens on each push When you push to your deployment branch, Envio Cloud will: 1. Build your updated indexer code 2. Start a **new deployment** that re-indexes from the start block 3. Keep your previous deployment running and serving queries until the new one is fully synced This means there is **no downtime** during updates — your existing deployment continues serving data while the new one catches up. ### When re-indexing is required A full re-index from the start block happens on every new deployment. This includes changes to: - Event handler logic - Schema (`schema.graphql`) - Configuration (`config.yaml`) - ABIs or contract addresses :::tip Use the [Effects API cache](../Advanced/effect-api.md#cache-on-envio-cloud) to speed up re-indexing by caching expensive external calls (like `eth_call` results) across deployments. This is available on paid plans. ::: ### Adding a new chain to your indexer To add a new chain, update your `config.yaml` with the new network configuration and push to the deployment branch. The new deployment will index all configured chains, including the new one. Your previous deployment continues serving data for the existing chains while the new deployment syncs. ### Rolling back to a previous version If a new deployment introduces issues, you can switch back to a previous version from the Envio Cloud dashboard. Navigate to your indexer and select the version you want to activate. ## Monitoring Once your indexer is deployed, you can monitor its health, performance, and progress using several built-in tools including the dashboard, logs, and alerts. For detailed information about monitoring your deployments, see our **[Monitoring Guide](./hosted-service-monitoring.md)**. ## Continuous Deployment Best Practices and Configuration For a robust deployment workflow, we recommend: 1. **Protected Branches**: Set up branch protection rules for your deployment branch 2. **Pull Request Workflow**: Instead of pushing directly to the deployment branch, use pull requests from feature branches 3. **CI Integration**: Add tests to your CI pipeline to validate indexer functionality before merging to the deployment branch ### Continuous Configuration After deploying your indexer, you can manage its configuration through the `Settings` tab in the Envio Cloud dashboard: #### General Tab The General tab provides core configuration options: - **Config File Path**: Update the location of your indexer's configuration file - **Deployment Branch**: Change which Git branch triggers deployments - **Root Directory**: Modify the root directory for your indexer (useful for monorepos) - **Delete Indexer**: Permanently remove the indexer and all its deployments :::warning Deleting an Indexer Deleting an indexer is permanent and will remove all associated deployments and data. This action cannot be undone. ::: #### Environment Variables Tab Configure environment-specific variables for your indexer: - Add custom environment variables with the `ENVIO_` prefix - Environment variables are securely stored and injected into your indexer at runtime - Useful for API keys, configuration values, and other deployment-specific settings :::tip Environment Variable Best Practices Use environment variables for sensitive data rather than hardcoding values in your repository. Remember to prefix all variables with `ENVIO_`. ::: #### Plans & Billing Tab Manage your indexer's pricing plan and billing: - Select from available pricing plans - Upgrade your plan to suit your needs - View current plan features and limits For detailed pricing information, see our [Pricing & Billing page](./hosted-service-billing.mdx). #### Alerts Tab Configure monitoring and notification preferences: - Set up notification channels (Discord, Slack, Telegram, Email) - Choose which alert types to receive (Production Endpoint Down, Indexer Stopped Processing, etc.) - Configure deployment notifications (Historical Sync Complete) For complete alert configuration details, see our [Features page](./hosted-service-features.md#built-in-alerts). :::info Alert Availability Alert configuration is available for indexers deployed with version 2.24.0 or higher on paid production plans. ::: ## Visual Reference Guide The following screenshots show each step of the deployment process: ### Step 1: Select Organization ![Select organisation](/img/deploying/select-org.png) ### Step 2: Install GitHub App ![Install GitHub App](/img/deploying/install-github-app.png) ### Step 3: Connect a Repo ![Connect a repo](/img/deploying/connect-repo.png) ### Step 4: Add the Indexer ![Add the indexer](/img/deploying/add-indexer.png) ### Step 5: Configure Deployment Settings ![Configure indexer](/img/deploying/configure-indexer.png) ### Step 6: Create a Deployment Branch ![Create deployment branch](/img/deploying/create-deployment-branch.webp) ### Step 7: Deploy via Git ![Deploy via Git](/img/deploying/deploy-via-git.webp) ### Step 8: Indexer Deployed Once deployment completes, your indexer should be live and you should see the overview dashboard below. Full monitoring details are available in our **[Monitoring Guide](./hosted-service-monitoring.md)**. ![Indexer overview](/img/deploying/indexer-overview.png) ### Step 9: Manage Indexer Configuration Manage indexer configurations and deployments using the sidebar navigation on the left. ![Manage indexer configuration](/img/deploying/manage-indexer-nav.png) ## Related Documentation - **[Features](./hosted-service-features.md)** - Learn about all available Envio Cloud features - **[Envio Cloud CLI](./envio-cloud-cli.md)** - Deploy and manage indexers from the command line - **[Pricing & Billing](./hosted-service-billing.mdx)** - Compare plans and see feature availability - **[Overview](./hosted-service.md)** - Introduction to Envio Cloud - **[Self-Hosting](./self-hosting.md)** - Run your indexer on your own infrastructure ---