Installation OsiScraper

Current version / Release date

1.0.0 / 2021-06-07

Supported platforms

Windows 10, MacOS 11, Linux (.deb, tested on Ubuntu 20.x and Debian GNU Linux 10)

Downloading OsiScraper

Please register at https://license.osiscraper.com.

After registration via the website, click the button Download (or navigate directly to https://license.osiscraper.com/get-osiscraper/) and follow the instructions to download OsiScraper for your platform.

IMPORTANT: Please use only the official OsiScraper distribution downloaded via the OsiScraper website (https://www.osiscraper.com, https://license.osiscraper.com/get-osiscraper/) and verify the SHA number (the SHA256 checksum, published on our website and via our official social media channels) of the downloaded file.
When downloading and using OsiScraper from any other source, you are at risk of downloading malicious software, viruses, or exploitative code with added undeclared functions that could compromise your privacy and your data. We take no responsibility for any consequences of installing and using copies of OsiScraper obtained via any alternative source.

Verifying SHA number of the downloaded file

SHA (Secure Hash Algorithm) is a cryptographic hash function mapping data (such as those in a downloaded file) to a string of letters and digits. Even the smallest change in the original data results in a substantial change of its SHA number. Therefore, SHA numbers can be used to certificate files and ensure their integrity.

Please follow the steps given below to verify that the SHA number of the downloaded file matches the SHA number of the installer for your platform, shown on the official download website (https://license.osiscraper.com/get-osiscraper/).

Linux:
In terminal, use command
sha256sum /path/to/the/downloaded/file
For example,
sha256sum ~/Downloads/osiscraper_1.0.0.deb

Mac:
In terminal, use command
shasum -a 256 /path/to/the/downloaded/file
For example,
shasum -a 256 ~/Downloads/OsiScraper.dmg

Windows:
In terminal, use command
CertUtil -hashfile /path/to/the/downloaded/file SHA256
For example,
CertUtil -hashfile %USERPROFILE%\Downloads\osiscraper_setup.exe SHA256

Installing OsiScraper

Please follow the instructions given at download (https://license.osiscraper.com/get-osiscraper/) to install OsiScraper.

IMPORTANT: We recommend to install OsiScraper only for the current user (e.g., ‘Install for me only’). An installation for all users can result in various permission issues that may be difficult to solve.

Getting licensed

You need to have valid license files (i.e., a license and the respective signature) to be able to use OsiScraper. The license files can be obtained upon registration via https://license.osiscraper.com.

If you haven’t got your license yet, please visit https://license.osiscraper.com to register and download your license and signature.

Starting OsiScraper and license verification

On the very first start, OsiScraper creates its default directory structure in /Documents/Scraper Files. If OsiScraper cannot find your license files or if the files are not valid, a window indicating the problem will appear:
Detected problem: License or signature not found, Detected problem: Invalid license file or signature, or Detected problem: License expired.

Click the button I have a valid license.

get-license

In the next window, click the button Browse and navigate to the directory containing both license files you have downloaded. Their filenames are similar to license__I9NSXBQDLV__ArthurDent__2021-07-01 and signature__I9NSXBQDLV__ArthurDent__2021-07-01.
Select one of these files. OsiScraper will automatically copy both license files to the directory /Documents/Scraper Files/Settings/Credentials/Keys.

On each start, OsiScraper checks the integrity of the license file using the respective signature. Subsequently, the validity of the license is verified against a license database. This is usually a quick and smooth process that takes just a fraction of a second. For a couple of seconds, a welcome window is shown, followed by the OsiScraper’s main window.

Problems with license verification?

If OsiScraper is unable to verify your license, the following window will be shown.

Possible causes and solutions:
Check your Internet connection.
OsiScraper’s connection to the license database may be blocked by your firewall. Please check your firewall settings and open port 3306 to allow the connection to the license server. If needed, grant access specifically to 136.144.215.184
Check your antivirus settings. Whitelist OsiScraper if necessary.

Starting browser

OsiScraper makes use of Google Chrome and ChromeDriver.
– Google Chrome is a web browser, used by OsiScraper to display websites, to access the respective data and to visualise the (to-be-)scraped content.

– ChromeDriver is a webdriver, a tool used by OsiScraper to control the browser and to communicate with it.

In OsiScraper, click the button Start Browser.

If you have installed Google Chrome and the respective ChromeDriver, Google Chrome will start now.

If Google Chrome is not yet installed, this message will be shown:

followed by:

Installing Google Chrome

Click the button Download Google Chrome. In your default browser, the website https://www.google.com/chrome/ will open. Here you can download the newest version of Google Chrome for your platform.

Mac: Open the downloaded googlechrome.dmg. Drag and drop Chrome to the Applications folder.

Windows: Double-click the downloaded ChromeSetup.exe to install Chrome.

Linux: The downloaded file’s name depends on your Linux distribution and the computer’s architecture (e.g., google-chrome-stable_current_amd64.deb).
Using a graphical installer: Navigate in it to the downloaded file, double-click the downloaded file and follow the installer’s instructions.
From terminal: In terminal, navigate to the directory with the downloaded file (e.g., cd ~/Downloads). Run command
sudo dpkg –install /path/to/the/downloaded/file
For example,
sudo dpkg –install ~/Downloads/google-chrome-stable_current_amd64.deb

After installing Google Chrome, return to OsiScraper and click the button Return to the main window. In the main window, click the button Start Browser again and OsiScraper will try to download and install ChromeDriver automatically.

Installing ChromeDriver

OsiScraper needs to start ChromeDriver which, subsequently, starts and drives Google Chrome.

If ChromeDriver is not yet installed or the installed version is incompatible with the current version of Google Chrome, OsiScraper is mostly able to identify the installed version of Google Chrome and automatically download and install the respective version of ChromeDriver. In this case, the following window will be shown (Google Chrome version may differ):

The problem is solved, you can click the button Return to the main window and click Start Browser to open Google Chrome.

If Google Chrome is installed in a non-standard directory, if you have an old version of Google Chrome or when using a virtual machine (VM), OsiScraper may not be able to retrieve the version of Google Chrome automatically. In such a case, you will have to download and install ChromeDriver yourself.
Click the button Download ChromeDriver. In your browser, the website https://chromedriver.chromium.org/downloads will open. From this site, please download and extract the corresponding version of ChromeDriver to /Documents/Scraper Files/Settings/Credentials.

IMPORTANT:
Please notice that some versions of ChromeDriver in Windows open a window similar to the one shown below, to log information and warnings. Feel free to minimise this window or let it behind other windows but PLEASE DON’T CLOSE THIS WINDOW. If the window is closed while ChromeDriver is running, the ChromeDriver may crash and the connection between OsiScraper and Google Chrome will be broken. The window will be closed automatically when the browser is closed.