# Introduction ![](/files/EnxjPqmY8Ej2Y1vXVnL3) {% hint style="info" %} **UXWizz has been recently rebranded from "userTrack".** **You might still find references to the old "userTrack" name in this documantation or in the product itself.** {% endhint %} ## What is UXWizz? UXWizz is a self-hosted website analytics platform. \ \ Thousands of website owners and web agencies use UXWizz to privately get insights into their traffic and improve their websites. \ \ View stats, heatmaps and session recordings, track events, run A/B tests and increase conversion rates without sending your data to third-party companies. ## Quick links * [Requirements](/installation/requirements) * [Installation](/installation/installation) * [Changelog](/about/changelog#changelog) * [Support](/guides/support) ## Get If you have not yet purchased UXWizz, you can view the [prices here](https://www.usertrack.net/pricing). \ If you have already purchased a UXWizz license: **THANK YOU**, every purchase increases the [updates frequency](/about/changelog), documentation and [support](/guides/support). ## Install To get started with UXWizz you first have to install it. \ After reading the [requirements](/installation/requirements) you can go directly to the [installation section](/installation/installation). ## Use Have you already installed UXWizz and have recorded data but you are not sure how to interpret it? Read the [usage tips](/guides/usage-tips) to see the recommended ways to take advantage of the recorded data. # Requirements [Installing UXWizz](/installation/installation) on a server should take under 5 minutes if you know how to: * **Upload files to your server** * **Create a database** * **Include a JavaScript snippet on your website** If you don't know how to do any of those steps, don't worry as they are explained in the installation guide. You can also always contact [support](/guides/support) for help. ## Server requirements {% hint style="info" %} **UXWizz is self-hosted.** You must use your own server/hosting (either shared, VPS or dedicated). {% endhint %} UXWizz runs on the LAMP stack (Linux/Apache/MySQL/PHP): * **PHP ≥ 8.0** (pdo\_mysql, zip extensions enabled) * **MySQL ≥ 8.0** or **MariaDB ≥ 10.7** * Web server (**Apache**, LiteSpeed, NGINX, etc.) * Access to create a database and upload files to the server. You can use the following guidelines to decide on your server configuration depending on the amount of traffic that your website gets: {% content-ref url="/pages/-MPt3uLnHa\_CZx4PLHsi" %} [Server specs (CPU, RAM)](/installation/requirements/server-specs-cpu-ram) {% endcontent-ref %} ## Website requirements * UXWizz's **ust.min.js** JavaScript tracker must be included on your website(s). * You need access to include a JavaScript file or to edit files on your website. # Limitations {% hint style="info" %} **Before purchasing you should know what are the most important limitations of UXWizz**\ While UXWizz is regularly updated, some of those limitations are browser-imposed and are not likely to be solved in the near future. {% endhint %} **Recording/Session Playback limitations** {% hint style="info" %} **🎉 NEW -** A secondary session recording system to address this issue has already been implemented since version 4.0.0.\ [Read more about the session recording systems](/api/session-recording). {% endhint %} The default playback is recommended for landing pages or pages that don't contain a lot of dynamic content. The [**default recording system**](https://docs.uxwizz.com/installation/requirements/pages/-MlFhp-p5VUf_FwF-x-1#a.-default-page-recording) is very well optimized, but has some limitations: * **Interactions over or inside iframes are not recorded** *(browsers do not propagate events from iframes to the parent document)* * **Recorded pages content, versions or updates are not stored.** This happens because the default tracking system only stores the URL of the recorded pages, this means that the page content is only loaded when the record is being played and it is always the latest/current version of the page at that URL. * As a consequences of the previous point: if a user has to **log-in** in order to **access** a specific area of the website you will **not** be able to view recordings on that area as long *as you are not logged in as well*. Also, if you are logged in as a different user you may see their actions done on your user panel. * Web components and shadow-DOM or frameworks that use those technologies (like Polymer) might not be properly recorded. This happens because encapsulated elements do not correctly respond to external artificially triggered events (eg: click). * As all actions done by the user are actually replayed on your site, you should add the class ***UST\_noClick*** on the HTML elements that lead to a final action (eg. finalizing an order), so that the click will be shown but the action will not be executed. All limitations, apart from the iframe-recording are solved when using the [full recording system](https://docs.uxwizz.com/installation/requirements/pages/-MlFhp-p5VUf_FwF-x-1#b.-full-page-recording). **Heatmap limitations** * Heatmap data is displayed over an iframe of the given website URL. Because of this, the tracked website must allow for it to be displayed within an iframe on your dashboard domain. * Heatmaps record data points relative to the page container. Because of this, interactions over dynamic elements (such as dropdowns, pop-ups) would show as activity when viewing the heatmap regardless of their visibility (you still see heatmap activity in the region the pop-up was shown, even though the pop-up is currently not visible). {% hint style="warning" %} **NOTE** Because *UXWizz* is self-hosted the **maximum number of recordings stored depends on your server configuration**. You can easily track 30k-50k monthly sessions on a cheap $5/mo VPS. It's a good idea to limit data storage to store only the latest 50k-200k recordings on low-spec servers. \ \ For more details see the [server specifications guidelines](/installation/requirements/server-specs-cpu-ram). {% endhint %} # Server specs (CPU, RAM) A lot of effort has been put into making the tracking and dashboard as fast as possible. \ UXWizz should run well on most servers, but depending on the amount of traffic you get and the total database size you should consider the following suggestions for your server configuration: {% hint style="warning" %} The [full session recording system](https://docs.uxwizz.com/installation/requirements/pages/-MlFhp-p5VUf_FwF-x-1#b.-full-page-recording) uses a lot more resources than the default one. Depending on the content on the site being tracked, you might need more resources. {% endhint %} Minimum recommended server specifications: * **<10k monthly visits** * Any cheap VPS or shared hosting should work * 1 GB RAM * 1 vCPU * 10GB disk * You should consider upgrading your server if you store more than 500k total sessions * **<50k monthly visits** * 2 GB RAM * 2 vCPU * 25GB disk * You should consider upgrading your server if you store more than 1M total sessions * **<200k monthly visits** * 8GB RAM * 4 vCPU * 50GB disk * You should consider upgrading your server if you store more than 5M total sessions * **<1M monthly visits** * 32GB RAM * 8 vCPU * 320GB disk * You should consider upgrading your server if you store more than 10M total sessions * **1M+ monthly visits** * Powerful dedicated server * Preferably to separate the MySQL database on a different server instance Other recommendations: * **Make sure your server resources are properly allocated.** Check the MySQL, Apache and PHP configurations to make sure they have access to utilize all the resources provided by the server. See the [optimization tips](/installation/optimization-tips) for some configuration suggestions. * **Regularly back-up the database.** \ I recommend an external backup service like [**SimpleBackups.io**](https://simplebackups.io/?via=cristian) because it's easy to set-up and you get notified if the backup fails. They also have a free plan for a single project. \ Otherwise you could regularly save the output of mysqldump. * **If you don't use all the features, disable them.**\ UXWizz allows you to granularly set what data is being tracked (click heatmaps, movement heatmaps, recordings). If you do not use heatmaps for example, you can disable them in order to reduce data transfer and storage. In order, the most resource-intensive features are: * Session Recordings (when used, the [default one](https://docs.uxwizz.com/installation/requirements/pages/-MlFhp-p5VUf_FwF-x-1#a.-default-page-recording) is recommended for best performance). * Movement Heatmaps * Click Heatmaps * Suggestion to reduce total storage size over the years: keep all quantitative data (stats, page visits, events) but regularly delete old qualitative data (heatmaps, session recordings). {% hint style="info" %} [See here some recommend hosting providers.](https://docs.uxwizz.com/installation/requirements/pages/-M62BsnivEMZFwYBx5R1#id-2.-recommended-server-hosting-providers) {% endhint %} **If you can't decide what server configuration or hosting provider to use, you can contact support for help and suggestions.** # Installation guide ![](/files/EnxjPqmY8Ej2Y1vXVnL3) {% hint style="info" %} UXWizz can be installed on a server running Apache, PHP and MySQL (LAMP).\ **Installation steps depend on your UXWizz version (Standalone or WordPress)** {% endhint %} **Installation guide for:** 1. [**UXWizz - Standalone**](#id-1.-standalone-version-lamp-server) 2. [**UXWizz - WordPress Plugin**](#id-2.-wordpress-version-plugin) ## 1. Standalone version (LAMP server) ### 1.1. Option A: New server (VPS or dedicated) This is the **recommended way** as you will have a completely separated server where you can track the all your sites.\ UXWizz provides a **cloud-init** configuration script, which allows for one-click installs or you can follow the shell commands mentioned in it to download and install UXWizz. #### See the [**steps to setup a new, dedicated UXWizz server**](/installation/setup-uxwizz-server)**.** ### 1.2. Option B. Existing server (with cPanel or FTP access) UXWizz was designed to run on any server and even on cheap shared hosting, as long as it meets the [requirements](/installation/requirements).\ \ Install UXWizz in 4 simple steps: 1. [Upload the script](/installation/installation/uploading-the-script) 2. [Create a new *MySQL database* for UXWizz](/installation/installation/creating-a-mysql-database) 3. [Run the auto installer](/installation/installation/running-the-installer) 4. [Add the tracking code to your site](/installation/adding-the-tracking-code) ## 2. WordPress version (plugin) You can find a more detailed [WordPress installation guide here](https://usertrack.net/blog/wordpress-analytics-plugin-installation). Summary: 1. Install **wp-usertrack.zip** as a WordPress plugin and **activate** it. 2. Access the userTrack plugin from the wp-admin sidebar. 3. Choose a **password**. 4. Login:\ user: **admin** \ pass: **Your chosen password**\ ![](/files/-Ltuu64dzjrx8qguAZtQ) 5. Add the current **domain name** to be tracked (eg. yoursite.com). 6. If your WordPress site is in a sub-folder: go to **Settings** -> **Tracking** and click "RESET" next to the **Server path** setting so that the server API path is automatically detected.\ 7. Make sure to check the **Pages to track** menu to set on which pages to automatically insert the **ust.min.js** file. It's recommended that you track all non-sensitve pages for more accurate data. 8. You can also include the **ust.min.js** script manually and even on different domains (tracking snippet is shown after adding a new domain name, or from the tracker info of existing domains). {% hint style="info" %} **Note:** After installing userTrack data should be **immediately** tracked, if you visit the site yourself and you don't see any data it means something went wrong during installation. If you can't figure out what's wrong feel free to ask for help by sending an e-mail at **support \[at] uxwizz.com**. {% endhint %} # Uploading the script 1. **Upload the script** 2. [Create a new *MySQL database* for UXWizz](/installation/installation/creating-a-mysql-database) 3. [Run the auto installer](/installation/installation/running-the-installer) 4. [Add the tracking code to your site](/installation/adding-the-tracking-code) ## 1.1 Uploading the script **1. Upload**, using cPanel or FTP, the **userTrack.zip** archive to the root folder of your website (recommended). ![cPanel -> File manager -> public\_html](/files/1G9xh5gloGigq207Im4e) **2. Extract** the zip file and delete the archive afterwards. ![Right click -> Extract -> Extract file(s). Delete .zip file afterwards.](/files/fXVSpOSZkGOsLS89w67b) **3.** You should now have a **userTrack** folder inside the root of your web server. {% hint style="info" %} **File permissions** In some cases you might have to change the **file permissions** (chmod) after they are uploaded. Most of the files only need read permission, but the following files also need write permissions: * **server/dbconfig.php** - write permission needed so the auto-installer can save the database connection information. Write permission can be revoked after the installation is completed. * **server/ust.min.js** - this is the minified tracking script which is updated every time the settings in tracker.js are changed. * **server/ust-rr.min.js** - same as above, but with full session tracking Note that UXWizz comes with an auto-updater. In order for the updater to replace older UXWizz files with the newest version, all UXWizz files and folders should be writable from PHP (have write permission). {% endhint %} # Creating a MySQL database 1. [Upload the script](/installation/installation/uploading-the-script) 2. **Create a new *****MySQL database***** for UXWizz** 3. [Run the auto installer](/installation/installation/running-the-installer) 4. [Add the tracking code to your site](/installation/adding-the-tracking-code) ## 1.2 Creating the database UXWizz requires access to a **MySQL database**, either local (on the same server) or remote. **1. Create a MySQL database**.\ If you are using cPanel you can create it using ***MySQL® Databases***. ![](/files/Z0UBHTByWyZOTT4nGdmQ) **2. Create a MySQL user** (make sure you remember **database name,** **username** and **password**). ![](/files/qKHfFyes6lmrDfWVUhUs) **3. Assign** the user to the database. Mark the "***ALL PRIVILEGES***" checkbox when asked. ![](/files/C1cYTChBaf6WO9cyuPHq) {% hint style="success" %} We now have everything needed to start the installation wizard. {% endhint %} # Running the installer 1. [Upload the script](/installation/installation/uploading-the-script) 2. [Create a new *MySQL database* for UXWizz](/installation/installation/creating-a-mysql-database) 3. **Run the auto installer** 4. [Add the tracking code to your site](/installation/adding-the-tracking-code) ## 1.3 Auto installer Almost done, just one more step: 1. Access \~\~\_**[www.yourdomain.com\*\*\_\~\~\*\*/userTrack/server/install.php](http://www.yourdomain.com**_~~**/userTrack/server/install.php)** and follow the instructions, more specifically in this step you have to fill the connection credentials to the database created in step 2. {% hint style="info" %} If you copied UXWizz files to a different location, access **/server/install.php** relative to the installation path. {% endhint %} {% hint style="success" %} Installation is now complete and you should be prompted to choose a new password. {% endhint %} # Install on a new server {% hint style="info" %} **In the guide you will learn why and how to easily create a new server dedicated to running UXWizz.** \ **After completing this guide, you will have your own UXWizz dashboard running on a VPS or dedicated server, accessible by your own domain name.** {% endhint %} ## How to install **UXWizz** * [Install on a clean Ubuntu 20.04 server](/installation/setup-uxwizz-server/ubuntu-20.04) * [Install on DigitalOcean in a few clicks](/installation/setup-uxwizz-server/digitalocean) * [Install via Docker](/installation/docker) ## Quick notes: ### 1. Benefits of running **UXWizz** on its own server Although you can install UXWizz on the same server as your site, sometimes it might not be possible (eg. your site does not run on PHP) or you might not want to add extra resources on the same server as your site. There are also other advantages of running UXWizz on a separate server: * **Security:** If someone somehow gains access to your UXWizz installation, or a vulnerability is found in UXWizz, the attacker will not be able to affect anything else outside the UXWizz dashboard. * **Site performance:** UXWizz is well optimized, but it's even better if all UXWizz tracking and queries are executed on a separate server, as there is no way for those to affect the performance of the tracked sites. * **Dashboard performance:** The recommended DigitalOcean $5/mo server performance is usually better than most shared hostings, so all the UXWizz dashboard will be faster, as all the graphs can be generated faster on the server. ### **2. Recommended server hosting providers** * [**DigitalOcean**](https://m.do.co/c/32db05609806) **- Simple UI and Quick 1-Click Installation ($200 credit 60-day credit)** * [**Hetzner.com**](https://hetzner.cloud/?ref=UbRqvwvi1mfG) **- For affordable VPS and powerful dedicated servers ($20 credit)** Choose DigitalOcean for the best UI/UX and ease of installation.\ Choose Hetzner for best prices/performance and if you need EU hosting. Why I recommend DigitalOcean: * I used them for several projects and I had a really **good experience**. * I already **tested** and run an UXWizz dashboard on one of their $5/mo server and it runs well. * Their **interface and UX** are one of the best. * The **server performance** is good and stable, your UXWizz dashboard will be fast and reliable. * They provide pre-built **LAMP** images, meaning that you can create a server that already has **Apache**, **PHP** and **MySQL** ready. * They allow for **cloud-init** scripts for easy installation, and there is also a [1-Click UXWizz app](https://marketplace.digitalocean.com/apps/uxwizz?refcode=1ae65cd1b449). * They have a **referral program.** The [DigitalOcean ](https://m.do.co/c/32db05609806)links on this page have an affiliate code and if you sign-up through the links on this page you will get $200 in credit over 60 days. This means that you can get a very powerful server **for 2 months for free.** If you prefer to get a more powerful server, I can't really recommend DigitalOcean as they can get pretty expensive for the high-end specs, in which case I recommend [**Hetzner.com**](https://hetzner.cloud/?ref=UbRqvwvi1mfG)**.** # Ubuntu 20.04 (or higher) {% hint style="info" %} This guide assumes that you already have SSH (console) access to a clean Ubuntu installation.\ If you do not already have a server, check out the [recommended server specs](/installation/requirements/server-specs-cpu-ram). {% endhint %} ## Steps summary: You will learn how to setup the **LAMP stack** and how to install **UXWizz**. * [**Install Apache, PHP, MariaDB**](/installation/setup-uxwizz-server/ubuntu-20.04#lamp-setup) * [**Improve security configuration**](/installation/setup-uxwizz-server/ubuntu-20.04#basic-security) * [**Install UXWizz**](#installing-uxwizz) * [**Use your own domain name**](/installation/setup-uxwizz-server/ubuntu-20.04#adding-your-domain-name) ## LAMP Setup To install Apache, PHP, MariaDB, run those commands in order: ```bash sudo apt install apache2 sudo apt install php libapache2-mod-php sudo apt install mariadb-server sudo apt-get install php-mysql ``` ## Basic Security {% hint style="info" %} Use those commands to enable firewall (ufw) and improve the default MySQL security. {% endhint %} Those steps are optional, but recommended. \ Follow the prompts whenever necessary. ```bash sudo ufw allow ssh sudo ufw allow http sudo ufw allow https sudo ufw enable sudo mysql_secure_installation ``` ## Installing UXWizz {% hint style="info" %} By default, the 14 days trial version will be installed.\ You can then upgrade to the full version using a valid license key in the interface (Settings->Updates).\ \ If you want to **install directly the full version**, replace the second line with\ `curl -Lo userTrack.zip`` `**`https://www.uxwizz.com/download-latest-version?variant=rg&cv=6.4.0&license=YOUR_LICENSE_CODE`** Remember to replace **YOUR\_LICENSE\_CODE** with the license code received via email and to change **variant** accordingly (**wp** for WordPress version, **ag** for the Agency Version). {% endhint %} {% hint style="danger" %} Replace **YOUR\_ROOT\_DATABASE\_PASSWORD** with the password chosen when you ran ***mysql\_secure\_installation*****.** {% endhint %} ```bash cd /var/www/html curl -Lo userTrack.zip https://www.uxwizz.com/trial-download apt install unzip unzip userTrack.zip rm userTrack.zip mv userTrack/* userTrack/.* . find . -type d -exec chmod 0777 {} + find . -type f -exec chmod 0666 {} + rm userTrack -r ust_rootp=YOUR_ROOT_DATABASE_PASSWORD ust_db=uxwizz ust_user=uxwizz ust_password="$(openssl rand -base64 12)" mysql -u root -p"$ust_rootp" -e "CREATE DATABASE $ust_db /*\!40100 DEFAULT CHARACTER SET utf8 */;" mysql -u root -p"$ust_rootp" -e "CREATE USER $ust_user@'%' IDENTIFIED BY \"$ust_password\";" mysql -u root -p"$ust_rootp" -e "GRANT ALL PRIVILEGES ON $ust_db.* TO $ust_user@'%';FLUSH PRIVILEGES;" sed -i "s*password = ''*password = '$ust_password'*" server/dbconfig.php sed -i "s*username = 'root'*username = '$ust_user'*" server/dbconfig.php sed -i "s*db_name = 'uxwizz'*db_name = '$ust_db'*" server/dbconfig.php apt-get install php-zip -y a2enmod headers rewrite systemctl restart apache2 ``` {% hint style="info" %} If, after the installation you need to see the database connection credentials, the values are stored in **server/dbconfig.php.** {% endhint %} ## Adding your domain name ### Install certbot Certbot is used to generate a free [Let's Encrypt](https://letsencrypt.org/) certificate and manage its auto-renewal. ```bash sudo apt update sudo apt install snapd -y sudo snap install snap-store sudo snap install --classic certbot ``` To set your own domain name for this dashboard, [see this adding your domain name section](https://docs.uxwizz.com/installation/setup-uxwizz-server/pages/-MTmCqCRFDvc-ZmvC9lQ#id-2.-point-your-own-domain-name-to-the-uxwizz-dashboard-server). {% hint style="warning" %} **Note**: If accessing *yoursite.com**/server*** shows the Directory listing instead of 'Forbidden', it means that .htaccess files don't work properly. To fix this, set AllowOverride to All in your Apache2 config. You can automatically set it, assuming default paths, by running this command: `sudo sed -i 's/AllowOverride None/AllowOverride All/g' /etc/apache2/apache2.conf` {% endhint %} # DigitalOcean {% hint style="warning" %} ### **Note: This guide is deprecated.** ### **Use the UXWizz 1-Click DigitalOcean App instead!** UXWizz is now available as a 1-Click App on DigitalOcean and can be installed even easier.\ [**Click here to deploy UXWizz 1-Click App on DigitalOcean**](https://marketplace.digitalocean.com/apps/uxwizz?refcode=1ae65cd1b449\&action=deploy)**.** {% endhint %} Server setup summary: 1. [Create a new UXWizz **server**.](#1.-create-a-new-server-running-uxwizz) 2. [Point your own **domain** name at that server's IP.](#2.-point-your-own-domain-name-to-the-uxwizz-dashboard-server) 3. [Add free **HTTPS certificate** for that domain.](#3.-add-free-https-certificate-for-that-domain.) ### 1. Create a new server running UXWizz If you don't already have a DigitalOcean account, you can [create one here](https://m.do.co/c/32db05609806) (referral link, you get **$200 free credits** on sign-up). **1) Create a new droplet.**\
**2) Choose your preferred server location**\ Normally this should be close to you, or close to where the majority of the tracked users are. A central location such as Amsterdam could also be good.
**3) Choose the LAMP image from the Marketplace**

