Skip to content

Latest commit

 

History

History
81 lines (59 loc) · 3.03 KB

railway.mdx

File metadata and controls

81 lines (59 loc) · 3.03 KB
title description
Railway
Guide to deploy LogChimp on Railway

import { Cards, Card } from 'fumadocs-ui/components/card' import { PlaneTakeoff, MapIcon, BracesIcon } from 'lucide-react';

There are many ways to install LogChimp. With Railway, you can get started with just a few easy steps. Click the button1, and hit deploy. It's that simple.

You will need to set-up SMTP configuration to let your users get emails to reset password, account verification, notifications and more.

<<<<<<< HEAD:content/self-hosting/deployments/railway.mdx Deploy on Railway

⚠️ **Breaking Change (PostgreSQL 12 → 18)** LogChimp now uses PostgreSQL 18 which introduces an incompatible data directory structure. Existing Docker volumes or databases from PostgreSQL 12 **will not work directly** with this version. Please review the [Breaking Change – PostgreSQL 12 → 18](/docs/miscellaneous/breaking-changes-pg18) page before upgrading or deploying.

Deploy on Railway

a15bdd0 (docs: add PostgreSQL 12→18 breaking change notice and link from Docker page):content/docs/install/railway.mdx

All the environment variables are pre-configured for you. You can learn more about them here.

And there you go... 🚄, you should be able to access LogChimp at http://localhost:3000.

Your LogChimp site is ready to accept your customers' feedback with ease. 🎉

LogChimp live site preview

Behind the scenes

This template will auto-provision the following services for you:

  1. PostgreSQL database
  2. LogChimp API service
  3. LogChimp Theme service

You can always customize the secret keys and other environment variables.

Railway provides an easy way to generate a 32-character secret key by pressing Command + K (on MacOS) or Ctrl + K (on Windows). Of course, you can provide your own secret key as well.

LogChimp Railway template

Next Steps

Congrats on successfully installing LogChimp.

Phew! That was a lot of work! Let's move to next step.

} href="/platform/setup" title="Onboarding setup" > Setting up your LogChimp site, by creating an owner account. 
<Card
	icon={<MapIcon />}
	href="/guide"
	title="Learn LogChimp"
>
	Learn how to use LogChimp.
</Card>

<Card icon={<BracesIcon />} title="API Reference" href="/api-reference">
	Connect your application with LogChimp.
</Card>

Footnotes

  1. The above link contains a referral code which gives referral credits to @mittalyashu. ↩