Setup

System requirements

• Supports Mac, Windows 7/10 (Professional) and Ubuntu Linux 16.04.
  • All others are untested, and while they may work, they are not currently supported.
• All instructions assume that Git is already installed.
• Recommended minimum supported screen resolution is 1920 x 1080 for Windows and Linux, default for display (2880 x 1800 for retina Mac and 1440 x 900 for non-retina Mac)
• The bootstrap script asks to install some software at the system level, as well as possibly change default Python version. Please decide if this is acceptable to you before saying yes. In addition, you will be asked if you would like to install libraries to enable OCR.
• Important: when running Iris, make sure that you have saved any work that you have open. When Iris is running, it commands all user input, and can interfere with any document or interface that matches a given test.
• Wayland on Linux: when running Iris on Linux make sure you're using GNOME X11 as your desktop environment. This is currently the only desktop environment that has been tested and is supported at this time.

---

Mac instructions:

1. Clone the Iris repo.

cd ~
git clone https://github.com/mozilla/iris

2. Run the Mac bootstrap script. Please note: this will install some software as well as make some system changes. If you disagree, the script will allow you to exit.

cd iris
./bootstrap/bootstrap.sh

3. Run this command to agree to xcode terms of service.

sudo xcodebuild -license accept

4. Restart your Mac in order for certain libraries to be recognized.
5. In System Preferences, go to Mission Control and change the keyboard shortcut for "Application Windows" to "-", or none.
6. Launch Iris.

cd ~/iris
pipenv install
pipenv shell
iris -k

NOTE: If your test just starts the Firefox instance and then nothing happens, please have a look in Security Preferences > Security & Privacy > Privacy > Accessibility - you might have to allow your terminal application in the list.

---

Windows 7 / Windows 10 Professional instructions:

Note:
Windows 7 requires Powershell 5 and the latest .NET framework version 4.5. In addition, please make sure you are using the default theme for the operating system, and not a custom theme such as "Aero," as this is not supported.

1. Launch the terminal.
2. Run the following commands. Please note:

• The script will prompt you to restart the terminal twice.
• This will install some software as well as make some system changes. If you disagree, the script will allow you to exit.

git clone https://github.com/mozilla/iris
cd iris
bootstrap\bootstrap.sh

4. Install project requirements and activate the virtualenv.

pipenv install
pipenv shell

5. Run Iris.

iris -k

---

Ubuntu Linux instructions:

1. Open Settings > Displays > "Scale for Menu and Title bars:" and verify that it is set to 1.
2. Close any active applications and file system windows.
3. Launch the terminal and run the following commands. Please note:

• This will install some software as well as make some system changes. If you disagree, the script will allow you to exit.
• This will take around 15 minutes to download, compile, and install dependencies.

cd ~
git clone https://github.com/mozilla/iris
cd iris
./bootstrap/bootstrap.sh

4. Run the following commands to complete installation and launch Iris.

pipenv install
pipenv shell
iris -k

---

Optional: Install Sikuli

If you have never used Sikuli, it is highly encouraged to visit their site, download their tools, and experiment, as the concepts that Sikuli uses have greatly inspired Iris and will help in learning.

---

Optional: PyCharm IDE

You can use any IDE that you are comfortable with, but we recommend PyCharm.