Skip to content

Commit

Permalink
update majove osx build instruction (2600hz#5875)
Browse files Browse the repository at this point in the history
  • Loading branch information
zzzming authored and jamesaimonetti committed Jun 26, 2019
1 parent bfb2314 commit f838034
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 3 deletions.
31 changes: 28 additions & 3 deletions doc/engineering/installing-on-mac.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
# Installing on Mac (for development)

Make sure you have run `xcode-select --install` to install various build tools that are available(such as zlib.
## Prerequisite
These steps are required mostly to build Erlang using Kerl and later build Kazoo. Kerl is recommended although brew can manage multiple Erlang versions.

If macOS version is older than 10.14, Mojave, please make sure you have run `xcode-select --install` to install various build tools that are available(such as zlib).

Some additional dependencies are required to get things up and running on Mac. The easiest way to
install these dependencies is via `brew` so [install brew](https://brew.sh/) if you have not already.

Run the brew install command below to install dependencies:
Make sure these modules are already installed by brew.
```python@2 fop libxslt openssl ncurses expat imagemagick ghostscript htmldoc icu4c```

```$ brew list```
should provide a list of modules already installed.

Brew install any missing modules. This is an example to install the complete list.

```brew install python@2 libxslt openssl ncurses expat imagemagick ghostscript htmldoc```
```brew install python@2 fop libxslt openssl ncurses expat imagemagick ghostscript htmldoc icu4c```

Since macOS 10.14 Mojave does not come with a JDK, or for any needs to upgrade the current Java version to JDK 11 or 12. Openjdk is recommended due to its GNU GPLv2 license. Instructions can be found at [here](https://stackoverflow.com/questions/52524112/how-do-i-install-java-on-mac-osx-allowing-version-switching)

And you can skip installing these (they are included via the Apple command line tools or the brew packages):

Expand Down Expand Up @@ -58,3 +69,17 @@ You will also want to add a symlink for libreoffice somewhere in your path becau
executable name is `soffice` but kazoo expects it to be `libreoffice`. Something like:

```ln -s /usr/local/bin/soffice /usr/local/bin/libreoffice```

## Kerl
We recommend Kerl to manage Erlang versions. Kerl is an Erlang version management tool as rvm for Ruby, nvm for node.js. Please familiarize [these steps](https://github.com/kerl/kerl)

Please make sure `~/.kerlrc` contains this, because macOS has not been keeping up the latest openssl version. We would like to refer to the brew installed version.
``` KERL_CONFIGURE_OPTIONS="--with-ssl=/usr/local/opt/openssl" ```

## Brew installed Erlang
Brew directly installs Erlang version. It's also tested but offers less version options as supposed to Kerl.

You have to use Brew link and unlink to switch between version.

## Build Kazoo
The generic build [instruction](https://github.com/2600hz/kazoo/blob/master/doc/installation.md#longer-version) works on macOS.
1 change: 1 addition & 0 deletions doc/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

This is a guide to building Kazoo from source on a Debian 8 (Jessie) base installation. Other GNU/Linux distros should work similarly, though the dependencies may differ a bit. If you want to just install and use Kazoo (and not build it) try using the [installation instructions](https://docs.2600hz.com/sysadmin/doc/install/install_via_centos7/). The rest of this guide assumes you want to run a development environment for Kazoo.

If your development is on macOS, here are [extra steps](https://github.com/2600hz/kazoo/blob/master/doc/engineering/installing-on-mac.md) for set up.

## Dependencies

Expand Down

0 comments on commit f838034

Please sign in to comment.