Skip to content

Commit 9783ce9

Browse files
CelloSerenityCelloSerenity
authored
Update installation/pairing guide (#152)
* Update windows.mdx Signed-off-by: CelloSerenity <[email protected]> * Update anisette.mdx Signed-off-by: CelloSerenity <[email protected]> * Update docusaurus.config.js Signed-off-by: CelloSerenity <[email protected]> * Update TRANSLATION_GUIDE.md Signed-off-by: CelloSerenity <[email protected]> * Update common-issues.mdx Signed-off-by: CelloSerenity <[email protected]> * Update error-codes.mdx Signed-off-by: CelloSerenity <[email protected]> * Update error-codes.mdx Signed-off-by: CelloSerenity <[email protected]> * Update linux.mdx Signed-off-by: CelloSerenity <[email protected]> * Update pairing-file.mdx Signed-off-by: CelloSerenity <[email protected]> * Update linux.mdx Signed-off-by: CelloSerenity <[email protected]> * Update linux.mdx Signed-off-by: CelloSerenity <[email protected]> * Update error-codes.mdx Signed-off-by: CelloSerenity <[email protected]> * Update post-install.mdx Signed-off-by: CelloSerenity <[email protected]> * Update faq.mdx Signed-off-by: CelloSerenity <[email protected]> * Update release-notes.mdx Signed-off-by: CelloSerenity <[email protected]> * Update jit.mdx Signed-off-by: CelloSerenity <[email protected]> * Update faq.mdx Signed-off-by: CelloSerenity <[email protected]> * Update faq.mdx Signed-off-by: CelloSerenity <[email protected]> * Update intro.mdx * Update prerequisites.mdx * Update prerequisites.mdx Signed-off-by: CelloSerenity <[email protected]> * Update intro.mdx Signed-off-by: CelloSerenity <[email protected]> * Update common-issues.mdx Signed-off-by: CelloSerenity <[email protected]> * Update troubleshooting.mdx Signed-off-by: CelloSerenity <[email protected]> * Update common-issues.mdx Signed-off-by: CelloSerenity <[email protected]> * Update error-codes.mdx Signed-off-by: CelloSerenity <[email protected]> * Update jit.mdx Signed-off-by: CelloSerenity <[email protected]> * Update linux.mdx Signed-off-by: CelloSerenity <[email protected]> * Update windows.mdx Signed-off-by: CelloSerenity <[email protected]> * Update mac.mdx Signed-off-by: CelloSerenity <[email protected]> * Update linux.mdx Signed-off-by: CelloSerenity <[email protected]> * Update pairing-file.mdx Signed-off-by: CelloSerenity <[email protected]> * Update windows.mdx Signed-off-by: CelloSerenity <[email protected]> * Update pairing-file.mdx Signed-off-by: CelloSerenity <[email protected]> * Update prerequisites.mdx Signed-off-by: CelloSerenity <[email protected]> * Update pairing-file.mdx Signed-off-by: CelloSerenity <[email protected]> * Update pairing-file.mdx Signed-off-by: CelloSerenity <[email protected]> * Update pairing-file.mdx Signed-off-by: CelloSerenity <[email protected]> * Update pairing-file.mdx * Update pairing-file.mdx Signed-off-by: CelloSerenity <[email protected]> * Update pairing-file.mdx Signed-off-by: CelloSerenity <[email protected]> * Update linux.mdx Signed-off-by: CelloSerenity <[email protected]> * Update linux.mdx Signed-off-by: CelloSerenity <[email protected]> --------- Signed-off-by: CelloSerenity <[email protected]>
1 parent eadcfb0 commit 9783ce9

File tree

5 files changed

+25
-36
lines changed

5 files changed

+25
-36
lines changed

‎docs/installation/linux.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ sidebar_position: 4
66

77
Before you start, make sure to have all steps completed found in the [prerequisites](prerequisites)!
88

9-
1. Make sure you have usbmuxd and either Docker or Podman installed on your machine.
10-
2. Plug in your iDevice. If you recieve a prompt, select "trust" and enter your passcode.
9+
1. Ensure you have usbmuxd installed and updated by running `sudo apt install -y usbmuxd` in the Linux terminal.
10+
2. Install either Docker or Podman on your machine.
11+
2. Plug in your secondary iDevice. If you recieve a prompt, select "trust" and enter your passcode.
1112

1213
3. Now, run Altcon with Docker or Podman using the following commands (may require `sudo`):
1314

@@ -19,12 +20,11 @@ Podman setup:
1920
```bash
2021
podman run --rm -it -v ${PWD}/:/mnt/ -v /var/run/usbmuxd:/var/run/usbmuxd ghcr.io/sidestore/altcon
2122
```
22-
3. Altcon will pair with your device. When you recieve another prompt, select "trust" and enter your passcode again.
23-
4. On your secondary device, do the following:
23+
5. Altcon will pair with your device. When you receive another prompt, select "trust" and enter your passcode again.
24+
6. On your secondary device, do the following:
2425
* Approve the "Developer App" under your Apple ID's email (you can find this in Settings, under "General", and then "VPN & Device Management").
2526
* Open the Settings app.
2627
* Navigate to the 'Privacy and Security' section.
2728
* Turn on 'Developer Mode' at the bottom.
28-
5. Open SideStore and select "allow" for prompts until SideStore requests a pairing file. Exit the app now.
2929

3030
Now, proceed to generate your [pairing file](pairing-file).

‎docs/installation/mac.mdx‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,5 @@ Before you start, make sure to have all steps completed found in the [prerequisi
1414
* Open the Settings app.
1515
* Navigate to the 'Privacy and Security' section.
1616
* Turn on 'Developer Mode' at the bottom.
17-
5. Open SideStore and select "allow" for prompts until SideStore requests a pairing file. Exit the app now.
1817

1918
Now, proceed to generate your [pairing file](pairing-file).

‎docs/installation/pairing-file.mdx‎

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

7-
idevice pair is a program which creates a Jitterbug pairing file, allowing programs like SideStore to talk to your device remotely. This is required to use SideStore, otherwise it will not function.
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.
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, 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 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.
1010
:::
1111

12-
Download idevice pair for:
13-
- [macOS](https://github.com/jkcoxson/idevice_pair/releases/latest/download/iDevicePair--macos-universal.dmg)
14-
- [Windows](https://github.com/jkcoxson/idevice_pair/releases/latest/download/iDevicePair--windows-x86_64.exe)
15-
- Linux ([x86_64](https://github.com/jkcoxson/idevice_pair/releases/latest/download/iDevicePair--linux-x86_64.AppImage) or [AArch64](https://github.com/jkcoxson/idevice_pair/releases/latest/download/iDevicePair--linux-aarch64.AppImage))
16-
17-
## Pairing Instructions
12+
## Installation Instructions
1813

1914
### macOS
2015

21-
1. Download `iDevicePair--macos-universal.dmg`. Open the file and drag `idevice pair` to `Applications`.
22-
2. Connect your secondary device to your computer via cable. If a prompt appears, tap "trust" and type in your passcode.
23-
3. Unlock your device, then open idevice pair and select your device in the drop-down menu.
24-
4. Ensure your device is unlocked and opened to the home screen, then select "generate". When a prompt appears on your device, tap "trust". Your pairing file should appear.
25-
5. Ensure your device is still open to the home screen, then scroll down to the SideStore section and select "install". The word "success" should appear in green.
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`.
2618

27-
### Windows (64-bit)
19+
### Windows
2820

29-
1. If not already installed for AltServer, install [iTunes](https://apple.com/itunes/download/win64) from Apple's website.
30-
2. Download `iDevicePair--windows-x86_64.exe` (move it somewhere you won't lose it).
31-
3. Connect your secondary device to your computer via cable. If a prompt appears, tap "trust" and type in your passcode.
32-
4. Unlock your device, then, in File Explorer, open `idevice pair` and select your device in the drop-down menu.
33-
5. Ensure your device is unlocked and opened to the home screen, then select "generate". When a prompt appears on your device, tap "trust". Your pairing file should appear.
34-
6. Ensure your device is still open to the home screen, then scroll down to the SideStore section and select "install". The word "success" should appear in green.
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.
3523

3624
### Linux
3725

38-
1. Ensure usbmuxd is installed on your machine.
39-
2. Download the version of idevice pair that corresponds to your PC's architecture and make it executable.
40-
3. Connect your secondary device to your computer via cable. If a prompt appears, tap "trust" and type in your passcode.
41-
4. Unlock your device, then execute idevice pair and select your device in the drop-down menu.
42-
5. Ensure your device is unlocked and opened to the home screen, then select "generate". When a prompt appears on your device, tap "trust". Your pairing file should appear.
43-
6. Ensure your device is still open to the home screen, then scroll down to the SideStore section and select "install". The word "success" should appear in green.
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.
4435

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

‎docs/installation/prerequisites.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ SideStore's installation process may seem tricky, but with the ***one-time*** us
1111
To install SideStore, you will need:
1212

1313
- An iPhone or iPad [with a passcode](https://support.apple.com/en-us/119586) running iOS/iPadOS 14 or higher
14-
- A [Mac](/docs/installation/mac), [Windows](/docs/installation/windows), or [Linux](/docs/installation/linux) (Linux support is experimental) computer
14+
- A [Mac](/docs/installation/mac), [Windows](/docs/installation/windows), or [Linux (support is experimental)](/docs/installation/linux) computer
1515
- An Apple ID
1616
- The StosVPN app (see below)
1717
- A Wi-Fi connection
@@ -30,5 +30,5 @@ This VPN is required to be turned on any time you wish to install, update, or re
3030

3131
Next, follow the installation instructions for your operating system!
3232
- [macOS](mac)
33-
- [Windows (64-bit)](windows)
33+
- [Windows](windows)
3434
- [Linux (experimental)](linux)

‎docs/installation/windows.mdx‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 3
66

77
Before you start, make sure to have all steps completed found in the [prerequisites](prerequisites)!
88

9-
On your machine, uninstall any version of iCloud or iTunes you may have downloaded from the Microsoft store, then install the non-Microsoft Store versions of [iCloud](https://updates.cdn-apple.com/2020/windows/001-39935-20200911-1A70AA56-F448-11EA-8CC0-99D41950005E/iCloudSetup.exe) and [iTunes](https://apple.com/itunes/download/win64). The non-Microsoft Store version of iCloud was removed from Apple’s website in mid-September 2022, so the above link directs to an older version of iCloud that is still compatible with AltServer, and still available directly from Apple’s servers (safe).
9+
On your machine, uninstall any version of iCloud or iTunes you may have downloaded from the Microsoft store, then install the non-Microsoft Store versions of iTunes ([64-bit](https://apple.com/itunes/download/win64) or [32-bit](https://apple.com/itunes/download/win32)) and [iCloud](https://updates.cdn-apple.com/2020/windows/001-39935-20200911-1A70AA56-F448-11EA-8CC0-99D41950005E/iCloudSetup.exe). The non-Microsoft Store version of iCloud was removed from Apple’s website in mid-September 2022, so the above link directs to an older version of iCloud that is still compatible with AltServer, and still available directly from Apple’s servers (safe).
1010

1111
1. Download `altinstaller.zip` from [AltStore's website](https://cdn.altstore.io/file/altstore/altinstaller.zip). Extract `altinstaller.zip` and run `setup.exe`. In your Windows taskbar, type in "AltServer" and click "Run as administrator." Make sure to allow access to private networks if prompted. AltStore will appear as an icon in the system tray (where Internet, Wi-Fi, Battery, etc. are displayed).
1212
2. Download the SideStore IPA which you can find [here](https://github.com/sidestore/sidestore/releases/latest/download/sidestore.ipa).
@@ -16,6 +16,5 @@ On your machine, uninstall any version of iCloud or iTunes you may have download
1616
* Open the Settings app.
1717
* Navigate to the 'Privacy and Security' section.
1818
* Turn on 'Developer Mode' at the bottom.
19-
5. Open SideStore and select "allow" for prompts until SideStore requests a pairing file. Exit the app now.
2019

2120
Now, proceed to generate your [pairing file](pairing-file).

0 commit comments

Comments
 (0)