๐ธ Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.
Nginx (#36)
Bill Yange921f6ebbf8f
diff --git a/.env.example b/.env.examplenew file mode 100644index 000000000..94da3bc48--- /dev/null+++ b/.env.example@@ -0,0 +1,2 @@+BASE_URL=[your-base-url]+BETTER_AUTH_SECRET=[your-better-auth-secret]\ No newline at end of filediff --git a/README.md b/README.mdnew file mode 100644index 000000000..e7fe32ac8--- /dev/null+++ b/README.md@@ -0,0 +1,129 @@+# ๐ธ 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++### 1. Set Up Your VPS Server++Choose a reliable VPS provider (e.g., DigitalOcean, Linode, AWS, Hetzner) and create a new Ubuntu server instance.++### 2. Clone the Repository++SSH into your server and clone the repository:++```bash+git clone [your-repo-url] frogstats+cd frogstats+```++### 3. Configure Environment Variables++Create a `.env` file in the root directory based on `.env.example`:++```bash+cp .env.example .env+```++Edit `.env` and set the following variables:++- `BASE_URL`: Your domain URL (e.g., `https://analytics.frogstats.com`)+- `BETTER_AUTH_SECRET`: Generate a secure secret using OpenSSL:++```bash+openssl rand -hex 32+```++Copy the generated secret and paste it into your `.env` file.++Your `.env` file should look like this:++```env+BASE_URL=https://analytics.frogstats.com+BETTER_AUTH_SECRET=your_generated_secret_here+```++### 4. Deploy with Docker Compose++Ensure Docker and Docker Compose are installed on your server. Then, run:++```bash+docker compose up --build -d+```++This will build and start all necessary services (ClickHouse, PostgreSQL, backend, and frontend).++### 5. Set Up Nginx and SSL with Certbot++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!diff --git a/docker-compose.yml b/docker-compose.ymlindex 0a1d23163..fa95392bc 100644--- a/docker-compose.yml+++ b/docker-compose.yml@@ -11,7 +11,6 @@ services:- clickhouse-data:/var/lib/clickhouseenvironment:- CLICKHOUSE_DB=analytics- - ALLOW_EMPTY_PASSWORD=yespostgres:image: postgres:latest