keejef
/
session-ios
mirror of https://github.com/oxen-io/session-ios
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
dev
master
voice-calls-2
voice-calls
authentication
2.5.0
2.4.5
2.4.4
2.4.3
2.4.2
2.4.1
2.4.0
2.3.2
2.3.1
2.3.0
2.2.14
2.2.13
2.2.12
2.2.11
2.2.10
2.2.9
2.2.6
2.2.4
2.2.2
2.2.1
2.2.0
2.1.1
2.0.3
2.0.2
2.0.1
2.0.0
1.0.0-alpha.1
audit-2
audit
2.6.2
2.6.1
2.6.0
2.2.8
2.2.7
2.2.5
2.2.3
2.1.0
1.9.7
1.9.6
1.9.5
1.9.4
1.9.3
1.9.1
1.9.0
1.8.3
1.8.2
1.8.1
1.8.0
1.7.8
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.0
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.5.3
1.5.2
1.5.1-beta
1.5.0-beta
1.5.0
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.0-beta
1.4.0
1.3.0-alpha.1
1.3.0
1.2.6
1.2.5
1.2.4
1.2.3
1.2.1
1.2.0-alpha.2
1.2.0-alpha.1
1.2.0
1.13.0
1.12.9
1.12.8
1.12.7
1.12.6
1.12.5
1.12.4
1.12.2
1.12.1
1.11.9
1.11.8
1.11.7
1.11.6
1.11.5
1.11.4
1.11.3
1.11.24
1.11.23
1.11.22
1.11.21
1.11.20
1.11.2
1.11.19
1.11.18
1.11.17
1.11.16
1.11.15
1.11.14
1.11.13
1.11.12
1.11.11
1.11.10
1.11.1
1.11.0
1.10.2
1.10.1
1.10.0
1.1.0-alpha.4
1.1.0-alpha.3
1.1.0-alpha.2
1.1.0-alpha.1
1.1.0
1.0.8
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0-alpha.3
1.0.0-alpha.2
1.0.0
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'de41f5adca'
${ noResults }
session-ios/BUILDING.md

2.9 KiB
Raw Blame History

Building

We typically develop against the latest stable version of Xcode.

As of this writing, that's Xcode 12.4

Prerequistes

Install CocoaPods.

1. Clone

Clone the repo to a working directory:

git clone https://github.com/oxen-io/session-ios.git

Recommendation:

We recommend you fork the repo on GitHub, then clone your fork:

git clone https://github.com/<USERNAME>/session-ios.git

You can then add the Session repo to sync with upstream changes:

git remote add upstream https://github.com/oxen-io/session-ios

2. Submodules

Session requires a number of submodules to build, these can be retrieved by navigating to the project directory and running:

git submodule update --init --recursive

3. Pods

To build and configure the libraries Session uses, just run:

pod install

4. libSession build dependencies

The iOS project has a share C++ library called libSession which is built as one of the project dependencies, in order for this to compile the following dependencies need to be installed:

  • cmake
  • m4
  • pkg-config

These can be installed with Homebrew via brew install cmake m4 pkg-config

Additionally xcode-select needs to be setup correctly (depending on the order of installation it can point to the wrong directory and result in a build error similar to tool '{name}' requires Xcode, but active developer directory '/Library/Developer/CommandLineTools' is a command line tools instance), this can be setup correctly by running:

sudo xcode-select -s /Applications/Xcode.app/Contents/Developer

5. Xcode

Open the Session.xcworkspace in Xcode.

open Session.xcworkspace

In the TARGETS area of the General tab, change the Team dropdown to your own. You will need to do that for all the listed targets, e.g. Session, SessionShareExtension, and SessionNotificationServiceExtension. You will need an Apple Developer account for this.

On the Capabilities tab, turn off Push Notifications and Data Protection, while keeping Background Modes on. The App Groups capability will need to remain on in order to access the shared data storage.

Build and Run and you are ready to go!

Known issues

Third-party Installation

The database for the app is stored within an App Group directory which is based on the app identifier, unfortunately the identifier cannot be retrieved at runtime so it's currently hard-coded in the code. In order to be able to run session on a device you will need to update the UserDefaults.applicationGroup variable in SessionUtilitiesKit/General/SNUserDefaults to match the value provided (You may also need to create the App Group on your Apple Developer account).

Push Notifications

Features related to push notifications are known to be not working for third-party contributors since Apple's Push Notification service pushes will only work with the Session production code signing certificate.