Skip to content

Commit d347637

Browse files
authored
Minor fixes (#12)
* docs: Grammer & clarify sections * fix: Setup Script wasn't installing debs * style: consistent shebangs * docs: Need this ssh key as well to automate
1 parent cdeb025 commit d347637

File tree

4 files changed

+33
-31
lines changed

4 files changed

+33
-31
lines changed

README.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22

33
> :construction_worker: :hammer: **Work in progress** :construction: :vertical_traffic_light:
44
5-
A monitor solution for jailbroken iOS devices. The core goal of this project is to make sure a specific iOS application is constantly running without needed to use Single App Mode (SAM) or Guided Access Mode (GAM).
5+
dmon is a monitor solution for jailbroken iOS devices. This project's core goal is to ensure a specific iOS application is constantly running without needing to use Single App Mode (SAM) or Guided Access Mode (GAM).
66

7-
A script, `./bin/setup`, is included to help with initial configuration of a jailbroken device.
7+
A script is included to help with the initial configuration of a jailbroken device: `./bin/setup`
88

99
## Table of Contents
1010

1111
- [Prerequisites](#prerequisites)
1212
- [Getting started](#getting-started)
1313
- [Testing](#testing)
1414
- [Commonly asked questions](#commonly-asked-questions)
15-
- [Why didnt you use theos to build the deb](#why-didnt-you-use-theos-to-build-the-deb)
15+
- [Why didn't you use Theos to build the deb](#why-didnt-you-use-theos-to-build-the-deb)
1616
- [How do I stop it?](#how-can-i-stop-it)
17-
- [How do I setup the webserver?](#how-do-i-setup-the-webserver)
18-
- [Why did you reuse the existing `config.json`](#why-did-you-reuse-the-existing-configjson)
17+
- [How do I set up the webserver?](#how-do-i-setup-the-webserver)
18+
- [Why did you reuse the existing `config.json`?](#why-did-you-reuse-the-existing-configjson)
1919
- [Why didn't you include the debs I need](#why-didnt-you-include-the-debs-i-need)
2020
- [Why is my https url not working?](#why-is-my-https-url-not-working)
2121
- [References](#references)
@@ -27,15 +27,17 @@ A script, `./bin/setup`, is included to help with initial configuration of a jai
2727
- Apple Command Line Tools (`xcode-select --install`)
2828
- imobiledevice tools (`brew install libimobiledevice`)
2929
- Optional but **highly recommend** creating a ssh keypair
30-
- Setup your ssh config entry. This makes your life much easier as ssh sessions can be remembered.
30+
- Setup your ssh config entry. Life is much easier when your ssh sessions are remembered.
3131

3232
```sh
3333
cat ~/.ssh/config
34-
Host iphone
34+
Host iphone localhost
3535
HostName localhost
3636
User root
3737
Port 2222
3838
StrictHostKeyChecking no
39+
UserKnownHostsFile=/dev/null
40+
#IdentityFile ~/.ssh/main.pub
3941

4042
Host *
4143
ControlMaster auto
@@ -45,7 +47,7 @@ A script, `./bin/setup`, is included to help with initial configuration of a jai
4547

4648
## Getting started
4749

48-
It is assumed you know your way around a command line. All commands are run on your computer connected to a single iOS device. While it is possible to do some of this manually on a jailbroken iOS device that is pron to human error.
50+
It is assumed you know your way around a command line. Commands are ran on your computer connected to a single iOS device.
4951

5052
1. Grab a valid iOS 14+ device and jailbreak it: https://ios.cfw.guide/get-started/select-iphone/
5153
1. Clone this git repo.
@@ -62,9 +64,9 @@ It is assumed you know your way around a command line. All commands are run on y
6264

6365
1. Create a `config.json` at the root of this repo with the correct values.
6466

65-
Make sure to remove all `// comments` before saving. They are not valid json!
67+
Make sure to remove all `// comments` before saving. They are not valid JSON!
6668

67-
```json
69+
```js
6870
{
6971
"api_key": "YOUR_API_KEY",
7072
"device_configuration_manager_url": "https://YOUR_AWESOME_DCM_URL",
@@ -82,9 +84,9 @@ It is assumed you know your way around a command line. All commands are run on y
8284
- https://apt.bingner.com/debs/1443.00/com.saurik.substrate.safemode_0.9.6005_iphoneos-arm.deb
8385
- https://repo.spooferpro.com/debs/com.spooferpro.kernbypass_1.1.0_iphoneos-arm64.deb
8486
- https://github.com/clburlison/dmon/releases
85-
- (Optional - Required to pogo.ipa updates) https://cydia.akemi.ai/debs/nodelete-ai.akemi.appsyncunified.deb
86-
- (Optional - Required to pogo.ipa updates) https://cydia.akemi.ai/debs/nodelete-ai.akemi.appinst.deb
87-
- **Potentially any paid/private debs. nudge, nudge, wink, wink**
87+
- (Optional - Required for pogo.ipa updates) https://cydia.akemi.ai/debs/nodelete-ai.akemi.appsyncunified.deb
88+
- (Optional - Required for pogo.ipa updates) https://cydia.akemi.ai/debs/nodelete-ai.akemi.appinst.deb
89+
- **Potentially any paid/private debs. Nudge, nudge, wink, wink**
8890

8991
1. Grab a copy of Pokemon Go via [majd/ipatool](https://github.com/majd/ipatool).
9092

@@ -96,14 +98,14 @@ It is assumed you know your way around a command line. All commands are run on y
9698
```
9799

98100
1. Connect your iOS device to your computer via USB.
99-
1. Open Terminal and run (remember to only have one phone connected).
101+
1. Open Terminal.app and run (remember only to have one phone connected).
100102

101103
```sh
102104
# Alteratively you can pass -u <device-uuid> if multiple phones are connected
103105
iproxy 2222 22
104106
```
105107

106-
1. Then in a separate terminal window run:
108+
1. Then, in a separate terminal window, run:
107109

108110
```sh
109111
ssh root@localhost -p 2222 # default password is 'alpine'
@@ -118,25 +120,25 @@ It is assumed you know your way around a command line. All commands are run on y
118120
./bin/setup -s ~/.ssh/main.pub
119121
```
120122

121-
1. Assuming everything worked correctly your phone should be properly configured.
123+
1. Assuming everything worked correctly, your phone is now properly configured.
122124

123125
Bonus items that are out of scope for this project.
124126

125127
- Configure your device as supervised and push a wireless mobileconfig profile
126-
- Configure your device to use Shared Internet from your mac
128+
- Configure your device to use Shared Internet from your Mac
127129
- Supervise your device and push a global proxy to route requests through HAproxy
128130

129131
## Testing
130132

131133
- All testing has been completed with iOS 15 using palera1n
132-
- Only confirmed on older A9 processors aka iPhone SE first gen
134+
- Only confirmed on older A9 processors, aka iPhone SE first gen
133135
- DEB Package is built on macOS Ventura
134136

135137
## Commonly asked questions
136138

137139
### Why didn't you use Theos to build the deb?
138140

139-
I was expecting to add a few external compiled binaries and didn't want to read a ton of documentation. Things changed and now I'm too lazy to rewrite.
141+
I was expecting to add a few external compiled binaries and wanted to avoid reading the documentation. But, unfortunately, things changed, and I don't want to rewrite it.
140142

141143
### How can I stop it?!?!
142144

@@ -148,9 +150,9 @@ I was expecting to add a few external compiled binaries and didn't want to read
148150
/usr/bin/launchctl unload /Library/LaunchDaemons/com.github.clburlison.dmon.plist
149151
```
150152

151-
### How do I setup the webserver?
153+
### How do I set up the webserver?
152154

153-
It is a flat structure. You can use nginx, apache, caddy, python, node, etc. Your files should be named like this:
155+
It is a flat structure. You can use Nginx, Apache, Caddy, Python, NodeJS, etc. Your files should be named:
154156

155157
```sh
156158
top_level_folder
@@ -159,26 +161,26 @@ top_level_folder
159161
└── version.txt
160162
```
161163

162-
Your `version.txt` file should have the following. Obviously update the versions to match what is currently released.
164+
Your `version.txt` file should have the following text. Update the versions to match what is currently released.
163165

164166
```sh
165167
gc: 2.0.248
166168
pogo: 0.265.0
167169
```
168170

169-
Then in your config point `dmon_url` to `http://HOSTNAME:PORT/top_level_folder`.
171+
Then in your config, point `dmon_url` to `http://HOSTNAME:PORT/top_level_folder`.
170172

171173
### Why did you reuse the existing `config.json`?
172174

173-
This isn't a pure solution. I am lazy. Now bugger off.
175+
I was lazy and figured this would make it easier for you. Now bugger off.
174176

175177
### Why didn't you include the debs I need?
176178

177-
I don't have the original authors permissions to upload their files.
179+
I don't have the original author's permission to upload their files.
178180

179181
### Why is my https url not working?
180182

181-
We are using the stock CA Certificates installed as part of the iOS jailbreak. The Procursus Team placed files in `/usr/lib/ssl/cacert.pem` and I figured it would be safe to keep using them. Those root certs might have expired and need an update.
183+
dmon is using the stock CA Certificates installed as part of the iOS jailbreak. The Procursus Team placed files in `/usr/lib/ssl/cacert.pem` and I figured it would be safe to keep using them. Those root certs might have expired and need an update if you are running into an issue.
182184

183185
## References
184186

bin/disable

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
#!/usr/bin/env zsh
1+
#!/bin/zsh
22

33
ssh iphone "/usr/bin/launchctl unload /Library/LaunchDaemons/com.github.clburlison.dmon.plist"

bin/enable

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
#!/usr/bin/env zsh
1+
#!/bin/zsh
22

33
ssh iphone "/usr/bin/launchctl load /Library/LaunchDaemons/com.github.clburlison.dmon.plist"

bin/setup

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/zsh
22
############################################
3-
# Version 0.0.4
3+
# Version 0.0.5
44
############################################
55
SCRIPT_NAME=$(basename $0)
66
# Make sure this is always ran from the parent directory path.
@@ -37,9 +37,9 @@ fi
3737
# ssh root@localhost -p 2222 'apt install -y --allow-unauthenticated com.ex.substitute'
3838

3939
echo Copying over all debs
40-
scp -P 2222 -r ./debs root@localhost:~/
40+
scp -P 2222 -r ./debs root@localhost:~/debs
4141
echo Installing all debs
42-
ssh -p 2222 root@localhost "dpkg -i *.deb"
42+
ssh -p 2222 root@localhost "dpkg -i ~/debs/*.deb"
4343

4444
echo Copying over config file
4545
ssh -p 2222 root@localhost 'mkdir -p /var/mobile/Application\ Support/GoCheats/'

0 commit comments

Comments
 (0)