Splunk® Enterprise

Installation Manual

Download manual as PDF

Download topic as PDF

Install on Mac OS X

You can install Splunk Enterprise on Mac OS X with a DMG package or a tar file.

To install the Splunk universal forwarder, see Install a *nix universal forwarder in the Universal Forwarder manual. The universal forwarder is a separate executable, with its own set of installation procedures.

Upgrading?

If you are upgrading, review "How to upgrade Splunk Enterprise" for instructions and migration considerations before proceeding.

Installation options

The Mac OS installation package comes in two forms: a DMG package and a tar file.

If you require two installations in different locations on the same host, use the tar file. The DMG installer cannot install a second instance. If one exists, it removes that instance upon successful install of the second.

Graphical installation

  1. Double-click on the DMG file. A Finder window containing splunk.pkg opens.
  2. In the Finder window, double-click on splunk.pkg. The installer opens and displays the Introduction, which lists version and copyright information.
  3. Click Continue. The Select a Destination window opens.
  4. Choose a location to install Splunk Enterprise.
    • To install in the default directory, /Applications/splunk, click on the harddrive icon.
    • To select a different location, click Choose Folder...
  5. Click Continue. The pre-installation summary displays. If you need to make changes:
    • Click Change Install Location to choose a new folder, or
    • Click Back to go back a step.
  6. Click Install.
  7. A window appears that prompts you for the credentials you used to log into your Mac. These are not your Splunk Enterprise instance or splunk.com credentials. Type in the password and click OK or Install software.
  8. The installation begins. It might take a few minutes to complete.
  9. When the install completes, click Finish. The installer places a shortcut on the Desktop.

Command line installation

To install Splunk Enterprise on Mac OS X from the command line, you must use the root user, or elevate privileges using the sudo command. If you use sudo, your account must be an Administrator-level account.

  1. To mount the DMG file, run:
    sudo hdid splunk_package_name.dmg
    

    The Finder mounts the disk image onto the desktop. The image is available under /Volumes/SplunkForwarder <version> (note the space).

  2. To Install the software:
    • To the root volume:
    cd /Volumes/SplunkForwarder\ <version>
    sudo installer -pkg .payload/splunk.pkg -target /
    

    There is a space in the disk image name. Use a backslash to escape the space or wrap the disk image name in quotes.

    • To a different disk of partition:
    cd /Volumes/SplunkForwarder\ <version>
    sudo installer -pkg .payload/splunk.pkg -target /Volumes\ Disk
    

    There is a space in the disk image name. Use a backslash to escape the space or wrap the disk image name in quotes.

    -target specifies a target volume, such as another disk, where Splunk will be installed in /Applications/splunk.

To install into a directory other than /Applications/splunk on any volume, see the graphical installation instructions.

tar file install

The tar file is a manual form of installation. When you install Splunk Enterprise with a tar file:

  • Splunk Enterprise does not create the splunk user automatically. If you want it to run as a specific user, you must create the user manually before installing.
  • Ensure that the disk partition has enough space to hold the uncompressed volume of the data you plan to keep indexed.

To install Splunk Enterprise on Mac OS X, expand the tar file into an appropriate directory using the tar command:

tar xvzf splunk_package_name.tgz

The default install directory is splunk in the current working directory. To install into /Applications/splunk, use the following command:

tar xvzf splunk_package_name.tgz -C /Applications

Next steps

Now that you have installed Splunk Enterprise:

Uninstall Splunk Enterprise

To learn how to uninstall Splunk Enterprise, see Uninstall Splunk Enterprise in this manual.

PREVIOUS
Install on Solaris
  NEXT
Install the universal forwarder on FreeBSD

This documentation applies to the following versions of Splunk® Enterprise: 6.4.0, 6.4.1, 6.4.2, 6.4.3, 6.4.4, 6.4.5, 6.4.6, 6.4.7, 6.4.8, 6.4.9, 6.4.10, 6.5.0, 6.5.1, 6.5.1612 (Splunk Cloud only), 6.5.2, 6.5.3, 6.5.4, 6.5.5, 6.5.6, 6.5.7, 6.5.8, 6.5.9, 6.6.0, 6.6.1, 6.6.2, 6.6.3, 6.6.4, 6.6.5, 6.6.6, 6.6.7, 6.6.8, 6.6.9, 6.6.10, 6.6.11, 7.0.0, 7.0.1, 7.0.2, 7.0.3, 7.0.4, 7.0.5, 7.0.6, 7.0.7, 7.0.8, 7.1.0, 7.1.1, 7.1.2, 7.1.3, 7.1.4, 7.1.5, 7.2.0, 7.2.1


Comments

Hi Max/Buntar29,

I presume that you mean macOS 10.13.2. We couldn't give support on an OS that existed at the same time as our founding. :)

Anyway, Splunk Enterprise is not officially supported on macOS 10.13. Splunk Free, Trial, and Universal Forwarder are. The error that you're getting means that the file system check, which is important for indexing operations, is failing. There is a workaround for it (see https://answers.splunk.com/answers/306998/why-am-i-getting-homepathoptsplunkvarlibsplunkaudi.html?childToView=578312#answer-578312) but you perform that workaround at your own risk; making this change could result in the loss of any data that you index. If it's feasible for you, the better option would be to switch the default filesystem on your Mac back to HFS+.

There is work to get APFS supported as a filesystem, but I couldn't promise a timeframe for such an update. My apologies for any inconvenience caused.

Malmoore, Splunker
January 9, 2018

Dear Developers,

I have a problem concerning the launch of the Splunk application on my machine. My system is MacOS 10.3.2. Actually, the following lines are written in the terminal:
"homePath='/Applications/Splunk/var/lib/splunk/audit/db' of index=_audit on unusable filesystem.
Validating databases (splunkd validatedb) failed with code '1'. If you cannot resolve the issue(s) above after consulting documentation, please file a case online at http://www.splunk.com/page/submit_issue".
I'm looking forward to your answer,

Max

Buntar29
January 9, 2018

Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters