Add iOS docs to the dev docs

Imports old dev docs Also adds my currently open PR #10 on the docs to improve them.
2023-02-12 21:08:37 -05:00 · 2023-02-12 21:08:37 -05:00 · 8bde80a3d2
parent aea8a6d04b
commit 8bde80a3d2
1 changed files with 75 additions and 2 deletions
--- a/docs/develop.md
+++ b/docs/develop.md
@ -327,7 +327,80 @@ To build your own version with Firebase, you must:
 ```

 ## iOS app
-The ntfy iOS app source code is available [on GitHub](https://github.com/binwiederhier/ntfy-ios).
+
+## Requirements
+!!! note 
+    These requirements are strictly based off of my development on this app. There may be other versions of macOS / XCode that work. Feel free to test on other versions!
+
+1. macOS Monterey or later
+1. XCode 13.2+
+1. A physical iOS device (for push notifications, I could not get them to work in the XCode simulator)
+1. The [macOS development branch for ntfy](https://github.com/Copephobia/ntfy/tree/macos-development) (for APNS configuration)
+1. Firebase account
+1. Apple Developer license? (I forget if its possible to do testing without purchasing the license)
+
+## Setup - Apple Developer/iOS Instant Notification Setup

 !!! info
-    I haven't had time to move the build instructions here. Please check out the repository instead.
+    Along with this step, the "Setup - PLIST Deployment and Configuration" step is also required for these changes to take effect in the iOS app.
+
+1. [Create a new key in Apple Developer Member Center](https://developer.apple.com/account/resources/authkeys/add)
+  1. Select "Apple Push Notifications service (APNs)"
+1. Download the newly created key (should have a file name similar to `AuthKey_ZZZZZZ.p8`, where `ZZZZZZ` is the **Key ID**)
+1. Record your **Team ID** - it can be seen in the top-right corner of the page, or on your Account > Membership page
+1. Next, navigate to "Project Settings" in the firebase console for your project, and select the iOS app you created. Then, click "Cloud Messaging" in the left sidebar, and scroll down to the "APNs Authentication Key" section. Click "Upload Key", and upload the key you downloaded from Apple Developer.
+
+!!! warning  
+    If you don't do the above setups for APNS, **notifications will not post instantly or sometimes at all**. This is because of the missing APNS key, which is required for firebase to send notifications to the iOS app. See below for a snip from the firebase docs.
+
+> If you don't have an APNs authentication key, you can still send notifications to iOS devices, but they won't be delivered instantly. Instead, they'll be delivered when the device wakes up to check for new notifications or when your application sends a firebase request to check for them. The time to check for new notifications can vary from a few seconds to hours, days or even weeks. Enabling APNs authentication keys ensures that notifications are delivered instantly and is strongly recommended.
+
+## Setup - Firebase
+
+1. If you haven't already, create a Google / Firebase account
+1. Visit the [Firebase console](https://console.firebase.google.com)
+1. Create a new Firebase project:
+  1. Enter a project name
+  1. Disable Google Analytics (currently iOS app does not support analytics)
+1. On the "Project settings" page, add an iOS app
+  1. Apple bundle ID - "com.copephobia.ntfy-ios" (this can be changed to match XCode's ntfy.sh target > "Bundle Identifier" value)
+  1. Register the app
+  1. Download the config file - GoogleInfo.plist (this will need to be included in the ntfy-ios repository / XCode)
+1. Generate a new service account private key for the ntfy server
+  1. Go to "Project settings" > "Service accounts"
+  1. Click "Generate new private key" to generate and download a private key to use for sending messages via the ntfy server
+
+## Setup - ntfy server
+
+1. Checkout the [macOS development branch for ntfy](https://github.com/Copephobia/ntfy/tree/macos-development)
+1. If not already made, make the `/etc/ntfy/` directory and move the service account private key to that folder
+1. Copy the `server/server.yml` file from the ntfy repository to `/etc/ntfy/`
+1. Modify the `/etc/ntfy/server.yml` file `firebase-key-file` value to the path of the private key
+1. Install go: `brew install go`
+1. In the ntfy repository, run `make build-simple`
+
+## Setup - XCode
+
+1. Follow step 4 of [https://firebase.google.com/docs/ios/setup](Add Firebase to your Apple project) to install the firebase-ios-sdk in XCode, if it's not already present - you can select any packages in addition to Firebase Core / Firebase Messaging
+1. Similarly, install the SQLite.swift package dependency in XCode
+1. When running the debug build, ensure XCode is pointed to the connected iOS device - registering for push notifications does not work in the iOS simulators
+
+## Setup - PLIST Deployment and Configuration
+To have intstant notifications/better notification delivery when using firebase, you will need to add the `GoogleService-Info.plist` file to your project. Here's how to do that:
+
+1. In XCode, find the NTFY app target. **Not** the NSE app target.
+1. Find the Asset/ folder in the project navigator
+1. Drag the `GoogleService-Info.plist` file into the Asset/ folder that you get from the firebase console. It can be found in the "Project settings" > "General" > "Your apps"  with a button labled "GoogleService-Info.plist"
+
+After that, you should be all set!
+
+## Useful resources
+
+- https://www.raywenderlich.com/14958063-modern-efficient-core-data
+- https://www.hackingwithswift.com/books/ios-swiftui/how-to-combine-core-data-and-swiftui
+- https://stackoverflow.com/a/41783666/1440785
+- https://stackoverflow.com/questions/47374903/viewing-core-data-data-from-your-app-on-a-device
+- https://debashishdas3100.medium.com/save-push-notifications-to-coredata-userdefaults-ios-swift-5-ea074390b57
+- https://cocoacasts.com/cocoa-fundamentals-how-to-access-builds-settings-in-swifti
+- https://www.hackingwithswift.com/articles/216/complete-guide-to-navigationview-in-swiftui
+- https://stackoverflow.com/a/70731861/1440785