Installing OpenRefine
System requirements
OpenRefine does not require internet access to run its basic functions. Once you download and install it, it runs as a small web server on your own computer, and you access that local web server by using your browser. It only requires an internet connection to import data from the web, reconcile data using a web service, or export data to the web.
OpenRefine requires three things on your computer in order to function:
Compatible operating system
OpenRefine is designed to work with Windows, Mac, and Linux operating systems. Our team releases packages for each.
Java
Java must be installed and configured on your computer to run OpenRefine. The Mac version of OpenRefine includes Java; new in OpenRefine 3.4, there is also a Windows package with Java included.
If you want to install Java yourself, you can install a pre-built Java Runtime Environment (JRE) from Adoptium.net. Please note that OpenRefine works with Java 11 to Java 17 for OpenRefine 3.7.
If you install and start OpenRefine on a Windows computer without Java, it will automatically open up a browser window to this page.
Compatible browser
OpenRefine works best on browsers based on WebKit, such as:
We are aware of some minor rendering and performance issues on other browsers such as Firefox. We don't support Internet Explorer. If you are having issues running OpenRefine, see the section on Running.
Release versions
OpenRefine always has a latest stable release, as well as some more recent developments available in beta, release candidate, or snapshot releases. If you are installing for the first time, we recommend the latest stable release.
If you wish to use an extension that is only compatible with an earlier version of OpenRefine, and do not require the latest features, you may find that an older stable version is best for you in our list of releases. Look at later releases to see which security vulnerabilities are being fixed, in order to assess your own risk tolerance for using earlier versions. Look for “final release” versions instead of “beta” or “release candidate” versions.
Unstable versions
If you need a recently developed function, and are willing to risk some untested code, you can look at the most recent items in the list and see what changes appeal to you.
“Beta” and “release candidate” versions may both have unreported bugs and are most suitable for people who are willing to help us troubleshoot these versions by creating bug reports.
For the absolute latest development updates, see the snapshot releases. These are created with every commit.
Installing or upgrading
Back up your data
If you are upgrading from an older version of OpenRefine and have projects already on your computer, you should create backups of those projects before you install a new version.
First, locate your workspace directory. Then copy everything you find there and paste it into a folder elsewhere on your computer.
For extra security you can export your existing OpenRefine projects.
Take note of the extensions you have currently installed. They may not be compatible with the upgraded version of OpenRefine. Installations can be installed in two places, so be sure to check both your workspace directory and the existing installation directory.