📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!
TypeScript chartsclickhousedockergdprgoogle-analyticsmetricsmonitoringmysqlnestjsprivacyredisself-hostedselfhostedstatisticstailwindcssweb-analyticswebanalyticswebsite
Cover more settings
Blue Mouse677bf35100fc
diff --git a/docs/docs/accountsettings/teams-and-integrations.md b/docs/docs/accountsettings/teams-and-integrations.mdnew file mode 100644index 000000000..ad0a6971d--- /dev/null+++ b/docs/docs/accountsettings/teams-and-integrations.md@@ -0,0 +1,67 @@+---+title: Teams, API & Integrations+slug: /teams-api-integrations+---++import useBaseUrl from '@docusaurus/useBaseUrl';++Beyond basic profile settings, Swetrix offers powerful tools for collaboration, automation, and customisation.++## Organisations (Teams)++Organisations allow you to collaborate with your team members on multiple projects. Instead of sharing a password or inviting users to individual projects one by one, you can group projects under an Organisation and give your team access to all of them at once.++### Creating an Organisation++1. Navigate to the **[Organisations](/organisations)** page from the dashboard menu.+2. Click the **New organisation** button.+3. Enter a name for your organisation and click **Create**.++### Managing Members++To manage your team, go to the Organisations page and click the **Settings** (gear icon) button on the organisation card.++- **Invite Members**: Click the **Invite** button in the "People" section. Enter their email address and select a role.+ - **Admin**: Can manage organisation settings, invite/remove members, and manage projects.+ - **Viewer**: Can only view projects and analytics.+- **Change Roles**: Click on a member's role to upgrade or downgrade them.+- **Remove Members**: Click the role dropdown and select **Remove member**.++### Assigning Projects++You can assign a project to an organisation in the **Project Settings -> Access** tab. Once assigned, all members of the organisation will have access to the project according to their organisation role.++## API Keys++Swetrix provides a personal API key that allows you to interact with the Swetrix API programmatically.++1. Go to your **[Account Settings](https://swetrix.com/user-settings)**.+2. Open the **Account** tab.+3. Scroll down to the **API Key** section.+4. Click **Generate new API key**.++:::warning+Treat your API key like a password. Do not share it or commit it to public repositories.+:::++## Integrations++Swetrix can send you reports and alerts directly to your favourite communication tools.++1. Go to your **[Account Settings](https://swetrix.com/user-settings)**.+2. Open the **Communications** tab.+3. Scroll down to the **Integrations** section.++Supported integrations:++- **Telegram**: Receive alerts via the Swetrix Bot.+- **Slack**: Send notifications to a Slack channel via Webhook.+- **Discord**: Send notifications to a Discord channel via Webhook.++## Interface Settings++You can customise your dashboard experience in the **Interface** tab of your Account Settings.++- **Timezone**: Set your preferred reporting timezone.+- **Time Format**: Choose between 12-hour and 24-hour time formats.+- **Live Visitors in Title**: Enable this to show the current number of live visitors in your browser tab's title. This allows you to monitor traffic even when you are working in another tab.diff --git a/docs/docs/analytics-dashboard/live-visitors.md b/docs/docs/analytics-dashboard/live-visitors.mdnew file mode 100644index 000000000..732d7a172--- /dev/null+++ b/docs/docs/analytics-dashboard/live-visitors.md@@ -0,0 +1,29 @@+---+title: Live Visitors+slug: /analytics-dashboard/live-visitors+---++import useBaseUrl from '@docusaurus/useBaseUrl';++Swetrix provides real-time traffic monitoring, allowing you to see how many people are on your website right now.++## The Live Counter++In the top right corner of your dashboard (and on the main Traffic overview), you will see a **Live** indicator with a pulsing green dot.++<img alt="Live visitors counter" src={useBaseUrl('img/analytics-dashboard/live-visitors.png')} />++- **What it counts**: This number represents the count of unique visitors who have initiated a session or viewed a page within the last **5 minutes**.+- **Updates**: The counter updates in real-time as new visitors arrive or existing ones leave (time out).++## Live Visitors in Browser Title++You can configure Swetrix to display the live visitor count directly in your browser tab's title. This is useful for keeping an eye on traffic without having the dashboard tab active.++To enable this:++1. Go to your **[Account Settings](/user-settings)**.+2. Open the **Interface** tab.+3. Check the box for **Show live visitors in browser title**.++Once enabled, your browser tab will look something like this: `(12) Project Name | Swetrix`.diff --git a/docs/docs/sitesettings/project-configuration.md b/docs/docs/sitesettings/project-configuration.mdnew file mode 100644index 000000000..308a18cf2--- /dev/null+++ b/docs/docs/sitesettings/project-configuration.md@@ -0,0 +1,72 @@+---+title: Project Configuration & Security+slug: /project-configuration-and-security+---++Beyond the basics of tracking, Swetrix offers a robust set of configuration options to secure your data, manage access, and customise your project settings.++To access these settings, go to your **Project Settings** page. You can learn how to access it [here](/how-to-access-site-settings).++## General Settings++The **General** tab allows you to configure the basic identity of your project.++- **Project Name**: A friendly name for your project (e.g., "My Personal Blog").+- **Website URL**: The main URL of the website you are tracking.+- **Project ID**: A unique identifier for your project (read-only).+- **Sharable Link**: A direct link to your public or password-protected dashboard (read-only).++## Security (Shields)++The **Shields** tab provides powerful tools to protect your analytics from spam, bots, and unwanted traffic.++### Origins++By default, Swetrix accepts events from any domain. If you want to restrict tracking to specific domains only, you can add them here.++- Enter one domain per line.+- Requests from domains not listed here will be rejected.+- Leave empty to allow all domains (default).++### IP Blacklist++You can block traffic from specific IP addresses to exclude them from your analytics (e.g., your own office IP).++- Enter one IP address per line.+- Supports both IPv4 and IPv6.++### Country Blacklist++If you want to completely ignore traffic from specific countries, you can add them to the blacklist.++- Select countries from the dropdown menu.+- Traffic from these countries will not be recorded.++### Bot Protection Level++Swetrix has built-in bot detection. You can adjust the strictness of this protection:++- **Basic**: Standard protection against common bots and crawlers.+- **Strict**: More aggressive filtering. May result in fewer recorded visits but cleaner data.++## Access Control++The **Access** tab manages who can see your data and which team owns the project.++### Visibility Settings++- **Enabled**: Toggles data collection on or off. If disabled, no new events will be recorded.+- **Public Dashboard**: If enabled, anyone with the link can view your analytics dashboard. No login required.+- **Password Protected**: If enabled, visitors must enter a password to view the dashboard. Useful for sharing stats with clients without requiring them to create an account.++### Organisation Assignment++If you are a member of an Organisation (Team), you can transfer the project to that organisation here. This allows all members of the organisation to access the project according to their roles.++## Danger Zone++The **Danger Zone** contains destructive actions. Proceed with caution.++- **Transfer Project**: Move ownership of the project to another user. See [Transfer Ownership](/how-to-transfer-ownership-of-your-website) for details.+- **Reset Data**: Clear all or some of your analytics data. See [Reset Site Data](/reset-sites-data) for details.+- **Delete Project**: Permanently delete the project and all associated data. **This action cannot be undone.**diff --git a/docs/sidebars.js b/docs/sidebars.jsindex 70b6805af..ad6b3ea63 100644--- a/docs/sidebars.js+++ b/docs/sidebars.js@@ -38,9 +38,11 @@ module.exports = {'analytics-dashboard/captcha','analytics-dashboard/revenue-tracking','analytics-dashboard/segments',+ 'analytics-dashboard/live-visitors',],'Site settings': ['sitesettings/how-to-access-site-settings',+ 'sitesettings/project-configuration','sitesettings/how-to-invite-users-to-your-website','sitesettings/transfer-ownership','sitesettings/embed-your-analytics-dashboard-into-your-website',@@ -50,6 +52,7 @@ module.exports = {],'Account settings': ['accountsettings/two-factor-authentication',+ 'accountsettings/teams-api-integrations','accountsettings/change-email','accountsettings/change-password','accountsettings/delete-account',diff --git a/docs/static/img/analytics-dashboard/live-visitors.png b/docs/static/img/analytics-dashboard/live-visitors.pngnew file mode 100644index 000000000..55e45f666Binary files /dev/null and b/docs/static/img/analytics-dashboard/live-visitors.png differ