๐ธ Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.
Update README.md
Bill Yang9fb9b05d3609
diff --git a/README.md b/README.mdindex e7fe32ac8..08efee4e7 100644--- a/README.md+++ b/README.md@@ -1,129 +1,69 @@-# ๐ธ Frogstats - Self-Hosted Google Analytics Alternative-Frogstats is an open-source, privacy-focused alternative to Google Analytics. Easily self-host it on your own VPS server and take full control of your analytics data.-## ๐ Quick Start Guide+<p align="center">+ <img src="https://github.com/user-attachments/assets/dba06664-c57d-4e61-921c-59033166369b">+ <h1 align="center">+ Rybbit Analytics+ </h1>+ <p align="center">+<p align="center">Open Source Web & Product Analytics</p>-### 1. Set Up Your VPS Server+<p align="center">+<a href="https://demo.rybbit.io/1" target="_blank">+ <img src="https://img.shields.io/static/v1?label=demo&message=view&color=green" alt="Demo">+</a>+<a href="https://rybbit.io/docs" target="_blank">+ <img src="https://img.shields.io/badge/docs-view-green" alt="Documentation">+</a>+<a href="https://discord.gg/DEhGb4hYBj" target="_blank">+ <img src="https://img.shields.io/badge/discord-join-green.svg?logo=discord&logoColor=white" alt="Discord">+</a>+<a href="https://github.com/goldflag/rybbit?tab=AGPL-3.0-1-ov-file" target="_blank">+ <img src="https://img.shields.io/static/v1?label=license&message=AGPL-3&color=green" alt="License">+</a>-Choose a reliable VPS provider (e.g., DigitalOcean, Linode, AWS, Hetzner) and create a new Ubuntu server instance.+</p>-### 2. Clone the Repository+</p>-SSH into your server and clone the repository:+Rybbit is the modern open source and privacy friendly alternative to Google Analytics. It takes only a couple minutes to setup and is super intuitive to use.-```bash-git clone [your-repo-url] frogstats-cd frogstats-```+View a <a href="https://demo.rybbit.io/1">live demo</a> of Rybbit running on a real-life production site with over a million visits a month.-### 3. Configure Environment Variables+<h2>Getting Started</h2>+You can either sign up for our hosted service at https://rybbit.io or <a href="https://rybbit.io/docs/self-host">self host</a> Rybbit on your own VPS.-Create a `.env` file in the root directory based on `.env.example`:+Learn more about Rybbit by reading our <a href="https://rybbit.io/docs">documentation</a> .-```bash-cp .env.example .env-```+<h2>Key Features</h2>-Edit `.env` and set the following variables:+- All key web analytics metrics including sessions, unique users, pageviews, bounce rate, session duration+- Customizable retention, user journeys, and funnels dashboards+- Advanced filtering across 15+ dimensions+- Custom events+- Live sessions dashboard+- 3 level location tracking (country -> region -> city) + advanced map visualizations+- Real time dashboard+- Support for organizations and unlimited number of sites-- `BASE_URL`: Your domain URL (e.g., `https://analytics.frogstats.com`)-- `BETTER_AUTH_SECRET`: Generate a secure secret using OpenSSL:+<h2>Dashboard Preview</h2>-```bash-openssl rand -hex 32-```+<h3>Main</h3>-Copy the generated secret and paste it into your `.env` file.+-Your `.env` file should look like this:+<h3>Realtime</h3>-```env-BASE_URL=https://analytics.frogstats.com-BETTER_AUTH_SECRET=your_generated_secret_here-```+-### 4. Deploy with Docker Compose+<h3>Sessions</h3>-Ensure Docker and Docker Compose are installed on your server. Then, run:+-```bash-docker compose up --build -d-```+<h3>Journeys</h3>-This will build and start all necessary services (ClickHouse, PostgreSQL, backend, and frontend).+-### 5. Set Up Nginx and SSL with Certbot+<h3>Funnels</h3>-Install Nginx and Certbot:--```bash-sudo apt update-sudo apt install nginx certbot python3-certbot-nginx-```--Create a new Nginx configuration file:--```bash-sudo nano /etc/nginx/sites-available/frogstats-```--Paste the following configuration:--```nginx-server {- listen 80;- server_name analytics.frogstats.com;-- location /api/ {- proxy_pass http://localhost:3001/;- proxy_set_header Host $host;- proxy_set_header X-Real-IP $remote_addr;- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;- proxy_set_header X-Forwarded-Proto $scheme;- }-- location / {- proxy_pass http://localhost:3002;- proxy_set_header X-Real-IP $remote_addr;- proxy_set_header Host $host;- proxy_set_header X-Forwarded-Proto $scheme;- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;- }-}-```--Enable the site and reload Nginx:--```bash-sudo ln -s /etc/nginx/sites-available/frogstats /etc/nginx/sites-enabled/-sudo nginx -t-sudo systemctl reload nginx-```--Obtain SSL certificates with Certbot:--```bash-sudo certbot --nginx -d analytics.frogstats.com-```--Follow the prompts to complete SSL setup.--### 6. Access Your FrogStats Dashboard--Navigate to your domain:--```-https://analytics.frogstats.com-```--Log in with the default admin credentials:--- **Username:** `admin`-- **Password:** `admin123`--**โ ๏ธ Important:** Change the default password immediately after logging in.--## ๐ Congratulations!--Your self-hosted FrogStats instance is now up and running. Enjoy privacy-focused analytics on your own infrastructure!+