deepstream.io is currently under reconstruction for the V4 release!

For V3 and enterprise documentation please go to https://deepstreamhub.com

To continue click here

Installing on OSX

Find out how to get deepstream running on OSX

deepstream is available via brew cask.

The only dependency you need is to install Homebrew, a popular package manager for macOS. If you don’t already have it installed, you can install it via:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

To install deepstream, simply run the command into your terminal

brew cask install deepstream

Resulting in

==> Downloading https://github.com/deepstreamIO/deepstream.io/releases/download/v2.4.0/deepstream.io-mac-2.4.0.pkg
######################################################################## 100.0%
==> Verifying checksum for Cask deepstream
==> Installing Cask deepstream
==> Running installer for deepstream; your password may be necessary.
==> Package installers may write to any location; options such as --appdir are ignored.
Password:
==> installer: Package name is deepstream.io-mac-2.4.0
==> installer: Upgrading at base path /
==> installer: The upgrade was successful.
🍺  deepstream was successfully installed!

Starting deepstream

deepstream can be started via its command line interface.

deepstream start

Starting deepstream on osx

Configuring deepstream

You can either change deepstream’s configuration file directly in /usr/local/etc/deepstream or create a copy and run deepstream with the -c flag. (Important, make sure to update all relative paths within the configuration after copying it).

$ cd ~
$ cp /usr/local/etc/deepstream .
$ ls
config.yml  permissions.yml  users.yml
$ deepstream start -c config.yml

Downloading deepstream’s source code

You can also get the package and sources directly from deepstream’s release page