Skip to content

One-click template for self-hosting Plausible on Railway!

License

Notifications You must be signed in to change notification settings

railwayapp-templates/plausible

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 

Repository files navigation

Railway: Plausible Analytics Template

Deploy on Railway

What is this template?

Plausible Analytics is a simple, open-source, lightweight (< 1 KB) and privacy-friendly alternative to Google Analytics. Plausible is trusted by 10,000+ paying subscribers to deliver their website and business insights.

This template makes it trivial to deploy an instance of Plausible Analytics with all of it's required services on Railway.

See the Plausible Analytics docsite for a more in-depth explanation of its feature set.

Quick start guide

  1. Click the "Deploy on Railway" button above, or click here
  2. Follow the setup steps in Railway
  3. Monitor your services as they come up; wait until they're all up.
  4. Setup your websites with Plausible Analytics.
    1. Navigate to the domain for your Plausible Analytics service.
    2. Follow the prompts to create an account on the service
    3. Follow the prompts to set up tracking on your website.
    4. For more information on how to use Plausible, check their site.

Optional variables

There are several "optional" environment variables for this template. This variables aren't needed to get Plausible Analytics running on Railway, but they add some niceties.

  • SMTP Mailer Setup: these optional values enable your Plausible Analytics instance to send you emails. These can be weekly updates, or timely notifications if your site is getting a spike in traffic. You can read more about these settings on Plausible Analytics docsite here.
    • MAILER_EMAIL: This is the email that all outgoing emails will come from (i.e. analytics@yoursite.com)
    • MAILER_NAME: This is the name that all outgoing emails will come from (i.e. Plausible Analytics for YourSite.com)
    • SMTP_HOST_ADDR: The host address of the SMTP server you'd like Plausible Analytics to use to send emails (i.e. send.mailserver.com)
    • SMTP_HOST_PORT: The port you'd like to use with SMTP_HOST_ADDR to send emails (i.e. 25, 225)
    • SMTP_USER_NAME: If your SMTP server of choice uses authentication, put the username here (i.e. smtp_user, admin@send.mailserver.com)
    • SMTP_USER_PWD: If your SMTP server of choice uses authentication, put the password here
    • SMTP_HOST_SSL_ENABLED: If your SMTP server support TLS encrypted traffic, enable it here (i.e true, false)

Project structure & services

This template is made up of three "services":

Additional resources

If you'd like to customize your instance of Plausible Analytics, I would recommend reviewing the documentation for both ClickHouse DB, and Plausible Analytics. Here are some links to get you started:

Feedback

If you experience any issues or have any feedback at all, you can create a GitHub issue here

Known issues

None right now!

About

One-click template for self-hosting Plausible on Railway!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published