DigitalOcean Marketplace - LAMP image

{% hint style="info" %} If you are interested you can read more about the **DigitalOcean LAMP image** here: {% endhint %} **4) Choose the $6/mo plan** \ If you want you can choose a more powerful server, but the $6/mo should be enough for at least 20-30k monthly visitors. If you want even faster performance, you can go for the $7/mo premium CPUs with NVMe SSD.\ You can also change the plan any time after creating the server.
**5) Select the preferred authentication method to access the server and the server name. SSH is recommended, but if you are not familiar with SSH you can select one-time password.**
**6) Select the free "Monitoring and alerting" add-on**\ This will enable performance graphs in your DigitalOcean dashboard, so you can see the CPU/Memory/Disk/Network usage of the server.

DigitalOcean Enable Monitoring and Alerting

**7) Click Advanced Options -> Add Initialization scripts (free)**\ This is where the magic happens and what automatically installs **UXWizz** on the server. {% hint style="warning" %} You can get the "user data" code by accessing this URL:\ **(replace YOUR\_LICENSE\_KEY with your own UXWizz license code)**\ [https://www.uxwizz.com/get-cloud-config?license=YOUR\_LICENSE\_KEY](https://www.usertrack.net/get-cloud-config?license=YOUR_LICENSE_KEY) **NOTE**: If you are using the **trial** version, use this link instead:\ [https://www.uxwizz.com/get-cloud-config?license=TRIAL](https://usertrack.net/get-cloud-config?license=TRIAL) {% endhint %} Add the copied code to the text input, it should look something like this:
{% hint style="info" %} You can optionally enable **backups.** You can also do this later, after the server is created. {% endhint %} {% hint style="success" %} To recap, those options should be selected: 1. **Marketplace -> LAMP** on 18.04 (or newer) image. 2. **User data textarea must be filled** with the #cloud-config code as explained above. {% endhint %} Everything is done, click **Create Droplet**. \ The server will now be created, it usually takes **4-5 minutes** before it can be accessed. ![](/files/-M62Y6Bv05NZQqSajRYb) While it's being setup we can add our own domain to point to that IP. ### 2. Point your own domain name to the UXWizz dashboard server To do this, you have to go add some DNS records to your domain from your domain name registrar.\ Add two **A** records from your domain (or subdomain name) to the **IP of your server**. 1. **A analytics.example.com 123.123.456.9** 2. **A [www.analytics.example.com](http://www.analytics.example.com) 123.456.78.9** ### **3. Add free HTTPS certificate for that domain.** The easiest way to access the server is through the web console. Here you can use the password that was set when creating the droplet. ![](/files/-M62bcN-K2giTstua-5q) {% hint style="info" %} Note that **when you type passwords in a console, nothing is displayed** but the password is actually typed. When you paste the password from your email you won't see anything, so just paste with it CTRL+V and submit with ENTER. {% endhint %} {% hint style="success" %} You should now be able to **access UXWizz using the new domain name.** It can also be accessed from the server IP. {% endhint %} Now, back to the **HTTPS certificate**.\ While you are in the console, run this command to generate a free **HTTPS certificate** using **certbot:**\ **(replace example.com and [www.example.com](http://www.example.com) with the own domains, the same as in step 2)** ``` certbot --apache --agree-tos -d example.com -d www.example.com ``` There are 3-4 questions you have to respond to in the console after running that command in order for the certificate to be issued. {% hint style="success" %} **Done!**\ \ **You now have a UXWizz instance, running on your own server, on your own domain with a HTTPS certificate.** {% endhint %} You might be able to also use this as a guide to add UXWizz on a server from different hosting provider, but the **user data** (cloud-init) script might not work, as it has some DigitalOcean specific paths. If you had any issues following this guide, or want to suggest making a similar guide for a different provider (assuming they support premade LAMP images and cloud-init), you can send me an e-mail at support \[at] uxwizz.com. # Docker UXWizz also provides public Docker images for the trial version, which can be upgraded to the full version using a [license key](https://www.uxwizz.com/pricing?ref=docker-docs). There are two options: {% content-ref url="/pages/m6V3wQAorh1eQ6yZnYsR" %} [Standalone Docker image](/installation/docker/standalone-docker-image) {% endcontent-ref %} {% content-ref url="/pages/PylwCCcRM0ygk7qoIjdR" %} [Via Docker Compose](/installation/docker/via-docker-compose) {% endcontent-ref %} # Via Docker Compose {% hint style="info" %} This guide assumes you already have [Docker ](https://www.docker.com/)installed. {% endhint %} {% hint style="info" %} This Docker compose creates two services: 1. **Webserver** (Apache/PHP) - The [UXWizz Webserver image](https://hub.docker.com/repository/docker/uxwizz/uxwizz-webserver/general) 2. **Database** (MySQL) - [MariaDB Image](https://hub.docker.com/_/mariadb) {% endhint %} ## Running UXWizz via docker compose Copy this **compose.yml** file locally in a folder named `uxwizz` and run **`docker compose up -d`** {% code title="compose.yml" %} ```yaml services: webserver: image: uxwizz/uxwizz-webserver:latest container_name: "uxwizz-webserver" restart: always ports: - "8000:80" - "4430:443" volumes: - html:/var/www/html - php-config:/usr/local/etc/php/php.ini - apache_sites_enabled:/etc/apache2/sites-enabled - apache_logs:/var/log/apache2 environment: UXWIZZ_DB_HOST: db MYSQL_DATABASE: uxwizz MYSQL_ROOT_PASSWORD: temp-root-password-jasdlkz1 depends_on: db: condition: service_healthy db: image: mariadb:11.7.2 container_name: "uxwizz-db" ports: - "3306:3306" command: --max-allowed-packet=64MB --bind-address=0.0.0.0 environment: MYSQL_ROOT_PASSWORD: temp-root-password-jasdlkz1 MYSQL_DATABASE: uxwizz MARIADB_AUTO_UPGRADE: 1 MARIADB_INITDB_SKIP_TZINFO: 1 volumes: - mysql_data:/var/lib/mysql healthcheck: test: ["CMD", "healthcheck.sh", "--connect", "--innodb_initialized"] start_period: 10s interval: 10s timeout: 5s retries: 3 restart: always volumes: mysql_data: html: apache_logs: apache_sites_enabled: php-config: ``` {% endcode %} {% hint style="warning" %} It is recommended to replace both values of **MYSQL\_ROOT\_PASSWORD** with a secure password. {% endhint %} To **stop** the services, you can run `docker compose down`. To also **delete** all UXWizz data/db/volumes, you can run `docker compose down -v`. ## Accessing UXWizz As shown in the compose file, the ports exported are **8000** (HTTP) and **4430** (HTTPS).\ \ You should now be able to access your dashboard at [**http://localhost:8000**](http://localhost:8000) ## Tip: Using Bind Volumes If you want to use local folders as bind volumes, instead of named volumes. You must first populate the **html** folder from the webserver image, by running this command: ```sh mkdir -p ./html; docker run --rm --entrypoint="" uxwizz/uxwizz-webserver \ tar cf - -C /var/www/html . | tar xf - -C ./html ``` Then, in **compose.yml** prepend **./** to all volumes, like this: ```yaml services: ... webserver: ... volumes: - ./html:/var/www/html - ./php.ini:/usr/local/etc/php/php.ini:ro - ./sites-enabled:/etc/apache2/sites-enabled - ./apache_logs:/var/log/apache2 db: ... volumes: - ./mysql_data:/var/lib/mysql ``` # Standalone Docker image This page explains how to start a new UXWizz Docker container. {% hint style="info" %} This guide assumes you already have [Docker ](https://www.docker.com/)installed. {% endhint %} ### Creating the container To start a new UXWizz container, run this command: ``` docker run -d -p 8080:80 --name uxwizz -v uxwizz_www:/var/www/html -v uxwizz_db:/var/lib/mysql uxwizz/uxwizz ``` Explanation: * **-d** - Run the container detached, without having to keep the current console open * **-p 8080:80** - Map the port 8080 on the host to port 80 in the container * **--name uxwizz** - Container instance name * **-v uxwizz\_www:/var/www/html** - Volume to persist UXWizz webserver files * **-v uxwizz\_db:/var/lib/mysql** - Volume to persist UXWizz database * **uxwizz/uxwizz** - The name of the public [UXWizz Docker Image on DockerHub](https://hub.docker.com/r/uxwizz/uxwizz) ### Accessing UXWizz Open the browser and access {% hint style="info" %} If you installed it on a remote server, access it via the server IP instead. You can change the port mapping by moidfying *8080*, for example *-p 80:80 -p 443:443* for a normal HTTP/HTTPS config. {% endhint %} ### Notes * The named volumes persist between container restarts. * **Updating the platform is done through the UXWizz dashboard itself.** # Adding the tracking code 1. [Upload the script](/installation/installation/uploading-the-script) 2. [Create a new *MySQL database* for UXWizz](/installation/installation/creating-a-mysql-database) 3. [Run the auto installer](/installation/installation/running-the-installer) 4. **Add the tracking code to your site** ## 1.4 Tracking a domain {% hint style="warning" %} **Note: You should include the snippets provided in the UXWizz dashboard, which are unique for each domain.** {% endhint %} You can track unlimited domains on a single UXWizz installation. To track a new domain you have to do two things: 1. **Add the domain name** by giving domain access to your own user using the one of the *Add domain* buttons (from main overview, domain selector or settings→users). 2. **Include the tracking script on that domain**. On each page of the tracked domain you need to include this JavaScript file: {% hint style="info" %} **The actual snippets/links are provided in your dashboard!** {% endhint %} ```html ``` Add it just before the end of the ***head*** tag, like so: ```html ... ... ``` **Note that if you want to use the AB testing feature the tracking code is bigger AND different for each domain (get this code from the interface, for each domain on the Domains page):** ```html ``` {% hint style="info" %} **On what pages to include the script?** It is recommended to include the script on all pages, but you might not want to include the tracking script on sensitive pages such as the login page. {% endhint %} {% hint style="info" %} #### Different tracking settings for each domain? If you want different tracking settings for each domain tracked you can change the settings inside the generated **ust.min.js** tracker file, saving it with another name (eg: ust.min.domain.js) and include this copy on the other domain instead of the original ust.min.js. **Note:** that when you do this, whenever you change settings in the UI, only the original ust.min.js will be updated/regenerated. Domain-specific settings is a planned future. {% endhint %} {% hint style="success" %} If everything worked as expected you should **immediately** see visitors data in your dashboard after a refresh, you can test if the script is working by visiting yourself the site you have installed the tracker on. {% endhint %} # Automatic SPA pageview tracking {% hint style="info" %} To track page views in a Single Page Application (SPA), you normally listen for route changes on your router and send a tracking call. {% endhint %} Here's how you can do it automatically, without changing any code in your application, by detecting when the URL changes: ### Automatically track pageviews on a Single Page Application ````html ```html ``` ```` # Add tracker to Next.js App {% hint style="warning" %} This guide is still quite new. If you encounter any issues, please [contact support](/guides/support). {% endhint %} To add an external analytics tracking snippet in your Next.js application: 1. [Include the tracking snippet in **\_document.tsx** or **app/layout.tsx.**](#id-1.-option-a-next.js-uxwizz-snippet-in-_document.tsx) 2. [Create the UXWizzPageview.tsx component.](#id-2.-creating-uxwizzpageview.tsx) 3. [Include the pageview component.](#id-3.-adding-the-pageview-component) {% hint style="info" %} Write this in your existing **\_document.tsx** file.\ Create it in your **pages directory** if it doesn't exist. If you are using the new **app** routing, copy the \ section into /**app/layout.tsx.** {% endhint %} {% hint style="warning" %} **Note!! - This was the tracking code as of version 6.4.0.** Please update it to match the tracking code given to you in the UXWizz dashboard. Set your own dashboard URL **dashboardURL** constant. {% endhint %} ### 1. (Option A) Next.js UXWizz snippet in \_document.tsx ```jsx import { Html, Head, Main, NextScript } from 'next/document'; import Script from 'next/script'; const dashboardURL = 'https://your.uxwizz.com/server'; const trackedDomain = 'yourappdomain.com'; export default class MyDocument extends Document { render() { return ( {/* UXWIZZ SNIPPET START */} {/* Global scope */} ``` This will add a tag like `click_element-path` for every element clicked, for example `click_#pricing-button(1)`. The `element-path` is a CSS selector that has the `nth-child:` part remove to save space, you can get the original selector by using this function: ```javascript function uncompressSelector(selector) { return selector.replace(/\((\d+)\)/g, ' > *:nth-child($1)'); } // Example var cssSelector = uncompressSelector('#pricing-button(1)'); console.log(cssSelector ); // Outputs: #pricing-button > *:nth-child(1) ``` # Events {% hint style="warning" %} **Note:** Currently the events are only stored and displayed per user in the dashboard. In the future versions you will be able to filter and generate charts based on those events. \ Until then, you can use MySQL to directly query the database. {% endhint %} {% hint style="info" %} If you want to track, for example, conversions, you should also store a Tag, e.g. `purchased`. This allows you to easily filter those sessions and generate charts. {% endhint %} Events allow you to store arbitrary data for a specific session or pageview.\ The main difference between **events** and [**tags** ](/api/tags)is that **tags** are unique strings stored per session, whereas events are complex objects saved per individual page visited. ### UST.addEvent(eventData) Example: ```javascript // NOTE: Make sure this code is added AFTER the tracking snippet UST.addEvent({ category: 'SHOP', // REQUIRED action: 'PURCHASED', // REQUIRED label: 'Football Shoes', value: 49.99, value_secondary: 15.99, item_id: 'SHOE123', data: { img: "prod/img/shoe.png" } }); ``` #### Input parameters You can pass those values in the **eventData** argument: | Parameter | Type | Example value | Info | | -------------------- | ----------------- | ---------------------------- | ----------------------- | | **category** | string - REQUIRED | "SHOP" | | | **action** | string - REQUIRED | "PURCHASED" | | | **label** | string - OPTIONAL | "Football Shoes" | | | **value** | number - OPTIONAL | 49.99 | eg. product price | | **value\_secondary** | number - OPTIONAL | 15.99 | eg. shipping costs/tax | | **item\_id** | string - OPTIONAL | "SHOE123" | eg. item SKU | | **data** | string - OPTIONAL | { img: "prod/img/shoe.png" } | This can be any object. | {% hint style="warning" %} **Data types limits** * **strings** (**category**, **action**, **label**, **item\_id**) have a **character limit of 128**. * **numbers** (**value** and **value\_secondary**) are stored as fixed precision decimal numbers. \ They always have **2 decimals** and a maximum of **13** digits before the decimal. Max decimal number format example: **9,999,999,999,999.99** * The **data** field is stored as a MySQL **TEXT** variable and can have any size (limited by the database engine). {% endhint %} {% hint style="info" %} **Note:** The **data** field is automatically converted to **JSON** using [**JSON.stringify()**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify) on the client-side **if** the passed value is not already a string. {% endhint %} #### Autofilled values Those values are automatically added by the server for each event | Name | Type | Info | | ---------------- | ---------------- | ------------------------------------------------------ | | **id** | UNSIGNED INTEGER | ID of the event | | **clientid** | UNSIGNED INTEGER | ID of the client (session) | | **clientpageid** | UNSIGNED INTEGER | ID of the client page (pageview) | | **date** | DATETIME | Date and time when the event was added to the database | {% hint style="info" %} The events system is loosely opinionated, meaning that you can store values in any way you prefer. The system provides multiple **string** and **number** fields that you populate. In the future, the value of some of those fields might gain a specific meaning in order to automatically generate and display specific charts. For example, the dashboard could automatically show "Revenue" as being the sum of "value" for events that have the action name "PURCHASED". {% endhint %} # Hooks/callbacks ## What are UXWizz callbacks? The UXWizz callbacks or hooks are a way to tap into the client-side UXWizz tracking functionality and listen to specific events. This is useful, for example, if you want to read or forward some UXWizz tracking data to another service. ### Available callbacks * **UST.onLoaded()** * Called as soon as the ust.min.js finishes loading. * **UST.onTrackingStarted() : false | undefined** * Called when all tracking checks passed, meaning that a new session will be created. * This is called before the session was created. * If you want to stop creating this session, return `false` from this function. * **UST.onSessionCreated(clientID: number)** * Called when the UXWizz server create a new session for this client * **clientID**: The integer number ID of the session. * This is called only once per visit for each visitor. * **UST.onPageViewCreated(clientID: number, clientPageID: number)** * Called when a new page has loaded and the server responded with the pageview ID. * **clientID:** The integer ID of the session. * **clientPageID:** The integer ID of the pageview. * This callback is also called once immediately after onSessionCreated (first pageview). * **UST.onDataSent(data: string\[])** * Called whenever tracking data (session recording/heatmap data) is sent to the server. * **data:** An array of data strings sent to the server. \ Each data string is in the format `c=XXX` where `c` is the data type and `XXX` is the data value.\ The data type can be: * **m** - Heatmap movements * Data value is a [Positions string](/api/hooks-callbacks#positions-string-compressed-format) * **c** - Heatmap clicks * Data value is a [Positions string](/api/hooks-callbacks#positions-string-compressed-format) * **p** - Partial recording data * Data value is a [Recording string](/api/hooks-callbacks#recording-string-compressed-format) * **r** - Full recording data (sent when pageview has finished) * Data value is a [Recording string](/api/hooks-callbacks#recording-string-compressed-format) * x - Recording type * Data is an integer * w - We have a complete recording * Data is 1 (or not set) * s - Skip updating lastActivity * Useful for when we want to update data for a user, without automatically refreshing/increasing the user's session duration. * Data is 1 (or not set) * **i** - clientPageID * Data value is a number * **UST.onTagAdded(tag: string)** * Called when **UST.addTag()** was called and the server responded. * **tag**: The string that has just been added as a tag to the current user. * **UST.onEventAdded(eventData: Event)** * **Added in version 3.5.0** * Called when **UST.addEvent()** was called and the server responded. * **eventData**: The original eventData passed, also containing **clientID** and **clientPageID** * **UST.onGDPRAccepted()** * Called when the user accepted the UXWizz tracking consent pop-up. * **UST.onGDPRDeclined()** * Called when the user declined the UXWizz tracking consent pop-up. ### **Usage example** {% hint style="warning" %} Make sure write the callbacks declarations **after the tracking file** is included. {% endhint %} #### Example: Multiple UXWizz callbacks ```javascript // // After ust.min.js include snippet // ... // ``` {% endcode %} {% hint style="info" %} **With Google Tag Manager, the second \ ``` {% endcode %} {% hint style="warning" %} Make sure to replace **`https://your.uxwizz.com/server/ust.min.js?v=x.x.x`** with the actual URL to your tracking file. {% endhint %} # The A/B test JS file is missing ### Problem After the initial installation you might notice that, if you checked the A/B testing feature when including the tracking script, the domain.ab.js file is missing, returning "404 Not Found". ### Cause This happens because **the AB** **testing file is only generated once at least one AB test has been created** and published. ### Solution #### A. If you are not using AB tests, include the tracking snippet without this feature Go to **Domains->Wrench icon (for the domain you want to change the tracking snippet) -> Include the tracking pixel**. Disable the A/B tests feature and copy the tracking code. Update the tracking snippet on your domain. ![Removing the A/B test code from the tracking snippet](/files/EZd503VwNkTtTVgHhcOM) **B. Create and publish an empty test** If you do plan to use A/B tests but don't want to create one yet, you can still generate the A/B test file by going to **A/B tests -> Add new test (bottom right) -> Publish Tests** ![Creating an empty A/B test to generate the missing ab.js file](/files/BTKjAryzK9uIbkMPuwDm) # WordPress # Cloudways 403 Forbidden screen on WordPress ### Problem: A 403 Forbidden screen is shown when trying to access the UXWizz WordPress plugin dashboard. ### Cause: {% hint style="info" %} Direct access to the UXWizz plugin folder is needed in ordered to view the dashboard. {% endhint %} There is a small incompatibility issue with Cloudways by default: Cloudways blocks by default access to all PHP files in the wp-content folder. ### **Solution:** {% hint style="success" %} Allow direct access to the wp-content folder, or at least to the UXWizz plugin folder. {% endhint %} See [**this guide**](https://support.cloudways.com/en/articles/5127209-restrict-direct-access-to-wordpress-php-files) on how to enable direct wp-content access on Cloudways.
# NGINX 403 Forbidden screen on WordPress ### Problem: A 403 Forbidden or 404 Not Found screen is shown when trying to access the UXWizz WordPress plugin dashboard. ### Cause: {% hint style="info" %} Direct access to the UXWizz plugin folder is needed in ordered to view the dashboard. {% endhint %} By default, nginx should use index.html as the index of the directory.\ If this is default is change, you have to make sure index.html is used as index. ### **Solution:** {% hint style="success" %} Set index.html as the index file for the UXWizz main directory {% endhint %} ```nginx server { listen 80; # ADD THIS PART vvv location /wp-content/plugins/wp-usertrack/userTrack { index index.html; } # ADD THIS PART ^^^ } ``` ### Still not working? Sometimes there might be some security plugin or firewall rule to disallow direct access to the **wp-content** folder. Make sure that the UXWizz root folder is white-listed for direct access. Here are some links to how to whitelist a folder in most popular WordPress security plugins: * Sucuri: * Wordfene: The path `/wp-content/plugins/wp-usertrack/userTrack` should be allowed and accessible in your browser. # Extending the dashboard Sometimes you might want to add or remove information from your dashboard, or automate specific tasks. {% hint style="info" %} Currently the dashboard extensibility is not a priority, so there are no tools or callbacks provided. {% endhint %} ## Adding custom CSS/JS using a browser extension You can use a browser extension such as [User JavaScript and CSS (for Chrome)](https://chrome.google.com/webstore/detail/user-javascript-and-css/nbhcbdghjpllgmfilhnhkllmkecfmpld/related?hl=en) to automatically executed custom JavaScript on your dashboard. Examples: ### 1. Making the flags clickable (view IP geolocation info) Let's assume you want to make it so that when you click the country flag next to an user IP (in the visitors list) it opens a new tab with the geolocation information of that IP. One basic solution would be: * Every 2 seconds, find all IP `td` elements in the table * Get the IP from the `value` of the `td` * Make `onclick` handler of the flag icon open a new tab to a geolocation of that IP. {% hint style="warning" %} This will only work if IP hashing and IP censoring are disabled in the settings, otherwise there is no way to know the IP of the user. {% endhint %} For your UXWizz dashboard URL, **add this code in the extension** ```javascript function makeFlagsClickable() { const IPchips = document.querySelectorAll('.MuiTableRow-root td:nth-child(3)'); for(node of IPchips) { const IP = node.getAttribute('value'); const a = node.querySelector('a'); const flag = a.previousSibling; flag.style.cursor = 'pointer' flag.style.outline = '2px dashed lightblue'; const geoIPURL = 'https://whatismyipaddress.com/ip/' + IP; flag.title = geoIPURL; flag.onclick = function() { window.open(geoIPURL, '_blank').focus(); } } } setInterval(makeFlagsClickable, 2000); ``` So it will look like: ![](/files/E0ITOBn8RCToT2Fq5f6s) # Support ![](/files/EnxjPqmY8Ej2Y1vXVnL3) If you have any trouble installing this script or have bugs to report feel free to send an e-mail at **support \[at] uxwizz.com**. {% hint style="warning" %} Please mention your **UXWizz license code** and the **URL** of your **UXWizz dashboard**. {% endhint %} # Migrating to a new server {% hint style="danger" %} Page under construction. **Note:** If you migrate from a multi-db (Agency) setup, you have to migrate all databases. {% endhint %} To migrate your UXWizz dashboard to a new server, you have to: 1. [Migrate the MySQL database](#id-1.-migrate-the-mysql-database) 2. [Copy the UXWizz files](#id-2.-copy-the-uxwizz-folder) 3. [Update your domain to point to the new server ](#id-3.-point-your-domain-name-to-new-server) {% hint style="info" %} You can also use a database backup service like [SimpleBackups.io](https://simplebackups.com/?via=cristian). \ It's also useful and easy to use for regular, scheduled backups and alerting. {% endhint %} ### 1. Migrate the MySQL database {% hint style="warning" %} Before migrating the database, it's a good idea to first [remove all unnecessary data](/installation/optimization-tips/auto-delete-old-data-cron-jobs#built-in-example-scripts) (e.g. old recordings, heatmaps, etc.) in order to reduce the database size as much as possible. {% endhint %} #### 1.1 Backup the current database UXWizz provides a script to back up the current database. Simply run this in your UXWizz folder: ```bash sh /server/cron/ust_backup_dh.sh ``` #### 1.2 Copy the .sql.gz file to the new server We will use `scp` over `ssh` to copy the file directly to the new server. (you can also manually copy this file) #### 1.2.1 Generate new SSH key {% hint style="warning" %} Skip if the new server uses password auth. This key is only used for the scp authentication. {% endhint %} On the original server, generate a new SSH key: ```bash ssh-keygen -t rsa -b 4096 # View and CTRL+C copy the key cat ~/.ssh/id_rsa.pub ``` On the new server, add the previously generated public key: ```bash # Open the authorized keys file nano ~/.ssh/authorized_keys # Add a new line with the previous contents from id_rsa.pub ssh-rsa AAAA_EXISTING_KEYS... ssh-rsa AAAA_THE_NEW_KEY... ``` #### 1.2.2 Copy the backup file Finally, start copying the backup file (replace the filename and the IP to the new server IP) ```bash scp your_backup.sql.gz root@12.45.67.89:/tmp/ust.sql.gz ``` #### 1.3 Import the new database On the new server, unzip the backup, create a new database (preferably with the same name as the old one) and import the sql file: ```bash gunzip ust.sql.gz mysql -u root -p -e "CREATE DATABASE new_database_name; USE new_database_name; SET autocommit=0 ; source ust.sql ; COMMIT;" ``` You might also have to create the same users as before. On the original server, you can see existing MySQL users and their permissions: ```bash apt-get install percona-toolkit pt-show-grants -u YOUR_MYSQL_USER -p YOUR_MYSQL_PASSWORD --database YOUR_UXWIZZ_DB ``` You can copy those grant commands and run them on the new MySQL instance to create the users and give grant privileges. ### 2. Copy the UXWizz folder Assuming your installation folder is **/var/www/html**: {% hint style="info" %} Make sure the folder exists on the new server: `mkdir -p /var/www/html` {% endhint %} {% code title="On original server:" %} ```bash cd /var/www/ scp -r html root@12.45.67.89:/var/www/ ``` {% endcode %} **Note:** If you had cron jobs enabled, you should also copy the contents of `crontab -e` ### 3. Point your domain name to new server Go to your domain name's DNS configuration and update the IP to point to the new server. For any other server configuration (**HTTPS** certificate, MySQL optimized configuration) check out the [UXWizz new server installation guide](/installation/setup-uxwizz-server). # Import SQL data on an existing server {% hint style="info" %} **When to use this**: you setup UXWizz on a new server, but forgot to import your old data. The new server already has new data, so you can't directly import old data, because the incremental IDs will clash. {% endhint %} This page explains how you can import SQL data that contains incremental IDs in an existing, already-populated database. Some tips in the [migration tutorial](/guides/migrating-to-a-new-server) could help for this too. **Steps to import old SQL data in a UXWizz server that already has data:** 1. **Old server:** Purge old data (to make the DB smaller) * Run the queries from [limit record/heatmaps 60 days](/installation/optimization-tips/auto-delete-old-data-cron-jobs#built-in-example-scripts) cron scripts. 2. **Old server:** Export old.sql DB from phpMyAdmin * Only export data, no table structure (otherwise manually replace CREATE TABLE with CREATE TABLE IF NOT EXISTS into the exported SQL file) * Don't export indexes (or manually remove Index creations section in the SQL file) 3. **New server:** Add a large value to all IDs in the new database (see SQL script below) 4. **New server:** Backup of current SQL file on the new server 5. **New server:** Import old.sql data. ### SQL script to increase all IDs (in order to make room for old data) {% hint style="warning" %} This script was tested on UXWizz version 8.5.0. If a new version introduced any database structure changes, you might have to update the script to include all missing tables/IDs. {% endhint %} ```sql -- Change 10million to a larger value (up to 99 million) if you had more data stored -- Disable FK checks SET FOREIGN_KEY_CHECKS=0; SET @offset = 10000000; START TRANSACTION; -- Primary keys UPDATE ust_users SET id = id + @offset; UPDATE ust_clients SET id = id + @offset; UPDATE ust_clientpage SET id = id + @offset; UPDATE ust_client_tag SET id = id + @offset; UPDATE ust_client_event SET id = id + @offset; UPDATE ust_clicks SET id = id + @offset; UPDATE ust_movements SET id = id + @offset; UPDATE ust_records SET id = id + @offset; UPDATE ust_partials SET id = id + @offset; UPDATE ust_access SET id = id + @offset; UPDATE ust_user_client_ip_label SET id = id + @offset; UPDATE ust_limits SET id = id + @offset; UPDATE ust_ab SET id = id + @offset; -- Foreign keys UPDATE ust_access SET userid = userid + @offset; UPDATE ust_user_client_ip_label SET userid = userid + @offset; UPDATE ust_user_client_watched SET userid = userid + @offset, clientid = clientid + @offset; UPDATE ust_clientpage SET clientid = clientid + @offset; UPDATE ust_client_tag SET clientid = clientid + @offset; UPDATE ust_client_event SET clientid = clientid + @offset, clientpageid = clientpageid + @offset; UPDATE ust_clicks SET client = client + @offset; UPDATE ust_movements SET client = client + @offset; UPDATE ust_records SET client = client + @offset; UPDATE ust_partials SET client = client + @offset; -- === Reset AUTO_INCREMENT for each table === -- ust_users SELECT GREATEST(IFNULL(MAX(id), 0) + 1, @offset) INTO @next_id FROM ust_users; SET @sql = CONCAT('ALTER TABLE ust_users AUTO_INCREMENT = ', @next_id); PREPARE stmt FROM @sql; EXECUTE stmt; DEALLOCATE PREPARE stmt; -- ust_clients SELECT GREATEST(IFNULL(MAX(id), 0) + 1, @offset) INTO @next_id FROM ust_clients; SET @sql = CONCAT('ALTER TABLE ust_clients AUTO_INCREMENT = ', @next_id); PREPARE stmt FROM @sql; EXECUTE stmt; DEALLOCATE PREPARE stmt; -- ust_clientpage SELECT GREATEST(IFNULL(MAX(id), 0) + 1, @offset) INTO @next_id FROM ust_clientpage; SET @sql = CONCAT('ALTER TABLE ust_clientpage AUTO_INCREMENT = ', @next_id); PREPARE stmt FROM @sql; EXECUTE stmt; DEALLOCATE PREPARE stmt; -- ust_client_tag SELECT GREATEST(IFNULL(MAX(id), 0) + 1, @offset) INTO @next_id FROM ust_client_tag; SET @sql = CONCAT('ALTER TABLE ust_client_tag AUTO_INCREMENT = ', @next_id); PREPARE stmt FROM @sql; EXECUTE stmt; DEALLOCATE PREPARE stmt; -- ust_client_event SELECT GREATEST(IFNULL(MAX(id), 0) + 1, @offset) INTO @next_id FROM ust_client_event; SET @sql = CONCAT('ALTER TABLE ust_client_event AUTO_INCREMENT = ', @next_id); PREPARE stmt FROM @sql; EXECUTE stmt; DEALLOCATE PREPARE stmt; -- ust_clicks SELECT GREATEST(IFNULL(MAX(id), 0) + 1, @offset) INTO @next_id FROM ust_clicks; SET @sql = CONCAT('ALTER TABLE ust_clicks AUTO_INCREMENT = ', @next_id); PREPARE stmt FROM @sql; EXECUTE stmt; DEALLOCATE PREPARE stmt; -- ust_movements SELECT GREATEST(IFNULL(MAX(id), 0) + 1, @offset) INTO @next_id FROM ust_movements; SET @sql = CONCAT('ALTER TABLE ust_movements AUTO_INCREMENT = ', @next_id); PREPARE stmt FROM @sql; EXECUTE stmt; DEALLOCATE PREPARE stmt; -- ust_records SELECT GREATEST(IFNULL(MAX(id), 0) + 1, @offset) INTO @next_id FROM ust_records; SET @sql = CONCAT('ALTER TABLE ust_records AUTO_INCREMENT = ', @next_id); PREPARE stmt FROM @sql; EXECUTE stmt; DEALLOCATE PREPARE stmt; -- ust_partials SELECT GREATEST(IFNULL(MAX(id), 0) + 1, @offset) INTO @next_id FROM ust_partials; SET @sql = CONCAT('ALTER TABLE ust_partials AUTO_INCREMENT = ', @next_id); PREPARE stmt FROM @sql; EXECUTE stmt; DEALLOCATE PREPARE stmt; -- ust_access SELECT GREATEST(IFNULL(MAX(id), 0) + 1, @offset) INTO @next_id FROM ust_access; SET @sql = CONCAT('ALTER TABLE ust_access AUTO_INCREMENT = ', @next_id); PREPARE stmt FROM @sql; EXECUTE stmt; DEALLOCATE PREPARE stmt; -- ust_user_client_ip_label SELECT GREATEST(IFNULL(MAX(id), 0) + 1, @offset) INTO @next_id FROM ust_user_client_ip_label; SET @sql = CONCAT('ALTER TABLE ust_user_client_ip_label AUTO_INCREMENT = ', @next_id); PREPARE stmt FROM @sql; EXECUTE stmt; DEALLOCATE PREPARE stmt; -- ust_limits SELECT GREATEST(IFNULL(MAX(id), 0) + 1, @offset) INTO @next_id FROM ust_limits; SET @sql = CONCAT('ALTER TABLE ust_limits AUTO_INCREMENT = ', @next_id); PREPARE stmt FROM @sql; EXECUTE stmt; DEALLOCATE PREPARE stmt; -- ust_ab SELECT GREATEST(IFNULL(MAX(id), 0) + 1, @offset) INTO @next_id FROM ust_ab; SET @sql = CONCAT('ALTER TABLE ust_ab AUTO_INCREMENT = ', @next_id); PREPARE stmt FROM @sql; EXECUTE stmt; DEALLOCATE PREPARE stmt; COMMIT; -- Re-enable FK checks SET FOREIGN_KEY_CHECKS=1; ``` # Feedback form (polls) A basic example of a poll form with a question and a simple Yes/No answer. The response is stored as a [**tag**](/api/tags) attached to the current user. You can also modify the code to use [**events**](/api/events) instead and store more data (like the current page the user is on, the question text, username, etc.). ### Example ![A simple poll functionality implemented using UXWizz to store the results](/files/-MdMtNUQBrLWn9t38fqc) You can test in this [JSFiddle](https://jsfiddle.net/pohcs8y2/3/) (note that this fiddle does not actually send data to UXWizz). ### HTML: {% hint style="info" %} Add this before the end of the \ tag. {% endhint %} ```markup
Is this page useful?
X
``` ### JavaScript: {% hint style="info" %} Add this in a \ ``` {% endcode %} The end result will be something like this:
# Tracking UTM parameters Example of reading and storing URL query parameters for each session. By default UTM parameters and not tracked in any way, they are even removed from the saved URL so that the number of unique links stored is reduced. If you want to store the UTM params for each session, you can automatically [tag](/api/tags) each session with the name and value of each UTM parameter. Add this after the tracking snippet: {% code title="Store UTM parameters as tags" %} ```html ``` {% endcode %} {% hint style="info" %} Once you have stored the utm parameters as tags you can create segments and filter sessions based on those tags. {% endhint %} # Tracking Google Ads GCLID By default, the **gclid** parameter is removed from the query parameters, so it won't be stored.\ \ To store the Google Ads click identifier **gclid** as a [Tag](/api/tags), you can use the [tracking UTM parameters](/useful-examples/tracking-utm-parameters) guide, by adding "gclid" to the tracked utms list. To simply include gclid in the final tracked URL, **remove** it from **Settings → Tracking → Remove query params from the saved URL**
# Storing user device types Example of storing custom device type data using tags. If you want more granular device type data to be stored (e.g. mobile/tablet/desktop or Android/iOS/Windows/MacOS) and used to filter sessions, you can manually store extra device data for each session using [Tags](/api/tags). {% hint style="info" %} Note: The device type is sometimes hard to define, for example nowadays laptops can have a touchscreen or tablets can have keyboards and mouse and be used as laptops, the so called 2-in-1 devices (e.g. Microsoft Surface). {% endhint %} You should include this script tag **after** the included UXWizz tracking snippet. {% code title="Store device type as tag" %} ```html ``` {% endcode %} {% hint style="info" %} By default UXWizz does store the device type in the `ust_clients` table under the `device-type` column, but only stores `0` for desktop devices and `1` for mobile devices (no difference is made for tablets). {% endhint %} # Track video playback Let's say you have a video on your landing page, and you want to know if people watched it.\ \ We could track the following actions: * User started playing the video * User paused playing the video (we want to know how far they watched before pausing) * User reached the end of the video We can use a combination of [Tags](/api/tags) and [Events](/api/events) for tracking those actions: ### HTML5 \