---
title: "Deploy Typesense Astro"
description: "Instant search for Astro sites with the InstantSearch adapter"
category: "Analytics"
url: https://railway.com/deploy/deploy-typesense-for-astro-sites
---

# Deploy Typesense Astro

Instant search for Astro sites with the InstantSearch adapter

**[Deploy Typesense Astro on Railway](https://railway.com/template/deploy-typesense-for-astro-sites)**

Machine-readable deploy manifest (JSON, validated by TemplateCI): https://railway.com/deploy/deploy-typesense-for-astro-sites/manifest.json

- **Creator:** onepush
- **Category:** Analytics

## Template content

### typesense-railway

- **Source:** Shinyduo/typesense-railway
- **Public domain:** Yes

## Documentation

# Deploy and Host self hosted Typesense Astro (Instant Search for Astro Sites) on Railway

Search on an Astro site usually means a hosted crawler, a static index rebuilt each deploy, or your own engine.

## About Hosting Typesense Astro open-source software on Railway (self hosted Typesense template)

Typesense Astro is a wiring pattern, not a product. The browser queries that collection through typesense-instantsearch-adapter and InstantSearch.js.

This template runs Typesense 30 behind a Caddy proxy on PORT 8080, forwarding to 127.0.0.1:8118. The index lives on the Railway volume at TYPESENSE_DATA_DIR.

## Why Deploy Typesense Astro, the Algolia DocSearch alternative on Railway (Railway Free Trial)

Algolia DocSearch is hard to beat for free, hands-off docs search, since a crawler maintains the index for you. You pay Railway for compute and a volume rather than per-search fees.

Railway is a singular platform to deploy your infrastructure stack. Railway will host your infrastructure so you don't have to deal with configuration, while allowing you to vertically and horizontally scale it.

By deploying Typesense Astro on Railway, you are one step closer to supporting a complete full-stack application with minimal burden. Host your servers, databases, AI agents, and more on Railway.

### Railway vs Other Hosting Providers and VPS for Typesense Astro self hosting

Railway trades some low-level control for a faster path to a live search node, while a VPS gives you the box itself.

| Provider | What You Get with Railway | What You Get with the Other Provider |
| --- | --- | --- |
| DigitalOcean | A git-linked service with a persistent volume and public HTTPS, no Caddy or TLS upkeep. | Full root access and cheap droplets, but you own updates, TLS renewal, and the proxy. |
| AWS | One service built from the Shinyduo/typesense-railway repo, with Caddy already forwarding to Typesense. | Deep VPC and IAM control, useful at scale but extra setup for a single node. |
| Hetzner | Managed deploys and a volume without writing systemd units for Typesense. | Strong CPU and RAM per euro if you are comfortable running the stack yourself. |

Pick Railway for a quick live node, and a VPS when you already have ops habits.

## Common Use Cases for hosted Typesense Astro

- **Docs site search.** A Starlight or plain Astro docs site with a few hundred pages in content collections. Typesense Astro indexes titles, headings, and body text at build time, so readers get typo-tolerant results as they type.
- **Blog archive with facets.** Filter posts by tag, author, or year with InstantSearch widgets. The indexing script pushes frontmatter fields into the collection, so the facet sidebar comes from your content.
- **Static product catalog.** Prices and stock live in a content collection or JSON file. A CI step reindexes on each deploy, and the browser queries Typesense with a search-only key, so the store needs no backend.
- **Multi-language content.** Index each locale into its own collection and point InstantSearch at the matching index name. This keeps Spanish queries from matching English tokens.
- **Gated internal knowledge base.** Run indexing in CI and keep the admin key out of the bundle entirely.

## Dependencies for Typesense Astro Docker hosted on Railway

Typesense Astro is a wiring job rather than a single product. Nothing here is an official Astro integration, so you own the indexing script.

### Deployment Dependencies for Managed Typesense Astro Service (Search Engine for Astro Static Sites)

The Railway service builds from the Shinyduo/typesense-railway repo, running a Typesense 30 image behind a Caddy reverse proxy on PORT 8080 that forwards to 127.0.0.1:8118.

### Implementation Details for Typesense Astro (Using Typesense official docker image)

Replace TYPESENSE_API_KEY with a long random value right after the first deploy, since the admin key can create and drop collections. Keep it out of anything the browser sees.

## How does Typesense Astro compare against other search options for Astro sites platforms

Most Astro teams add search after the build, and the first question is whether to use a hosted crawler, a static index, or a server you run.

### Typesense Astro vs Algolia DocSearch (Algolia DocSearch Alternative)

- **Where Typesense Astro wins:** you own the index and schema, and it works for blogs and stores, not just docs.
- **Where DocSearch wins:** it is free for qualifying open-source docs and needs no server from you.

### Typesense Astro vs Pagefind (Pagefind Alternative)

- **Where Typesense Astro wins:** the index stays fresh between builds and handles larger catalogs without a big static file for visitors.
- **Where Pagefind wins:** nothing to deploy or pay for monthly, and it runs on any static host.

### Typesense Astro vs Meilisearch (Meilisearch Alternative)

- **Where Typesense Astro wins:** the adapter and InstantSearch.js path is documented for Typesense, and the search-only key pattern fits the browser cleanly.
- **Where Meilisearch wins:** its API is quick to start with and its community is large.

### Typesense Astro vs Fuse.js (Fuse.js Alternative)

- **Where Typesense Astro wins:** the index stays off the page and filters run on the server, so large content sets do not bloat the browser.
- **Where Fuse.js wins:** it is tiny and needs no server, which suits a short list of posts held in memory.

## How to use Typesense Astro (the OSS Search Engine for Astro Static Sites)?

Day one is about getting the keys right and proving the pipeline before you touch the UI.

1. Replace TYPESENSE_API_KEY with a long random value right after deploy, and keep the admin key in CI secrets, never in Astro source.
2. Confirm the public domain in TYPESENSE_PUBLIC_URL answers a health request, and that TYPESENSE_URL works from another Railway service, since both route through Caddy.
3. Create a collection whose field names match your indexer's output.
4. Write a small Node script, run at build time or in CI, that reads your Astro content collections and upserts them with the typesense JS client and the admin key. This is a pattern you write, not an official Astro integration.
5. Mint a search-only key through the /keys API, scoped to that collection, and expose it to the site as a PUBLIC_ env variable.
6. Install typesense-instantsearch-adapter with @babel/runtime and instantsearch.js, then pass the adapter's searchClient into instantsearch() with a matching indexName.

## How to self host Typesense Astro on other VPS Services (Typesense Astro self hosting guide)

Most people reach for a managed host first, but this pattern works on any Linux VPS with Docker and Node. This is a pattern you write yourself, not an official Astro integration.

### Clone the Repository

```bash
git clone https://github.com/Shinyduo/typesense-railway.git
cd typesense-railway
```

### Install Dependencies

```bash
npm install typesense @babel/runtime
npm install --save typesense-instantsearch-adapter instantsearch.js
```

### Configure Environment Variables

Keep the admin key on the build machine only. Expose a scoped search key to the browser under a PUBLIC_ name.

```bash
TYPESENSE_API_KEY=replace-with-long-random-value
PUBLIC_TYPESENSE_HOST=your-domain.up.railway.app
PUBLIC_TYPESENSE_SEARCH_KEY=your-scoped-search-key
```

CORS is off by default here, so add TYPESENSE_ENABLE_CORS=true and TYPESENSE_CORS_DOMAINS set to your site origin.

### Start the Typesense Astro Application

```bash
node scripts/index-typesense.mjs
npm run build
```

Railway handles the Typesense container, persistent volume, public HTTPS domain, and Caddy proxy, so you only manage your Astro site and its keys.

## Official Pricing of Typesense Astro (Typesense Astro pricing)

Typesense Astro has no license fee of its own. Pick a RAM tier that fits your content rather than the biggest one you can afford.

## Typesense Astro cloud vs self hosted comparison (Pricing, features, costs, and more)

Hosted search is the quickest way to get a box working on an Astro site, but the bill drifts as traffic and index size grow. Here is how self hosting Typesense on Railway compares.

### Monthly cost of self hosting Typesense Astro on Railway

On Railway you pay for the compute the Typesense service uses plus the volume that holds the index, so cost tracks the RAM your dataset needs rather than each search. Neither option charges per search.

### System Requirements for Hosting Typesense Astro on a VPS

Typesense keeps the whole index in memory, so size RAM to your dataset first and CPU second.

## Frequently Asked Questions (FAQs)

### Can I reuse one Typesense instance for several Astro sites?

Yes. Give each site its own collection, such as `blog_posts` or `docs_pages`, and scope search-only keys per site so one leaked key can't read another site's index.

### Why does my search box return nothing after deploy?

The indexing step probably never ran or failed quietly. The browser only sees what the last successful index run wrote.

### Can the browser use TYPESENSE_API_KEY directly?

No. Anything prefixed with PUBLIC_ ships to the client, so only the scoped search-only key belongs there. Keep the admin key in your CI or build environment, where Astro never bundles it.

### Why won't my .env values load in astro.config.mjs?

Astro doesn't load .env files inside configuration files, so import.meta.env is empty there. Use loadEnv from vite or process.env in the config, and reserve import.meta.env for component code.

### Will my filters break after the first page load?

They can, if you set filter_by in additionalQueryParameters, because InstantSearch overrides it later. Move those constraints into configure with facetFilters, numericFilters, or filters instead.

### How often should I rebuild the index?

Rebuild on every content deploy. Run the indexer as a CI step after the Astro build rather than on a timer, so the index always matches what's live.


## Similar templates

- [Plausible WordPress](https://railway.com/deploy/deploy-plausible-for-wordpress-sites) — Cookie-free WordPress stats from your own Plausible
- [Typesense Multilingual](https://railway.com/deploy/deploy-typesense-multilingual-search) — Locale-aware multilingual search with Typesense
- [Formbricks](https://railway.com/deploy/formbricks-surveys) — Surveys, NPS and in-app feedback on your own Postgres, Hub and Cube

Open this page in a browser: https://railway.com/deploy/deploy-typesense-for-astro-sites