Skip to content

Update docs for new hosted service cache solution & Deployment tags #770

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MJYoung114 merged 5 commits into from
Jan 5, 2026
Merged

Update docs for new hosted service cache solution & Deployment tags #770

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d7489dd
Update docs for new hosted service cache solution
Piroddi Dec 30, 2025
87ed795
Update features
Piroddi Dec 30, 2025
11ee6a8
Add Tags feature
Piroddi Jan 5, 2026
7f18b58
updates
Piroddi Jan 5, 2026
e13888f
Update cache plan
Piroddi Jan 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions docs/HyperIndex/Advanced/effect-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
66 changes: 64 additions & 2 deletions docs/HyperIndex/Hosted_Service/hosted-service-features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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*
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix markdown linting violations: use proper heading structure for availability notices.

The static analysis tool flagged MD036 violations on lines 45, 58, and 90. Emphasis (single asterisks) should not be used as a heading-like statement. Consider formatting these as proper headings (e.g., ### Availability: Paid plans only) or restructuring them as info boxes/blockquotes for better semantics and consistency with the existing :::info and :::tip blocks used elsewhere.

🔎 Suggested formatting options

Option 1: Use proper heading notation:

-*Availability: Paid plans only*
+### Availability: Paid plans only

Option 2: Use an info block (more consistent with existing style):

-*Availability: Paid plans only*
+:::info Availability
+Paid plans only
+:::

Also applies to: 58-58, 90-90

🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

45-45: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

🤖 Prompt for AI Agents 
In @docs/HyperIndex/Hosted_Service/hosted-service-features.md around line 45,
Replace the emphasized, heading-like lines that use single asterisks (the three
occurrences reading "Availability: Paid plans only") with proper semantic
markup: either convert them to a heading (for example "### Availability: Paid
plans only") or wrap them in an info/blockquote consistent with existing blocks
(e.g., use an :::info or :::tip block) so they no longer trigger MD036; update
the three occurrences that match the exact phrase to use the chosen structure
and ensure surrounding spacing/newlines follow the other examples in the
document.


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:**
Expand All @@ -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
Expand Down Expand Up @@ -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).
:::

:::