forked from acouzens/open5gs
172 lines
4.8 KiB
Markdown
172 lines
4.8 KiB
Markdown
---
|
|
title: Mac OS X
|
|
head_inline: "<style> .blue { color: blue; } </style>"
|
|
---
|
|
|
|
This guide is based on macOS Big Sur 11.2 on a Macbook Pro(Intel Chips) computer.
|
|
{: .blue}
|
|
|
|
### Install Xcode Command-Line Tools
|
|
---
|
|
|
|
Homebrew requires the Xcode command-line tools from Apple's Xcode.
|
|
```bash
|
|
$ xcode-select --install
|
|
```
|
|
|
|
### Installing Homebrew
|
|
---
|
|
|
|
Install brew using the official Homebrew installation instructions.
|
|
```bash
|
|
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
|
|
```
|
|
|
|
### Getting MongoDB
|
|
---
|
|
|
|
Install MongoDB with Package Manager.
|
|
```bash
|
|
$ brew tap mongodb/brew
|
|
$ brew install mongodb-community
|
|
```
|
|
|
|
Run MongoDB server.
|
|
```bash
|
|
$ mongod --config /usr/local/etc/mongod.conf
|
|
```
|
|
|
|
**Tip:** MongoDB is persistent after rebooting with the following commands:
|
|
`$ brew services start mongodb-community`
|
|
{: .notice--info}
|
|
|
|
|
|
### Setting up network (No persistent after rebooting)
|
|
---
|
|
|
|
Note that Open5GS uses built-in "utun" device driver. So, You don't have to install external TUN/TAP driver.
|
|
{: .blue}
|
|
|
|
Configure the loopback interface.
|
|
```bash
|
|
$ sudo ifconfig lo0 alias 127.0.0.2 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.3 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.4 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.5 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.5 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.6 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.7 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.8 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.9 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.10 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.11 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.12 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.13 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.14 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.15 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.16 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.17 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.18 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.19 netmask 255.255.255.255
|
|
$ sudo ifconfig lo0 alias 127.0.0.20 netmask 255.255.255.255
|
|
```
|
|
|
|
Enable IP forwarding & Masquerading
|
|
```bash
|
|
$ sudo sysctl -w net.inet.ip.forwarding=1
|
|
$ sudo sysctl -w net.inet6.ip6.forwarding=1
|
|
$ sudo sh -c "echo 'nat on {en0} from 10.45.0.0/16 to any -> {en0}' > /etc/pf.anchors/org.open5gs"
|
|
$ sudo sh -c "echo 'nat on {en0} from 2001:db8:cafe::1/48 to any -> {en0}' > /etc/pf.anchors/org.open5gs"
|
|
$ sudo pfctl -e -f /etc/pf.anchors/org.open5gs
|
|
```
|
|
|
|
**Tip:** The script provided in [$GIT_REPO/misc/netconf.sh](https://github.com/{{ site.github_username }}/open5gs/blob/main/misc/netconf.sh) makes it easy to configure the TUN device as follows:
|
|
`$ sudo ./misc/netconf.sh`
|
|
{: .notice--info}
|
|
|
|
### Building Open5GS
|
|
---
|
|
|
|
Install the depedencies for building the source code.
|
|
```bash
|
|
$ brew install mongo-c-driver gnutls libgcrypt libidn libyaml libmicrohttpd nghttp2 pkg-config libusrsctp libtins talloc
|
|
```
|
|
|
|
Install Bison and Create soft link.
|
|
```bash
|
|
$ brew install bison
|
|
$ export PATH="/usr/local/opt/bison/bin:$PATH"
|
|
```
|
|
|
|
Install Meson using Homebrew.
|
|
```bash
|
|
$ brew install meson
|
|
```
|
|
|
|
Git clone.
|
|
|
|
```bash
|
|
$ git clone https://github.com/{{ site.github_username }}/open5gs
|
|
```
|
|
|
|
To compile with meson:
|
|
|
|
```bash
|
|
$ cd open5gs
|
|
$ meson build --prefix=`pwd`/install
|
|
$ ninja -C build
|
|
```
|
|
|
|
Check whether the compilation is correct.
|
|
|
|
**Note:** This should require *sudo* due to access `/dev/tun0`.
|
|
{: .notice--danger}
|
|
|
|
```bash
|
|
$ sudo ./build/tests/attach/attach ## EPC Only
|
|
$ sudo ./build/tests/registration/registration ## 5G Core Only
|
|
```
|
|
|
|
Run all test programs as below.
|
|
|
|
**Note:** This should require *sudo* due to access `/dev/tun0`.
|
|
{: .notice--danger}
|
|
|
|
```bash
|
|
$ cd build
|
|
$ sudo meson test -v
|
|
```
|
|
|
|
**Tip:** You can also check the result of `ninja -C build test` with a tool that captures packets. If you are running `wireshark`, select the `loopback` interface and set FILTER to `s1ap || gtpv2 || pfcp || diameter || gtp || ngap || http2.data.data || http2.headers`. You can see the virtually created packets. [testattach.pcapng]({{ site.url }}{{ site.baseurl }}/assets/pcapng/testattach.pcapng)/[testregistration.pcapng]({{ site.url }}{{ site.baseurl }}/assets/pcapng/testregistration.pcapng)
|
|
{: .notice--info}
|
|
|
|
You need to perform the **installation process**.
|
|
```bash
|
|
$ cd build
|
|
$ ninja install
|
|
$ cd ../
|
|
```
|
|
|
|
|
|
### Building WebUI of Open5GS
|
|
---
|
|
|
|
[Node.js](https://nodejs.org/) is required to build WebUI of Open5GS
|
|
|
|
```bash
|
|
$ brew install node
|
|
```
|
|
|
|
Install the dependencies to run WebUI
|
|
|
|
```bash
|
|
$ cd webui
|
|
$ npm ci --no-optional
|
|
```
|
|
|
|
The WebUI runs as an [npm](https://www.npmjs.com/) script.
|
|
|
|
```bash
|
|
$ npm run dev
|
|
```
|