macOS Installation

This page describes how to install Stardog on macOS.

Page Contents

Prerequisites
Homebrew
What’s Next?

Prerequisites

Before continuing with the installation guide, please review the System Requirements for running Stardog.

Homebrew

To install Stardog via Homebrew, use the following command:
```
 $ brew install stardog-union/tap/stardog
```
Homebrew will take care of the installation for you including adding Stardog’s /bin folder to your PATH so stardog and stardog-admin commands can be used regardless of current working directory.
Setup STARDOG_HOME

The most important piece of configuration to do before you start Stardog is setting the STARDOG_HOME environment variable. This is the directory where all the Stardog databases and other files will be stored. If STARDOG_HOME is not defined, Stardog will use the Java user.dir property value.

Our convention is to set STARDOG_HOME to /var/opt/stardog but this can be any directory. We highly recommend not setting this to the directory where Homebrew installed Stardog to (likely /usr/local/Caskroom/stardog ).

Place the following in your .zsh_profile or whichever file you use to configure your shell.
```
 export STARDOG_HOME=/var/opt/stardog
```
License key

If you do not have a license key

You can obtain a license key by speaking with a Stardog sales representative. If you do not want to manage your own Stardog license, you can simply sign up for a free account with Stardog Cloud.

If you have a license key

Add it to your STARDOG_HOME. Ensure that the stardog-license-key.bin file is readable by the Stardog process.
```
 $ cp stardog-license-key.bin $STARDOG_HOME
```
By default, Stardog will recognize your license key if its name follows the pattern stardog*.bin (i.e., stardog, followed by anything, and ending with .bin) and it resides in your home directory. You can specify a different location for the license file or a name that uses a different pattern by setting the environment variable STARDOG_LICENSE_PATH.

Start up the Stardog server

 $ stardog-admin server start

If the server starts up successfully, you should see an output like this in your terminal:

 ************************************************************
 This copy of Stardog is licensed to Somebody Awesome (somebody.awesome@stardog.com), Stardog
 This is a Enterprise license
 This license does not expire.
 ************************************************************

                                                             :;
                                     ;;                   `;`:
 `'+',    ::                        `++                    `;:`
 +###++,  ,#+                        `++                    .
 ##+.,',  '#+                         ++                     +
 ,##      ####++  ####+:   ##,++` .###+++   .####+    ####++++#
 `##+     ####+'  ##+#++   ###++``###'+++  `###'+++  ###`,++,:
 ####+    ##+        ++.  ##:   ###  `++  ###  `++` ##`  ++:
 ###++,  ##+        ++,  ##`   ##;  `++  ##:   ++; ##,  ++:
     ;+++  ##+    ####++,  ##`   ##:  `++  ##:   ++' ;##'#++
     ;++  ##+   ###  ++,  ##`   ##'  `++  ##;   ++:  ####+
 ,.   +++  ##+   ##:  ++,  ##`   ###  `++  ###  .++  '#;
 ,####++'  +##++ ###+#+++` ##`   :####+++  `####++'  ;####++`
 `####+;    ##++  ###+,++` ##`    ;###:++   `###+;   `###++++
                                                     ##   `++
                                                 .##   ;++
                                                     #####++`
                                                     `;;;.
 ************************************************************


 Stardog server 7.4.0 started on Thu Oct 01 21:12:22 EDT 2020.

 Stardog server is listening on all network interfaces.
 HTTP server available at http://localhost:5820.

 STARDOG_HOME=/var/opt/stardog/

By default, the Stardog server will become available at http://localhost:5820.

If you visit http://localhost:5820 while your Stardog server is running, you will be prompted for credentials and redirected to cloud.stardog.com.

What’s Next?

Get Started with Stardog Cloud, our complete Enterprise Knowledge Graph Platform, and connect to your running Stardog server. If you want to encrypt network traffic when using Stardog, see this guide for setting up SSL.

Check out our additional Getting Started Resources for some introductory blog posts, tutorials, video trainings and more.

Prerequisites
Homebrew
What’s Next?