Installing Brivacia

This guide explains how to install Brivacia for the first time.

1. Download Brivacia

Download the Brivacia ZIP archive.

Extract it on your computer, then upload all files to your web server.

Brivacia should be uploaded to the folder where you want to access the dashboard.

For example:

https://stats.example.com/

or:

https://example.com/brivacia/

2. Open Brivacia in your browser

Open the Brivacia URL in your browser.

If Brivacia is not installed yet, the installation wizard opens automatically.

3. Configure the dashboard

Choose the dashboard name.

This name is shown in the Brivacia interface.

Example:

Brivacia

4. Create the admin account

Create the local administrator account used to access Brivacia.

You need to choose:

• an admin username;
• an admin password;
• the same password again for confirmation.

The username must be between 3 and 32 characters long, and use only letters, numbers, dots, dashes or underscores.

The password must be between 12 and 128 characters long and include:

• one lowercase letter;
• one uppercase letter;
• one number;
• one special character.

You cannot use a common username such as admin, administrateur, administrator, brivacia, demo, guest, login, owner, root, support, system, test, or user.

Brivacia stores only the password hash in:

data/settings.json

5. Add your tracked website

Add at least one website to track.

Each tracked website has:

• a site code;
• a domain.

Example:

Site code: main
Domain: example.com

The site code is used by the tracking pixel.

For example, if the site code is main, the pixel will send:

site=main

You can add more websites later from the Brivacia settings.

6. Choose privacy settings

Choose how Brivacia should handle visitor location and IP anonymization.

Country provider:

• none: no country detection;
• blurloc: approximate location provider;
• cloudflare: use Cloudflare country headers. This only works if your website is behind Cloudflare.

IP prefix:

• 2 octets: stronger anonymization;
• 3 octets: more precise, still anonymized.

These settings can be changed later.

7. Choose referrer options

Brivacia can automatically improve referrer display.

You can enable or disable:

• automatic referrer icons;
• automatic referrer labels.

These settings can also be changed later.

8. Finish installation

Click the install button.

Brivacia creates its configuration files in:

data/

Important files include:

data/settings.json
data/brivacia.key

These files must not be publicly accessible.

The default Brivacia .htaccess file blocks direct access to sensitive files such as JSON, SQLite, log and key files on Apache-compatible servers.

9. Log in

After installation, log in with the admin account you created.

10. Add the tracking pixel to your website

Open the integration code from the Brivacia menu.

Copy the tracking pixel for your website and paste it into the website you want to track.

The recommended location is just before the closing </body> tag.

Brivacia starts collecting statistics as soon as the tracking pixel is loaded by your website.

After installation

You can change many options later from the Brivacia settings.

Do you find this project useful? You can support its development using the buttons in the page footer.