Eventfox docs

How to install Eventfox, add it to your site and use it. Everything here describes what Eventfox does today; what is coming is on the roadmap.

Getting started

  • InstallInstall Eventfox with Docker, either the all-in-one setup with its own Postgres or your own Postgres, then sign in, add the script and back up.
  • Add the script to your siteAdd one script tag to your site's head and page views appear in Eventfox within seconds. Includes allowed domains, Next.js and consent.
  • Your first eventCheck that page views arrive, then send your first custom event with one line of code and find it in the Events page.

Guides

  • Standard and Privacy modesEvery Eventfox project runs in Standard or Privacy mode. What each stores, the Standard mode switches, changing a mode and whether you need a cookie banner.
  • Custom eventsTrack anything that matters, such as sign-ups and purchases, with one line of code. Property rules, limits and what privacy modes remove.
  • FunnelsBuild a funnel of two to five steps from page views and custom events, and see conversion, drop-off and the time between steps.
  • Team and rolesAdd teammates to Eventfox as admins or viewers, give them temporary passwords, and understand how the number of users depends on your plan.
  • Retention and deletionChoose how long each project keeps events, delete all events or one visitor's events, and remove a whole project. Deleted data is gone for good.
  • Adding a licencePlain-English guide to the Free, Pro, Team and Business plans, who needs a licence, and how to install one on your own server.

Reference

  • Command lineEvery Eventfox command you can run with docker compose exec: create projects, set domains, reset passwords, delete a visitor, and manage licences.
  • JavaScript SDKReference for the Eventfox browser script and the @eventfox/web package: init options, track, page, consent functions and what the script sends.

More

  • RoadmapWhat is planned for Eventfox after the current release, from session view and email reports to retention cohorts, a read API and A/B tests.
  • ChangelogEvery Eventfox release and what changed in it, newest first. Read it before you upgrade.