! Getting Started
This guide walks you through the initial setup to use PrivateStater.
Step 1: Create an Account
- Go to PrivateStater Dashboard
- Sign up if you don't have an account
Step 2: Create a Project
A project is a unit for managing multiple websites as a group. You can invite colleagues, employees, and teams.
- Click the New Project button in the dashboard
- Enter a Project ID
Project ID Rules
- Only lowercase letters, numbers, and hyphens (
-) are allowed - Example:
my-company,personal-blog,startup2024
Step 3: Add a Website
- Click the Add Website button inside the project
- Enter the following information:
| Field | Description | Example |
|---|---|---|
| Website ID | Unique identifier (must be globally unique) | my-blog |
| Host | Actual domain (excluding protocol) | example.com or sub.example.com |
Website ID Rules
- Only lowercase letters, numbers, and hyphens are allowed
- IDs already registered by other users cannot be used
- Cannot be changed once created (must delete and recreate)
Step 4: Install Script
Add the following code to the <head> section of your website:
<script> window.PrivateStaterConfig = { prstSite: "YOUR_SITE_ID" };</script>
<script src="https://privatestater.com/privatestater.js"></script>
Replace YOUR_SITE_ID with the Website ID created in Step 3.
Installation Example
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>My Website</title>
<!-- PrivateStater Getter -->
<script> window.PrivateStaterConfig = { prstSite: "my-blog" };</script>
<script src="https://privatestater.com/privatestater.js"></script>
</head>
<body>
<!-- Website Content -->
</body>
</html>
Step 5: Enable Features
After installing the script, enable the desired features in the dashboard:
| Feature | Default State | Activation Location |
|---|---|---|
| Analytics | Always Active | - |
| Captcha | Inactive | Captcha > Settings |
| Feedback | Inactive | Feedback > Settings |
- Analytics works automatically immediately after script installation
- Captcha and Feedback must be explicitly enabled in the dashboard
Step 6: Verify Installation
- Visit your website
- Check if real-time statistics are displayed in the dashboard
- Visitor data should appear within about 1 minute
Testing in Local Development Environment
To test on localhost, you must enable Allow Localhost in the settings for each feature.
Dashboard > Website > [Feature] > Settings > Allow Localhost: Enable
Member Management
You can invite team members to the project to manage it together.
Roles
| Role | Permissions |
|---|---|
| Owner | All permissions (including project deletion, member management) |
| Member | View data and change settings |
Inviting Members
- Dashboard > Project > Member Management
- Enter the User Key of the user to invite
- Send invitation (expires in 7 days)
Notes
- Owners cannot leave the project (can only delete it)
- Members cannot invite or remove other members
Next Steps
Now that you have acquired the basic knowledge, refer to the following documents to learn more about the features:
- Analytics Integration - Analytics feature details
- Captcha Integration - Captcha feature details
- Feedback Integration - Feedback feature details