Install on Mac OS X

This tutorial assumes that you have already downloaded the latest version of the MacOS installer and explains how to to install Neubot on MacOS X >= 10.6 (Snow Leopard). The installer will install Neubot as a system daemon that will be started automatically at boot by launchd(8). For more on the installer, please refer to the documentation.

In this page we assume that you have downloaded Neubot 0.4.1, but these instructions will also apply to subsequent stable releases.


Install instructions

Double click on the downloaded file neubot-0.4.1.pkg.tgz to decompress it.

Install MacOS

Now double click on the installer, neubot-0.4.1.pkg.

Install MacOS

A popup window will open, click on Continue.

Install MacOS

The installer welcome screen will appear, click on Continue.

Install MacOS

The license screen will appear, click on Continue.

Install MacOS

A popup will appear, click on Agree to accept the terms of the license.

Install MacOS

The privacy screen will appear, displaying the privacy policy. Read on the policy and decide whether you want to provide Neubot the permission to share and publish your Internet address. If you don't provide both, Neubot cannot work and the installation will not continue. See FAQ 5. for an explanation of why Neubot needs both permissions.

Install MacOS

The select-disk screen will appear. Click on Continue to proceed: you cannot change the disk where to install because Neubot must reside on the root partition.

Install MacOS

The before-install summary screen will appear, click on Continue.

Install MacOS

The installer will ask the permission to install Neubot on the disk. Type your password and click Ok to authorize it.

Install MacOS

Neubot will be installed and, at the end, you will see a screen like this:

Install MacOS

Neubot is installed as a system daemon and is started automatically at boot by launchd(8). In the Applications folder you find the Neubot application that opens the web interface to control the daemon and view recent results.

Install MacOS

If something goes wrong...

If something goes wrong, please let me know. I need to know at least the version of your MacOS, and the version of Python installed. And send me the logs. In these section we'll see how to do these three steps.

Open Finder, select Applications, and then Utilities.

Install MacOS

Inside Utilities, there are the Console...

Install MacOS

... and the Terminal.

Install MacOS

Let's start with the Terminal. Open it and type the following commands:

  1. sw_vers (and then hit Enter);
  2. which python (and then hit Enter);
  3. python -V (and then hit Enter).

The first command prints your MacOS X version. The second command prints the location where Python is installed. And the third command prints Python version.

Install MacOS

Then open the Console. Type neubot into the search box, in order to filter out uninteresting log messages. Then send me the content of the window.

Install MacOS

Or you can read the logs directly from the terminal with the following command:

  • sudo grep neubot /var/log/system.log (and then hit Enter);

Install MacOS

To save the result to a file — instead of displaying it on screen — the complete command is:

  • sudo grep neubot /var/log/system.log > neubot.log (and then hit Enter);

Thanks for your cooperation!


Uninstall instructions

A script exists that allows to uninstall Neubot. The name of the script is uninstall.sh and it is located below /usr/local/share/neubot. In particular, since Neubot 0.4.9, /usr/local/share/neubot should contain only two files (org.neubot.plist and start.sh) and one directory. The directory name is the version number of Neubot, expressed in numeric representation, where 0.4.10-rc2 becomes 0.004010002 and 0.4.10 becomes 0.004010999. The uninstall.sh script is inside this directory, as shown by the following screenshot. You should run the script as root (as shown below) and you can safely ignore warnings about directories that cannot be removed.

Install MacOS