diff --git a/docs/HyperIndex/Advanced/effect-api.md b/docs/HyperIndex/Advanced/effect-api.md index 9562e56f..50741df5 100644 --- a/docs/HyperIndex/Advanced/effect-api.md +++ b/docs/HyperIndex/Advanced/effect-api.md @@ -168,15 +168,16 @@ When the indexer is rerun by using `envio dev` or `envio start -r` call, the ini ### Cache on Hosted Service -The same `.envio/cache` can also be used to populate the initial cache on the hosted service. +The hosted service provides built-in cache management for Effect API results, allowing you to save and restore caches directly from the dashboard without committing files to your repository. -Although this solution is very limited, and we're actively working on a better integration: +**Key Features:** +- **Save Cache**: Capture effect data from any deployment with one click via Quick Actions +- **Cache Settings**: Manage caches in Settings > Cache - enable/disable caching and select which cache to use +- **Automatic Restore**: New deployments automatically preload effect data from your selected cache -- It requires to commit `.envio/cache` to the GitHub repository, increasing the repository and git history size -- The file size is limited to 100MB, which is not enough for some use cases -- There might be issues with pulling big caches from the GitHub repository +This eliminates the need to commit `.envio/cache` to your repository and removes file size limitations. -Join our [Discord](https://discord.gg/envio) to get updates on the progress of the hosted service integration. +For detailed instructions, see the [Effect API Cache documentation](/docs/HyperIndex/hosted-service-features#effect-api-cache). ### Rate Limit diff --git a/docs/HyperIndex/Hosted_Service/hosted-service-features.md b/docs/HyperIndex/Hosted_Service/hosted-service-features.md index c282b689..ce1c4277 100644 --- a/docs/HyperIndex/Hosted_Service/hosted-service-features.md +++ b/docs/HyperIndex/Hosted_Service/hosted-service-features.md @@ -14,7 +14,36 @@ Most features listed on this page are available for **paid production plans only ::: +## Deployment Tags + +Organize and identify your deployments with custom key/value tags. Tags help you categorize deployments by environment, project, team, or any custom attribute that fits your workflow. + +**How it works:** +- Add up to **5 custom tags** per deployment via the deployment overview page +- Each tag consists of a **key** (max 20 characters) and a **value** (max 20 characters, automatically lowercased) +- Click "+ Add Tag" to create new tags, or click existing tags to edit or delete them + +**Special `name` Tag:** + +The `name` tag has special behavior—when set, its value is displayed directly on the deployment list, making it easy to identify deployments at a glance without navigating into each one. + +**Example Use Cases:** +- `name: staging` or `name: production` — quickly identify deployment purpose +- `env: staging` / `env: production` — categorize by environment +- `team: frontend` — organize by team ownership +- `version: v2` — track deployment versions + +**Benefits:** +- Quickly identify deployments in the list view +- Organize deployments across multiple projects or environments +- Add context and metadata to your deployments +- Filter and locate deployments more efficiently + + ## IP Whitelisting + +*Availability: Paid plans only* + Control access to your indexer by restricting requests to specific IP addresses. This security feature helps protect your data and ensures only authorized clients can query your indexer. **Benefits:** @@ -24,8 +53,42 @@ Control access to your indexer by restricting requests to specific IP addresses. - Ideal for production environments with strict access requirements +## Effect API Cache + +*Availability: Medium plans and up* + +Speed up your indexer deployments by caching [Effect API](/docs/HyperIndex/effect-api) results. When enabled, new deployments will start with preloaded effect data, eliminating the need to re-fetch external data and significantly reducing sync time. + +**How it works:** +1. **Save a Cache**: From any deployment, click "Save Cache" to capture the current effect data +2. **Configure Settings**: Navigate to Settings > Cache to manage your caches +3. **Enable Caching**: Toggle caching on and select which cache to use for new deployments +4. **Deploy**: New deployments will automatically restore from the selected cache + +**Key Features:** +- **Quick Save**: Save cache directly from the deployment page with one click +- **Cache Management**: View, select, and delete caches from the Cache settings page +- **Automatic Restore**: New deployments preload effect data from the active cache +- **Download Cache**: Download caches for local development, enabling faster iteration without re-fetching external data + + +**Benefits:** +- Dramatically faster deployment sync times +- Reduced external API calls during indexing +- Seamless deployment updates with preserved effect state + +:::tip +Learn more about the Effect API and how caching works in our [Effect API documentation](/docs/HyperIndex/effect-api). +::: + +:::info Version Requirement +This feature is only available for indexers deployed with version 2.26.0 or higher. +::: + ## Built-in Alerts +*Availability: Paid plans only* + Stay informed about your indexer's health and performance with our integrated alerting system. Configure multiple notification channels and choose which alerts you want to receive. :::info Version Requirement @@ -114,5 +177,4 @@ A comprehensive analytics platform that automatically pipes your indexed data fr :::tip For deployment instructions and limits, see our [Deployment Guide](./hosted-service-deployment.md). For pricing and feature availability by plan, see our [Billing & Pricing page](./hosted-service-billing.mdx). -::: - +::: \ No newline at end of file