Railway-Ready Typesense

A modern Typesense deployment template built specifically for Railway, using updated images and safe, production-ready defaults.

---

🚀 Deploy on Railway

---

✨ Features

• ✅ Updated Typesense image (v30-ready)
• ✅ Railway-friendly startup scripts
• ✅ Persistent data storage (no accidental data loss)
• ✅ Clean default configuration
• ✅ Easy upgrade path to future Typesense releases

---

🧱 What’s Included

• Typesense (latest supported image)
• Caddy (optional reverse proxy)
• Proper volume mounting for /data
• Startup scripts tested on Railway

---

⚙️ Configuration

After deployment, Railway will automatically generate the required environment variables.

Important variables:

• TYPESENSE_API_KEY – Admin API key
• TYPESENSE_DATA_DIR – Persistent data directory

You can manage these in Railway → Variables at any time.

---

🔒 Production Notes

• This template is production-ready by default
• Designed to avoid common Railway container issues
• Uses stable configuration patterns recommended by Typesense

If a release-candidate image is used, it can be upgraded to a stable release without changing the template name.

---

🛠 Maintenance

• Update Typesense versions via the Dockerfile
• No breaking changes required for minor upgrades
• Template naming remains stable over time

---

📄 License

Typesense is licensed under the Apache License 2.0.

This template is community-maintained.