Skip to content
Merged
2 changes: 1 addition & 1 deletion docs/installation/linux.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ podman run --rm -it -v ${PWD}/:/mnt/ -v /var/run/usbmuxd:/var/run/usbmuxd -v /va
* Navigate to the 'Privacy and Security' section.
* Turn on 'Developer Mode' at the bottom.

Now, proceed to generate your [pairing file](pairing-file).
Now, proceed to create your [pairing file](pairing-file).
2 changes: 1 addition & 1 deletion docs/installation/mac.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ Before you start, make sure to have all steps completed found in the [prerequisi
* Navigate to the 'Privacy and Security' section.
* Turn on 'Developer Mode' at the bottom.

Now, proceed to generate your [pairing file](pairing-file).
Now, proceed to create your [pairing file](pairing-file).
59 changes: 34 additions & 25 deletions docs/installation/pairing-file.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,43 @@ description: Pairing files are essential to SideStore's functionality.
sidebar_position: 5
---

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.
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.
:::warning
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.
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.
:::

## Installation Instructions

### macOS

1. Download [idevice pair for macOS](https://github.com/jkcoxson/idevice_pair/releases/latest/download/idevice_pair--macos-universal.dmg).
2. Open the Disk Image and drag `idevice pair` to `Applications`.

### Windows

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).
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.

### Linux

1. Ensure usbmuxd is installed on your machine by running `sudo apt install -y usbmuxd` in the Linux terminal.
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.

## Pairing Instructions

1. Connect your secondary device to your computer via cable. If a prompt appears, select `trust` and type in your passcode.
2. Unlock your device, then open `idevice pair` and select your device in the drop-down menu.
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.
4. Ensure your device is still open to the home screen, then scroll down and select `install` underneath "SideStore". `Success` should appear in green.
### Installation Instructions
#### macOS
1. Download [idevice_pair for macOS](https://github.com/jkcoxson/idevice_pair/releases/latest/download/idevice_pair--macos-universal.dmg)
2. Open the Disk Image and drag `idevice_pair` to `Applications`

#### Windows
1. Install [iTunes](https://apple.com/itunes/download/win64) from Apple's website
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

#### Linux
1. Install usbmuxd:
```bash
sudo apt install -y usbmuxd
```
2. Download idevice_pair for your architecture and save it to a memorable location:
- [x86_64](https://github.com/jkcoxson/idevice_pair/releases/latest/download/idevice_pair--linux-x86_64.AppImage)
- [AArch64](https://github.com/jkcoxson/idevice_pair/releases/latest/download/idevice_pair--linux-aarch64.AppImage)
3. Make the downloaded file executable

### Pairing Instructions

1. **Connect your device** to your computer via USB cable
- If prompted, tap `Trust` and enter your passcode
2. **Open idevice_pair** and select your device from the dropdown menu
3. **Load pairing file**:
- Ensure your device is unlocked and on the home screen
- Click `Load`
- If prompted, tap `Trust` and enter your passcode
4. **Install to SideStore**:
- Keep your device unlocked and on the home screen
- Scroll down and click `Install` under "SideStore"
- You should see `Success` appear in green

## Next steps
Now, follow the [post-install instructions](post-install).
2 changes: 1 addition & 1 deletion docs/installation/windows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ On your machine, uninstall any version of iCloud or iTunes you may have download
* Navigate to the 'Privacy and Security' section.
* Turn on 'Developer Mode' at the bottom.

Now, proceed to generate your [pairing file](pairing-file).
Now, proceed to create your [pairing file](pairing-file).
6 changes: 3 additions & 3 deletions docs/troubleshooting/common-issues.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This page is currently a work in progress. The information provided should be ac
Connection issues or an invalid pairing file.
#### Resolution
1. Attempt to reconnect
2. Generate and import a new pairing file using idevice pair. See our [Pairing File instructions](/docs/installation/pairing-file) for details
2. Create and import a new pairing file using idevice pair. See our [Pairing File instructions](/docs/installation/pairing-file) for details

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

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

### Unable to Launch SideStore
Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting/error-codes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ This means you are attempting to enable JIT on an unsupported iOS version. SideS

`minimuxer.MinimuxerError 27`

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

More coming, open to contributions...

Expand Down
4 changes: 2 additions & 2 deletions docs/troubleshooting/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,15 @@ Another common issue during sign-in is not receiving a verification code when us
- Disconnect from school/work Wi-Fi, try connecting to a restriction-free network.
3. Verify VPN is connected in StosVPN.
4. Turn StosVPN off, then back on, and wait a few seconds in SideStore before trying to refresh.
5. Regenerate your pairing file.
5. Recreate your pairing file.
- 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).


## Cannot Choose Pairing File

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

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.
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.
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.
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".
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.
Expand Down