Skip to content

Commit 1e4b0de

Browse files
Update to match idevice_pair readme (#159)
* Update to match idevice_pair readme Updated installation and pairing instructions for clarity and formatting. Signed-off-by: CelloSerenity <[email protected]> * Update instruction from 'generate' to 'create' Signed-off-by: CelloSerenity <[email protected]> * Clarify pairing file generation and expiration warnings Updated wording for clarity regarding pairing file generation and expiration. Signed-off-by: CelloSerenity <[email protected]> * Clarify pairing file regeneration steps Updated instructions for regenerating and reimporting pairing files in troubleshooting documentation. Signed-off-by: CelloSerenity <[email protected]> * Clarify error message for AFC pairing file Updated wording from 'regenerate' to 'recreate' for clarity. Signed-off-by: CelloSerenity <[email protected]> * Update wording from 'generate' to 'create' for clarity Signed-off-by: CelloSerenity <[email protected]> * Refine pairing file instructions in troubleshooting guide Updated terminology from 'generate' to 'create' and 'regenerate' to 'recreate' for consistency in pairing file instructions. Signed-off-by: CelloSerenity <[email protected]> * Update wording from 'generate' to 'create' in instructions Signed-off-by: CelloSerenity <[email protected]> --------- Signed-off-by: CelloSerenity <[email protected]>
1 parent feec866 commit 1e4b0de

File tree

7 files changed

+43
-34
lines changed

7 files changed

+43
-34
lines changed

docs/installation/linux.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@ podman run --rm -it -v ${PWD}/:/mnt/ -v /var/run/usbmuxd:/var/run/usbmuxd -v /va
2727
* Navigate to the 'Privacy and Security' section.
2828
* Turn on 'Developer Mode' at the bottom.
2929

30-
Now, proceed to generate your [pairing file](pairing-file).
30+
Now, proceed to create your [pairing file](pairing-file).

docs/installation/mac.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ Before you start, make sure to have all steps completed found in the [prerequisi
1515
* Navigate to the 'Privacy and Security' section.
1616
* Turn on 'Developer Mode' at the bottom.
1717

18-
Now, proceed to generate your [pairing file](pairing-file).
18+
Now, proceed to create your [pairing file](pairing-file).

docs/installation/pairing-file.mdx

Lines changed: 34 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,43 @@ description: Pairing files are essential to SideStore's functionality.
44
sidebar_position: 5
55
---
66

7-
idevice_pair is a program which generates a pairing file which allows apps like SideStore to perform actions on your device remotely. This is required to use SideStore, otherwise it will not function.
7+
idevice_pair is a program which creates a pairing file which allows apps like SideStore to perform actions on your device remotely. This is required to use SideStore, otherwise it will not function.
88
:::warning
9-
Caution, if you update or reset your iDevice, your pairing file will expire and you will need to generate a new one. This also occurs at random times due to Apple's policies, and there is nothing we can do at this point to fix it.
9+
Caution, if you update or reset your iDevice, your pairing file will expire and you will need to create a new one. This also occurs at random times. This is due to Apple's systems, and there is nothing we can do at this point to fix it.
1010
:::
1111

12-
## Installation Instructions
13-
14-
### macOS
15-
16-
1. Download [idevice pair for macOS](https://github.com/jkcoxson/idevice_pair/releases/latest/download/idevice_pair--macos-universal.dmg).
17-
2. Open the Disk Image and drag `idevice pair` to `Applications`.
18-
19-
### Windows
20-
21-
1. Ensure iTunes ([64-bit](https://apple.com/itunes/download/win64) or [32-bit](https://apple.com/itunes/download/win32)) is installed from from Apple's website (it should already be installed from the process of setting up AltServer).
22-
2. Download [idevice pair for Windows](https://github.com/jkcoxson/idevice_pair/releases/latest/download/idevice_pair--windows-x86_64.exe) and move it somewhere you will remember it.
23-
24-
### Linux
25-
26-
1. Ensure usbmuxd is installed on your machine by running `sudo apt install -y usbmuxd` in the Linux terminal.
27-
2. Download the version of idevice_pair for Linux ([x86_64](https://github.com/jkcoxson/idevice_pair/releases/latest/download/idevice_pair--linux-x86_64.AppImage) or [AArch64](https://github.com/jkcoxson/idevice_pair/releases/latest/download/idevice_pair--linux-aarch64.AppImage)) which corresponds to your PC's architecture. Move it somewhere you will remember it, and make it executable.
28-
29-
## Pairing Instructions
30-
31-
1. Connect your secondary device to your computer via cable. If a prompt appears, select `trust` and type in your passcode.
32-
2. Unlock your device, then open `idevice pair` and select your device in the drop-down menu.
33-
3. Ensure your device is unlocked and opened to the home screen, then select `load`. If a prompt appears on your device, tap `trust`. Your pairing file should appear.
34-
4. Ensure your device is still open to the home screen, then scroll down and select `install` underneath "SideStore". `Success` should appear in green.
12+
### Installation Instructions
13+
#### macOS
14+
1. Download [idevice_pair for macOS](https://github.com/jkcoxson/idevice_pair/releases/latest/download/idevice_pair--macos-universal.dmg)
15+
2. Open the Disk Image and drag `idevice_pair` to `Applications`
16+
17+
#### Windows
18+
1. Install [iTunes](https://apple.com/itunes/download/win64) from Apple's website
19+
2. Download [idevice_pair for Windows](https://github.com/jkcoxson/idevice_pair/releases/latest/download/idevice_pair--windows-x86_64.exe) and save it to a memorable location
20+
21+
#### Linux
22+
1. Install usbmuxd:
23+
```bash
24+
sudo apt install -y usbmuxd
25+
```
26+
2. Download idevice_pair for your architecture and save it to a memorable location:
27+
- [x86_64](https://github.com/jkcoxson/idevice_pair/releases/latest/download/idevice_pair--linux-x86_64.AppImage)
28+
- [AArch64](https://github.com/jkcoxson/idevice_pair/releases/latest/download/idevice_pair--linux-aarch64.AppImage)
29+
3. Make the downloaded file executable
30+
31+
### Pairing Instructions
32+
33+
1. **Connect your device** to your computer via USB cable
34+
- If prompted, tap `Trust` and enter your passcode
35+
2. **Open idevice_pair** and select your device from the dropdown menu
36+
3. **Load pairing file**:
37+
- Ensure your device is unlocked and on the home screen
38+
- Click `Load`
39+
- If prompted, tap `Trust` and enter your passcode
40+
4. **Install to SideStore**:
41+
- Keep your device unlocked and on the home screen
42+
- Scroll down and click `Install` under "SideStore"
43+
- You should see `Success` appear in green
3544

3645
## Next steps
3746
Now, follow the [post-install instructions](post-install).

docs/installation/windows.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ On your machine, uninstall any version of iCloud or iTunes you may have download
1717
* Navigate to the 'Privacy and Security' section.
1818
* Turn on 'Developer Mode' at the bottom.
1919

20-
Now, proceed to generate your [pairing file](pairing-file).
20+
Now, proceed to create your [pairing file](pairing-file).

docs/troubleshooting/common-issues.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This page is currently a work in progress. The information provided should be ac
1616
Connection issues or an invalid pairing file.
1717
#### Resolution
1818
1. Attempt to reconnect
19-
2. Generate and import a new pairing file using idevice pair. See our [Pairing File instructions](/docs/installation/pairing-file) for details
19+
2. Create and import a new pairing file using idevice pair. See our [Pairing File instructions](/docs/installation/pairing-file) for details
2020

2121
### No Wi-Fi or VPN Connection
2222
#### Cause
@@ -27,7 +27,7 @@ Connection issues with the minimuxer service.
2727
2. Try again (spamming the button often helps)
2828
3. Restart SideStore
2929
4. Restart StosVPN
30-
5. Regenerate and import a new pairing file using idevice pair. See our [Pairing File instructions](/docs/installation/pairing-file) for details
30+
5. Recreate and import a new pairing file using idevice pair. See our [Pairing File instructions](/docs/installation/pairing-file) for details
3131

3232
### SideStore Hangs Partway Through Installation
3333
#### Cause
@@ -38,7 +38,7 @@ Cache or protocol issues.
3838
3. Change Anisette Server
3939
4. In servers- reset adi.pb, then sign out of SideStore and sign back in
4040
5. Restart device
41-
6. Regenerate pairing file
41+
6. Recreate pairing file
4242
7. Reinstall SideStore using AltServer
4343

4444
### Unable to Launch SideStore

docs/troubleshooting/error-codes.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ This means you are attempting to enable JIT on an unsupported iOS version. SideS
119119

120120
`minimuxer.MinimuxerError 27`
121121

122-
This means you have an invalid pairing file. Follow the steps in these docs to regenerate it.
122+
This means you have an invalid pairing file. Follow the steps in these docs to recreate it.
123123

124124
More coming, open to contributions...
125125

docs/troubleshooting/troubleshooting.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,15 +74,15 @@ Another common issue during sign-in is not receiving a verification code when us
7474
- Disconnect from school/work Wi-Fi, try connecting to a restriction-free network.
7575
3. Verify VPN is connected in StosVPN.
7676
4. Turn StosVPN off, then back on, and wait a few seconds in SideStore before trying to refresh.
77-
5. Regenerate your pairing file.
77+
5. Recreate your pairing file.
7878
- If none of the above worked, it is very likely that the pairing file is corrupted. You can reference the documentation on how to create a new pairing file [here](/docs/installation/pairing-file).
7979

8080

8181
## Cannot Choose Pairing File
8282

8383
### If you are unable to select a pairing file in SideStore, follow these steps to resolve the issue:
8484

85-
1. **Reimport Pairing File**: Use idevice pair to regenerate and import your pairing file to your device. If idevice pair doesn't work, try jitterbugpair and follow the steps below.
85+
1. **Reimport Pairing File**: Use idevice_pair to recreate and import your pairing file to your device. If idevice pair doesn't work, try jitterbugpair and follow the steps below.
8686
2. **Check File Extension**: Make sure your pairing file's extension ends with `.mobiledevicepairing` or `.plist`. If it doesn't, double-check to see if you had zipped your pairing file before sending it to your phone. Failing to do so may lead to the file being corrupted during transport.
8787
3. **Move Pairing File**: If you are unable to select the pairing file from within the app, rename the file to `ALTPairingFile.mobiledevicepairing` and try moving the pairing file to the root directory of the SideStore folder in the Files app in "On My iPhone/iPad".
8888
4. **Certificate Signing**: When signing SideStore with a certificate, you won't be able to select the pairing file from within the app. You can try the fix mentioned above. If you do not see the SideStore folder in the Files app, connect your phone to your computer, and you can drag and drop the pairing file to the files of the SideStore app. Make sure to change it to the name mentioned above.

0 commit comments

Comments
 (0)