📈 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
(feature) Website settings docs (#14)
Andrii Romasiun99b8d88029d9
diff --git a/docs/sitesettings/embed-your-analytics-dashboard-into-your-website.md b/docs/sitesettings/embed-your-analytics-dashboard-into-your-website.mdnew file mode 100644index 000000000..710c6c719--- /dev/null+++ b/docs/sitesettings/embed-your-analytics-dashboard-into-your-website.md@@ -0,0 +1,31 @@+---+title: Embed your analytics dashboard into your website+slug: /how-to-embed+---++import useBaseUrl from '@docusaurus/useBaseUrl';++You can embed your Swetrix analytics dashboard into any other website using an iframe. This is useful if you're building a custom admin panel, a dashboard for your customers or just want to show your stats to your visitors.++### 1. Get your sharable link+First, you need to find the sharable link to your dashboard. You can get it in your [site settings](/how-to-access-site-settings) page. For people to be able to access your dashboard, you need to make it public or password-protected.++### 2. Write the HTML embed code+Now you need to write the HTML code for the iframe. You can do this in any text editor, or directly in your website's code. Here's an example of how it should look like:++```html+<iframe src="https://swetrix.com/projects/YOUR_PROJECT_ID?tab=traffic&theme=dark" width="1200" height="700" title="Test"></iframe>+```++### 3. Paste the code into your website+Now you can paste the code into your website's HTML. You can put it anywhere you want, but it's usually best to put it in a dedicated page or section.++### Embed options and customisation+You can customise the embed code to fit your needs. For example, you can change the width and height of the iframe or change the theme to match your website's design.+Here is a list of all available options:++ - `theme`: `light` or `dark` - the theme of the dashboard.+ - `tab`: `traffic`, `performance`, `sessions`, `funnels`, `alerts` - the default tab to show. By default, the traffic tab is shown.+ - `tabs`: `traffic`, `performance`, `sessions`, `funnels`, `alerts` - a comma-separated list of tabs that should be accessible in dashboard. Example: `tabs=traffic,performance,sessions` will only show the traffic, performance and sessions tabs. By default, all tabs are shown.+ - `embedded` - if set to `true`, header, footer and any marketing CTAs will be hidden.+ - `password` - if your dashboard is password-protected, you can pass the password as a query parameter. Example: `password=yourpassword`, this way the dashboard will be unlocked without the need to enter the password.\ No newline at end of filediff --git a/docs/sitesettings/get-analytics-email-reports.md b/docs/sitesettings/get-analytics-email-reports.mdnew file mode 100644index 000000000..172a23d5e--- /dev/null+++ b/docs/sitesettings/get-analytics-email-reports.md@@ -0,0 +1,22 @@+---+title: Get analytics email reports+slug: /get-analytics-email-reports+---++import useBaseUrl from '@docusaurus/useBaseUrl';++You can send regular email reports to your team or clients to keep them updated on your website's traffic. You can set up the frequency of the reports and the recipients.++### How to set up email reports+1. Go to your [site's settings](/how-to-access-site-settings).+2. Navigate to the "Email reports" section.+3. Click on the "Add a recipient" button.+4. Enter the email address of the recipient. They don't necessarily need to have a Swetrix account.+5. Select the frequency of the reports: quarterly, monthly, weekly, or daily.++<img alt="Settings from the Dashboard page" src={useBaseUrl('img/sitesettings/add_email_subscribers.png')} />++### How to remove users from the email reports+Under the "Email reports" section you can see the list of recipients. If a recipient did not accept the invitation, you can remove them from the list by clicking on the "Remove" button.++If they accepted the invitation, you can remove them from the list by clicking on the reports frequency button and in the dropdown menu click on "Remove member".diff --git a/docs/sitesettings/how-to-access-site-settings.md b/docs/sitesettings/how-to-access-site-settings.mdnew file mode 100644index 000000000..190e8fb50--- /dev/null+++ b/docs/sitesettings/how-to-access-site-settings.md@@ -0,0 +1,18 @@+---+title: How to access site settings+slug: /how-to-access-site-settings+---++import useBaseUrl from '@docusaurus/useBaseUrl';++You can access your site settings in two ways:++### From the dashboard+Click on the 'Settings' icon in the top right corner of site on the dashboard page.++<img alt="Settings from the Dashboard page" src={useBaseUrl('img/sitesettings/settings_from_dashboard.png')} />++### From your site's analytics page+Click on the 'Settings' tab in the top navigation bar of your site's analytics page.++<img alt="Settings from the sites analytics page" src={useBaseUrl('img/sitesettings/settings_from_project.png')} />diff --git a/docs/sitesettings/how-to-invite-users-to-your-website.md b/docs/sitesettings/how-to-invite-users-to-your-website.mdnew file mode 100644index 000000000..1229b0b6d--- /dev/null+++ b/docs/sitesettings/how-to-invite-users-to-your-website.md@@ -0,0 +1,51 @@+---+title: How to invite users to your website+slug: /how-to-invite-users-to-your-website+---++import useBaseUrl from '@docusaurus/useBaseUrl';++Swetrix allows you to invite other people to your website. This is useful if you want to give access to your team, clients or other people without sharing your login credentials.++You can invite any person to your website, but they need to have a Swetrix account. At the same time, they don't necessarily need to have a paid subscription to be invited to and access your website.++:::tip+If you want to share your dashboard without requiring the other person to have a Swetrix account, you can password-protect your dashboard and share the password with them.+:::++## How to invite users to your website+1. Go to your [site settings](/how-to-access-site-settings) page.+2. Scroll down to the "People" section and click the "Invite a user" button.+3. Enter the email address of the person you want to invite. Please note that the person needs to have a Swetrix account with the same email address.+4. Select a role for the person you're inviting. You can choose between "Admin" and "Viewer" roles.+ - **Admin**: Admins have full access to your website. They can view and edit all settings, add and remove other users, and view all analytics data.+ - **Viewer**: Viewers can only view your website's analytics data. They can't edit any settings or invite other users.+5. Click the "Invite" button to send the invitation. The person will receive an email with a link to accept the invitation. Once they accept it, they will be able to access your website. We'll also display a notification in their Dashboard page to let them know they've been invited to your website and they can accept the invitation from there as well.++<img alt="Invite user" src={useBaseUrl('img/sitesettings/invite_user.png')} />++### Who is responsible for billing?+The owner of the website is responsible for billing and needs to have a paid subscription. If you invite someone to your website, they can access it without having a paid subscription.++However, if you transfer ownership of your website to someone else, they will become responsible for billing.++## How to modify user permissions+You can modify the permissions of any user at any time. To do this, go to your [site settings](/how-to-access-site-settings) page and scroll down to the "People" section. Here you can see a list of all users who have access to your website.++To modify a user's permissions, click on their role. You can then change their role between "Admin" and "Viewer". Once you change the role, the user will have the new permissions immediately.++<img alt="Update user's role" src={useBaseUrl('img/sitesettings/change_role.png')} />++## How to remove a user from your website+To remove a user from your website, go to your site settings, scroll down to the "People" section, click on the user you want to remove, and then click the "Remove member" button.++Once you confirm the action, the user will no longer have access to your website.++## How to transfer ownership of your website+To transfer ownership, navigate to your site settings, click on the "Transfer project" button (it's located in general settings of the website) and enter the email address of the person you want to transfer ownership to.++You will receive an email to confirm the transfer. Once you confirm it, the other person will become the owner of the website and will be responsible for billing.++:::note+You can only transfer ownership to someone who is registered on Swetrix with the same email address you're transferring the website to.+:::diff --git a/docs/sitesettings/reset-sites-data.md b/docs/sitesettings/reset-sites-data.mdnew file mode 100644index 000000000..7e3900954--- /dev/null+++ b/docs/sitesettings/reset-sites-data.md@@ -0,0 +1,21 @@+---+title: Reset your site's data+slug: /reset-sites-data+---++import useBaseUrl from '@docusaurus/useBaseUrl';++On your [site settings](/how-to-access-site-settings) page, you can reset your site's data. This will delete all analytics data, but keep your settings and site ID intact.++:::caution+This action is irreversible. Once you reset your site's data, all analytics data will be permanently deleted and cannot be recovered.+:::++To reset your site's data, click on the "Reset project" button:++<img alt="Invite user" src={useBaseUrl('img/sitesettings/reset_settings.png')} />++In the confirmation dialog, you will find 3 options:+1. **Reset all**: This will permanently delete all analytics data for all time, but the site ID and it's settings will remain intact.+2. **Reset partially**: Partial reset allows you to delete data for a specific time range.+3. **Reset via filters**: This allows you to delete data based on specific filters (e.g. delete all data for a specific referrer, country, etc.).diff --git a/sidebars.js b/sidebars.jsindex 6c5181444..53b678082 100644--- a/sidebars.js+++ b/sidebars.js@@ -12,6 +12,13 @@ module.exports = {},'troubleshooting',],+ 'Site settings': [+ 'sitesettings/how-to-access-site-settings',+ 'sitesettings/how-to-invite-users-to-your-website',+ 'sitesettings/embed-your-analytics-dashboard-into-your-website',+ 'sitesettings/get-analytics-email-reports',+ 'sitesettings/reset-sites-data',+ ],'Affiliate program': ['affiliate/about','affiliate/terms',diff --git a/static/img/sitesettings/add_email_subscribers.png b/static/img/sitesettings/add_email_subscribers.pngnew file mode 100644index 000000000..1d95fce87Binary files /dev/null and b/static/img/sitesettings/add_email_subscribers.png differdiff --git a/static/img/sitesettings/change_role.png b/static/img/sitesettings/change_role.pngnew file mode 100644index 000000000..8da18b513Binary files /dev/null and b/static/img/sitesettings/change_role.png differdiff --git a/static/img/sitesettings/invite_user.png b/static/img/sitesettings/invite_user.pngnew file mode 100644index 000000000..0b2477fcbBinary files /dev/null and b/static/img/sitesettings/invite_user.png differdiff --git a/static/img/sitesettings/reset_settings.png b/static/img/sitesettings/reset_settings.pngnew file mode 100644index 000000000..b48371ef7Binary files /dev/null and b/static/img/sitesettings/reset_settings.png differdiff --git a/static/img/sitesettings/settings_from_dashboard.png b/static/img/sitesettings/settings_from_dashboard.pngnew file mode 100644index 000000000..29a557f05Binary files /dev/null and b/static/img/sitesettings/settings_from_dashboard.png differdiff --git a/static/img/sitesettings/settings_from_project.png b/static/img/sitesettings/settings_from_project.pngnew file mode 100644index 000000000..0d78d9ea0Binary files /dev/null and b/static/img/sitesettings/settings_from_project.png differ