Giter Club home page Giter Club logo

clickhouse's Introduction

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. [email protected])
    • 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, [email protected])
    • 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!

clickhouse's People

Contributors

railway-bot avatar

Watchers

JiongXin avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.