Releases: plausible/analytics
v1.5.0-rc.0
The highlights of this release are:
- City and region level geolocation (disabled by default, please see this discussion for setup info)
- Google Analytics integration: https://plausible.io/docs/google-analytics-import (WIP setup guide: plausible/docs#278)
- CSV data export: https://plausible.io/docs/export-stats
- ARM64 support
Upgrading Plausible Analytics to v1.5
In your docker-compose.yml
update the image used for plausible
to tag 1.5.0-rc.0
:
plausible:
- image: plausible/analytics:v1.4
+ image: plausible/analytics:1.5.0-rc.0
Restart the container
$ docker compose stop plausible
$ docker compose rm plausible
$ docker compose up -d
This will boot up the new version of the app.
Upgrading ClickHouse to 22.6 (Optional, but recommended)
In your docker-compose.yml
, update the image used for plausible_events_db
to the newest stable ClickHouse version:
plausible_events_db:
- image: yandex/clickhouse-server:21.3.2.5
+ image: clickhouse/clickhouse-server:22.6-alpine
Restart the container
$ docker compose stop plausible plausible_events_db
$ docker compose rm plausible_events_db
$ docker compose up -d
This will boot up the new version of ClickHouse.
Related PR: plausible/community-edition#45
Upgrading PostgreSQL to 14 (Optional, but recommended)
Upgrading PostgreSQL is a bit trickier, here's the upgrade guide.
Changelog
Following changes have been made since v1.4:
Added
- The ability to escape
|
characters with\
in Stats API filter values - An upper bound of 1000 to the
limit
parameter in Stats API - The
exclusions
script extension now also takes adata-include
attribute tag - A
file-downloads
script extension for automatically tracking file downloads as custom events - Integration with Matomo's referrer spam list to block known spammers
- API route
PUT /api/v1/sites/goals
with form paramssite_id
,event_name
and/orpage_path
, andgoal_type
with supported typesevent
andpage
- API route
DELETE /api/v1/sites/goals/:goal_id
with form paramssite_id
- The public breakdown endpoint can be queried with the "events" metric
- Data exported via the download button will contain CSV data for all visible graps in a zip file.
- Region and city-level geolocation #1449
- The
u
option can now be used in themanual
extension to specify a URL when triggering events. - Delete a site and all related data through the Sites API
- Subscribed users can see their Paddle invoices from the last 12 months under the user settings
- Allow custom styles to be passed to embedded iframe #1522
- New UTM Tags
utm_content
andutm_term
#515 - If a session was started without a screen_size it is updated if an event with screen_size occurs
- Added
LISTEN_IP
configuration parameter #1189 - The breakdown endpoint with the property query
property=event:goal
returns custom goal properties (withinprops
) - Added IPv6 Ecto support (via the environment-variable
ECTO_IPV6
) - New filter type:
contains
, available forpage
,entry_page
,exit_page
- Add filter for custom property
- Add ability to import historical data from GA: #1753
- API route
GET /api/v1/sites/:site_id
- Hovering on top of list items will now show a tooltip with the exact number instead of a shortened version
- Filter goals in realtime filter by clicking goal name
- The time format (12 hour or 24 hour) for graph timelines is now presented based on the browser's defined language
- Choice of metric for main-graph both in UI and API (visitors, pageviews, bounce_rate, visit_duration) #1364
- New width=manual mode for embedded dashboards #2148
- Add more timezone options
- Add new strategy to recommend timezone when creating a new site
- Alert outgrown enterprise users of their usage #2197
- Manually lock and unlock enterprise users #2197
- ARM64 support for docker images #2103
- Add support for international domain names (IDNs) #2034
Fixed
- Plausible script does not prevent default if it's been prevented by an external script plausible/analytics#1941
- Hash part of the URL can now be used when excluding pages with
script.exclusions.hash.js
. - UI fix where multi-line text in pills would not be underlined properly on small screens.
- UI fix to align footer columns
- Guests can now use the favicon to toggle additional info about the site bing viewed (such as in public embeds).
- Fix SecurityError in tracking script when user has blocked all local storage
- Prevent dashboard graph from being selected when long pressing on the graph in a mobile browser
- The exported
pages.csv
file now includes pageviews again plausible/analytics#1878 - Fix a bug where city, region and country filters were filtering stats but not the location list
- Fix a bug where regions were not being saved
- Timezone offset labels now update with time changes
- Render 404 if shared link auth cannot be verified plausible/analytics#2225
- Restore compatibility with older format of shared links plausible/analytics#2225
- Fix 'All time' period for sites with no recorded stats plausible/analytics#2277
- Ensure settings page can be rendered after a form error plausible/analytics#2278
Changed
script.file-downloads.outbound-links.js
only sends an outbound link event when an outbound download link is clicked- Plausible script now uses callback navigation (instead of waiting for 150ms every time) when sending custom events
- Cache the tracking script for 24 hours
- Move
entry_page
andexit_page
to be part of thePage
filter group - Paginate /api/sites results and add a
View all
link to the site-switcher dropdown in the dashboard. - Remove the
+ Add Site
link to the site-switcher dropdown in the dashboard. DISABLE_REGISTRATIONS
configuration parameter can now acceptinvite_only
to allow invited users to register an account while keeping regular registrations disabled #1841- New and improved Session tracking module for higher throughput and lower latency. PR#1934
- Do not display ZZ country code in countries report PR#1934
- Add fallback icon for when DDG favicon cannot be fetched PR#2279
v1.4.4
Security patch for password reset emails. Analysis of the issue and its impact: https://my-devbox.de/en/blog/accidental-pen-tester-evening/
Fixed
- Fix vulnerability with password reset emails
v1.4.3
v1.4.2
v1.4.1
v1.4.0
The highlights of this release are:
- Invite team members to your site dashboard
- More powerful filtering options
- Email verification requirement for users is now disabled by default. It can be enabled with the
ENABLE_EMAIL_VERIFICATION=true
option.
To update your installation, make sure your _docker-compose.yml_l file is referencing plausible/analytics
with the following tag: v1.4.0
. Then run the following commands:
$ docker-compose down
$ docker-compose pull plausible
$ docker-compose up -d
This will run your database migrations and boot up the new version of the app. Following changes have been made since v1.3:
Added
- New parameter
metrics
for the/api/v1/stats/timeseries
endpoint #952 - CSV export now includes pageviews, bounce rate and visit duration in addition to visitors #952
- Send stats to multiple dashboards by configuring a comma-separated list of domains #968
- To authenticate against a local postgresql via socket authentication, the environment-variables
DATABASE_SOCKET_DIR
&DATABASE_NAME
were added. - Time on Page metric available in detailed Top Pages report #1007
- Wildcard based page, entry page and exit page filters #1067
- Exclusion filters for page, entry page and exit page filters #1067
- Menu (with auto-complete) to add new and edit existing filters directly #1089
- Added
CLICKHOUSE_FLUSH_INTERVAL_MS
andCLICKHOUSE_MAX_BUFFER_SIZE
configuration parameters #1073 - Ability to invite users to sites with different roles #1122
- Option to configure a custom name for the script file
- Add Conversion Rate to Top Sources, Top Pages Devices, Countries when filtered by a goal #1299
- Add list view for countries report in dashboard #1381
- Add ability to view more than 100 custom goal properties #1353
Fixed
- Fix weekly report time range #951
- Make sure embedded dashboards can run when user has blocked third-party cookies #971
- Sites listing page will paginate if the user has a lot of sites #994
- Crash when changing theme on a loaded dashboard #1123
- UI fix for details button overlapping content on mobile #1114
- UI fix for the main graph on mobile overlapping its tick items on both axis
- UI fixes for text not showing properly in bars across multiple lines. This hides the totals on <768px and only shows the uniques and % to accommodate the goals text too. Larger screens still truncate as usual.
- Turn off autocomplete for name and password inputs in the New shared link form.
- Details modals are now responsive and take up less horizontal space on smaller screens to make it easier to scroll.
- Fix reading config from file
- Fix some links not opening correctly in new tab
- UI fix for more than one row of custom event properties #1383
- UI fix for user menu and time picker overlapping #1352
- Respect the
path
component of BASE_URL to allow subfolder installatons
Removed
- Removes AppSignal monitoring package
Changes
- Disable email verification by default. Added a configuration option
ENABLE_EMAIL_VERIFICATION=true
if you want to keep the old behaviour
v1.4.0-rc.0
The highlights of this release are:
- Invite team members to your site dashboard
- More powerful filtering options
- Email verification requirement for users is now disabled by default. It can be enabled with the
ENABLE_EMAIL_VERIFICATION=true
option.
This is a release candidate for testing. To update your installation, make sure your docker-compose.yml file is referencing plausible/analytics
with the following tag: v1.4.0-rc.0
. Then run the following commands:
$ docker-compose down
$ docker-compose pull plausible
$ docker-compose up -d
This will run your database migrations and boot up the new version of the app. Following changes have been made since v1.3:
Added
- New parameter
metrics
for the/api/v1/stats/timeseries
endpoint #952 - CSV export now includes pageviews, bounce rate and visit duration in addition to visitors #952
- Send stats to multiple dashboards by configuring a comma-separated list of domains #968
- To authenticate against a local postgresql via socket authentication, the environment-variables
DATABASE_SOCKET_DIR
&DATABASE_NAME
were added. - Time on Page metric available in detailed Top Pages report #1007
- Wildcard based page, entry page and exit page filters #1067
- Exclusion filters for page, entry page and exit page filters #1067
- Menu (with auto-complete) to add new and edit existing filters directly #1089
- Added
CLICKHOUSE_FLUSH_INTERVAL_MS
andCLICKHOUSE_MAX_BUFFER_SIZE
configuration parameters #1073 - Ability to invite users to sites with different roles #1122
- Option to configure a custom name for the script file
- Add Conversion Rate to Top Sources, Top Pages Devices, Countries when filtered by a goal #1299
- Add list view for countries report in dashboard #1381
- Add ability to view more than 100 custom goal properties #1353
Fixed
- Fix weekly report time range #951
- Make sure embedded dashboards can run when user has blocked third-party cookies #971
- Sites listing page will paginate if the user has a lot of sites #994
- Crash when changing theme on a loaded dashboard #1123
- UI fix for details button overlapping content on mobile #1114
- UI fix for the main graph on mobile overlapping its tick items on both axis
- UI fixes for text not showing properly in bars across multiple lines. This hides the totals on <768px and only shows the uniques and % to accommodate the goals text too. Larger screens still truncate as usual.
- Turn off autocomplete for name and password inputs in the New shared link form.
- Details modals are now responsive and take up less horizontal space on smaller screens to make it easier to scroll.
- Fix reading config from file
- Fix some links not opening correctly in new tab
- UI fix for more than one row of custom event properties #1383
- UI fix for user menu and time picker overlapping #1352
- Respect the
path
component of BASE_URL to allow subfolder installatons
Removed
- Removes AppSignal monitoring package
Changes
- Disable email verification by default. Added a configuration option
ENABLE_EMAIL_VERIFICATION=true
if you want to keep the old behaviour
v1.3.0
The highlights of this release are:
- Stats API: https://plausible.io/docs/stats-api
- Embedded stats: https://plausible.io/docs/embed-dashboard
- Fix for sending weekly and monthly reports over SMPT: #827
- Country database is packaged with the app by default. The
maxmindinc/geoipupdate
container is no longer necessary for geolocation
This release bumps the minimum Clickhouse version is 20.8.7.15
so make sure you upgrade your Clickhouse installation if needed.
To update your Plausible installation, make sure your docker-compose.yml file is referencing plausible/analytics
with one of the following tags: latest
, v1
, v1.3
, v1.3.0
. Then run the following commands:
$ docker-compose down
$ docker-compose pull plausible
$ docker-compose up -d
This will run your database migrations and boot up the new version of the app. Following changes have been made since v1.2:
Added
- Stats API [currently in beta] #679
- Ability to view and filter by entry and exit pages, in addition to regular page hits #712
- 30 day and 6 month keybindings (
T
andS
, respectively) #709 - Site switching keybinds (1-9 for respective sites) #735
- Glob (wildcard) based pageview goals #750
- Support for embedding shared links in an iframe #812
- Include a basic IP-To-Country database by default #906
- Add name/label to shared links #910
Fixed
- Capitalized date/time selection keybinds not working #709
- Invisible text on Google Search Console settings page in dark mode #759
- Disable analytics tracking when running Cypress tests
- CSV reports can be downloaded via shared links #884
- Fixes weekly/monthly email report delivery over SMTP #889
- Disable self-tracking with self hosting #907
- Fix current visitors request when using shared links
v1.3.0-rc.0
The highlights of this release are:
- Stats API: https://plausible.io/docs/stats-api
- Embedded stats: https://plausible.io/docs/embed-dashboard
- Fix for sending weekly and monthly reports over SMPT: #827
This is a release candidate for testing. To update your installation, make sure your docker-compose.yml file is referencing plausible/analytics
with the following tag: v1.3.0-rc.0
. Then run the following commands:
$ docker-compose down
$ docker-compose pull plausible
$ docker-compose up -d
This will run your database migrations and boot up the new version of the app. Following changes have been made since v1.2:
Added
- Stats API #679
- Ability to view and filter by entry and exit pages, in addition to regular page hits #712
- 30 day and 6 month keybindings (
T
andS
, respectively) #709 - Site switching keybinds (1-9 for respective sites) #735
- Glob (wildcard) based pageview goals #750
- Support for embedding shared links in an iframe #812
Fixed
v1.2.0
To update your installation, make sure your docker-compose.yml file is referencing plausible/analytics
with one of the following tags: latest
, v1
, v1.2
, v1.2.0
. Then run the following commands:
$ docker-compose down
$ docker-compose pull plausible
$ docker-compose up -d
This will run your database migrations and boot up the new version of the app. Following changes have been made since v1.1:
Added
- Ability to add event metadata #381
- Add tracker module to automatically track outbound links #389
- Display weekday on the visitor graph #175
- Collect and display browser & OS versions #397
- Simple notifications around traffic spikes #453
- Dark theme option/system setting follow #467
- "Load More" capability to pages modal #480
- Unique Visitors (last 30 min) as a top stat in realtime view #500
- Pinned filter and date selector rows while scrolling #472
- Escape keyboard shortcut to clear all filters #625
- Tracking exclusions, see our documentation here and here for details #489
- Keybindings for selecting dates/ranges #630
Changed
- Use alpine as base image to decrease Docker image size #353
- Ignore automated browsers (Phantom, Selenium, Headless Chrome, etc)
- Display domain's favicon on the home page
- Ignore consecutive pageviews on same pathname #417
- Validate domain format on site creation #427
- Improve settings UX and design #412
- Improve site listing UX and design #438
- Improve onboarding UX and design #441
- Allows outbound link tracking script to use new tab redirection #494
- "This Month" view is now Month-to-date for the current month #491
- My sites now show settings cog at all times on smaller screens #497
- Background jobs are enabled by default for self-hosted installations #603
- All new users on self-hosted installations have a never-ending trial #603
- Changed caret/chevron color in datepicker and filters dropdown
Fixed
- Do not error when activating an already activated account #370
- Ignore arrow keys when modifier keys are pressed #363
- Show correct stats when goal filter is combined with source #374
- Going back in history now correctly resets the period filter #408
- Fix URL decoding in query parameters #416
- Fix overly-sticky date in query parameters plausible/analytics/#439
- Prevent picking dates before site insertion plausible/analtics#446
- Fix overly-sticky from and to in query parameters #495
- Adds support for single-day date selection #495
- Goal conversion rate in realtime view is now accurate #500
- Various UI/UX issues #503
Security
- Do not run the plausible Docker container as root #362