Installation Manual

Install on Linux

You can install Splunk Enterprise on Linux using RPM or DEB packages or a tar file.

Note: To install the Splunk universal forwarder, see "Universal forwarder deployment overview" in the Forwarding Data manual. The universal forwarder is a separate executable, with its own set of installation procedures.

Upgrading?

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

Tar file installation

To install Splunk Enterprise on a Linux system, expand the tar file into an appropriate directory using the tar command:

tar xvzf splunk_package_name.tgz

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

tar xvzf splunk_package_name.tgz -C /opt

Note: When you install Splunk Enterprise with a tar file:

• Some non-GNU versions of tar might not have the -C argument available. In this case, to install in /opt/splunk, either cd to /opt or place the tar file in /opt before you run the tar command. This method works for any accessible directory on your machine's file system.
• Splunk Enterprise does not create the splunk user. If you want Splunk Enterprise to run as a specific user, you must create the user manually before you install.
• Ensure that the disk partition has enough space to hold the uncompressed volume of the data you plan to keep indexed.

RedHat RPM install

Ensure that the splunk build rpm package you want is available locally on the target server. Verify that the file is readable and executable by the the Splunk user. If needed change access:

 
chmod 744 splunk_package_name.rpm

To install the Splunk RPM in the default directory /opt/splunk:

rpm -i splunk_package_name.rpm

To install Splunk in a different directory, use the --prefix flag:

rpm -i --prefix=/opt/new_directory splunk_package_name.rpm

Note: Installing with rpm in a non-default directory is not recommended, as RPM offers no safety net at upgrade time. If the --prefix argument does not agree, then upgrade problems can occur.

To upgrade an existing Splunk Enterprise installation that resides in /opt/splunk using the RPM:

rpm -U splunk_package_name.rpm

Note: Upgrading rpms is upgrading the rpm package, not upgrading Splunk Enterprise. rpm upgrades can be done only when using the rpm in the past. There is no smooth transition from tar installs to rpm installs. This is not a Splunk Enterprise issue, but a fundamental packaging issue.

To upgrade an existing Splunk Enterprise installation that was done in a different directory, use the --prefix flag:

rpm -U --prefix=/opt/existing_directory splunk_package_name.rpm

Note: If you do not specify with --prefix for your existing directory, rpm will install in the default location of /opt/splunk.

For example, to upgrade to the existing directory of $SPLUNK_HOME=/opt/apps/splunk enter the following:

rpm -U --prefix=/opt/apps splunk_package_name.rpm

To Replace an existing Splunk Enterprise installation

rpm -i --replacepkgs --prefix=/splunkdirectory/ splunk_package_name.rpm

If you want to automate your RPM install with kickstart, add the following to your kickstart file:

./splunk start --accept-license
./splunk enable boot-start 

Note: The second line is optional for the kickstart file.

Enable Splunk Enterprise to start the system at boot by adding it to /etc/init.d/ Run this command as root or sudo and specify the user that Splunk Enterprise should run as.

./splunk enable boot-start -user splunkuser

Debian DEB install

You can install the Splunk DEB package only in the default location, /opt/splunk. This location must be a regular directory, and not a symbolic link. If you need to install Splunk somewhere else, or if you use a symbolic link for /opt/splunk, use a tar file to install the software.

To install the Splunk DEB package:

dpkg -i splunk_package_name.deb

What gets installed

Splunk package status:

dpkg --status splunk

List all packages:

dpkg --list

Default shell

Splunk Enterprise assumes you are using the bash shell.

Using the dash shell can result in zombie processes.

Start Splunk

Splunk Enterprise can run as any user on the local system. If you run it as a non-root user, make sure that it has the appropriate permissions to read the inputs that you specify. Refer to the instructions for running Splunk Enterprise as a non-root user.

To start Splunk Enterprise from the command-line interface, run the following command from $SPLUNK_HOME/bin directory, where $SPLUNK_HOME is the directory into which you installed Splunk Enterprise:

 ./splunk start

By convention, this document uses:

• $SPLUNK_HOME to identify the path to your Splunk Enterprise installation.
• $SPLUNK_HOME/bin/ to indicate the location of the command-line interface.

Startup options

The first time you start Splunk Enterprise after a new installation, you must accept the license agreement. To start Splunk Enterprise and accept the license in one step:

 $SPLUNK_HOME/bin/splunk start --accept-license

Note: There are two dashes before the accept-license option.

Launch Splunk Web and log in

After you start Splunk Enterprise and accept the license agreement, you can launch Splunk Web.

1. In a browser window, access Splunk Web at http://<hostname>:port.

• hostname is the host machine.
• port is the port you specified during the installation (the default port is 8000).

Note Navigate to HTTP the first time you access Splunk Enterprise.

2. Splunk Web prompts you for login information before it launches. The default is user name admin and password changeme. If you switch to Splunk Free, you bypass this logon page in future sessions.

What's next?

Now that you've installed Splunk Enterprise, what comes next?

Uninstall Splunk Enterprise

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