Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
c464ccb
Update windows.mdx
CelloSerenity Jun 12, 2025
0494bc0
Merge branch 'SideStore:main' into main
CelloSerenity Jun 12, 2025
7c7ffca
Merge branch 'SideStore:main' into main
CelloSerenity Jun 15, 2025
1a9bf7b
Update anisette.mdx
CelloSerenity Jun 15, 2025
113bc9c
Merge branch 'SideStore:main' into main
CelloSerenity Jun 24, 2025
9a6849a
Update docusaurus.config.js
CelloSerenity Jun 24, 2025
f6ce00e
Update TRANSLATION_GUIDE.md
CelloSerenity Jun 24, 2025
7de37f9
Update common-issues.mdx
CelloSerenity Jun 24, 2025
fee5809
Update error-codes.mdx
CelloSerenity Jun 24, 2025
90cf9d4
Update error-codes.mdx
CelloSerenity Jun 24, 2025
e6df307
Update linux.mdx
CelloSerenity Jun 29, 2025
5ad4d7e
Update pairing-file.mdx
CelloSerenity Jun 29, 2025
2fba0de
Update linux.mdx
CelloSerenity Jun 29, 2025
038cbb9
Update linux.mdx
CelloSerenity Jun 29, 2025
f21f5d3
Update error-codes.mdx
CelloSerenity Jun 29, 2025
864c659
Update post-install.mdx
CelloSerenity Jun 29, 2025
6db0eea
Update faq.mdx
CelloSerenity Jun 29, 2025
07294b3
Update release-notes.mdx
CelloSerenity Jul 1, 2025
a725eba
Update jit.mdx
CelloSerenity Jul 1, 2025
a0bba13
Update faq.mdx
CelloSerenity Jul 1, 2025
164600f
Update faq.mdx
CelloSerenity Jul 1, 2025
5b5368d
Merge branch 'SideStore:main' into main
CelloSerenity Jul 5, 2025
fda2614
Update intro.mdx
CelloSerenity Jul 5, 2025
df67ada
Update prerequisites.mdx
CelloSerenity Jul 5, 2025
1ec3c72
Update prerequisites.mdx
CelloSerenity Jul 15, 2025
f65c9b6
Update intro.mdx
CelloSerenity Jul 15, 2025
c9b93d5
Update common-issues.mdx
CelloSerenity Jul 15, 2025
50de62c
Update troubleshooting.mdx
CelloSerenity Jul 15, 2025
a7d0d04
Update common-issues.mdx
CelloSerenity Jul 15, 2025
bf52e28
Update error-codes.mdx
CelloSerenity Jul 15, 2025
fdabb07
Update jit.mdx
CelloSerenity Jul 15, 2025
e8d849e
Merge branch 'SideStore:main' into main
CelloSerenity Aug 6, 2025
ad30eee
Update linux.mdx
CelloSerenity Aug 6, 2025
babfd75
Update windows.mdx
CelloSerenity Aug 6, 2025
f7f7e24
Update mac.mdx
CelloSerenity Aug 6, 2025
e7e905f
Update linux.mdx
CelloSerenity Aug 14, 2025
3c5d1ff
Update pairing-file.mdx
CelloSerenity Aug 14, 2025
d265413
Update windows.mdx
CelloSerenity Aug 17, 2025
fe35e8a
Update pairing-file.mdx
CelloSerenity Aug 17, 2025
e9951ea
Update prerequisites.mdx
CelloSerenity Aug 17, 2025
77debbd
Update pairing-file.mdx
CelloSerenity Aug 17, 2025
9d473b2
Update pairing-file.mdx
CelloSerenity Aug 17, 2025
5ceaac8
Update pairing-file.mdx
CelloSerenity Aug 17, 2025
7f89ff4
Update pairing-file.mdx
CelloSerenity Aug 18, 2025
56299b4
Update pairing-file.mdx
CelloSerenity Aug 18, 2025
d466914
Update pairing-file.mdx
CelloSerenity Aug 18, 2025
269bccb
Update linux.mdx
CelloSerenity Aug 18, 2025
e6cd835
Update linux.mdx
CelloSerenity Aug 18, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/installation/linux.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ sidebar_position: 4

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

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

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

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

Now, proceed to generate your [pairing file](pairing-file).
1 change: 0 additions & 1 deletion docs/installation/mac.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,5 @@ Before you start, make sure to have all steps completed found in the [prerequisi
* Open the Settings app.
* Navigate to the 'Privacy and Security' section.
* Turn on 'Developer Mode' at the bottom.
5. Open SideStore and select "allow" for prompts until SideStore requests a pairing file. Exit the app now.

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

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

Download idevice pair for:
- [macOS](https://github.com/jkcoxson/idevice_pair/releases/latest/download/iDevicePair--macos-universal.dmg)
- [Windows](https://github.com/jkcoxson/idevice_pair/releases/latest/download/iDevicePair--windows-x86_64.exe)
- 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))

## Pairing Instructions
## Installation Instructions

### macOS

1. Download `iDevicePair--macos-universal.dmg`. Open the file and drag `idevice pair` to `Applications`.
2. Connect your secondary device to your computer via cable. If a prompt appears, tap "trust" and type in your passcode.
3. Unlock your device, then open idevice pair and select your device in the drop-down menu.
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.
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.
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 (64-bit)
### Windows

1. If not already installed for AltServer, install [iTunes](https://apple.com/itunes/download/win64) from Apple's website.
2. Download `iDevicePair--windows-x86_64.exe` (move it somewhere you won't lose it).
3. Connect your secondary device to your computer via cable. If a prompt appears, tap "trust" and type in your passcode.
4. Unlock your device, then, in File Explorer, open `idevice pair` and select your device in the drop-down menu.
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.
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.
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.
2. Download the version of idevice pair that corresponds to your PC's architecture and make it executable.
3. Connect your secondary device to your computer via cable. If a prompt appears, tap "trust" and type in your passcode.
4. Unlock your device, then execute idevice pair and select your device in the drop-down menu.
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.
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.
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.

## Next steps
Now, follow the [post-install instructions](post-install).
4 changes: 2 additions & 2 deletions docs/installation/prerequisites.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ SideStore's installation process may seem tricky, but with the ***one-time*** us
To install SideStore, you will need:

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

Next, follow the installation instructions for your operating system!
- [macOS](mac)
- [Windows (64-bit)](windows)
- [Windows](windows)
- [Linux (experimental)](linux)
3 changes: 1 addition & 2 deletions docs/installation/windows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 3

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

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

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).
2. Download the SideStore IPA which you can find [here](https://github.com/sidestore/sidestore/releases/latest/download/sidestore.ipa).
Expand All @@ -16,6 +16,5 @@ On your machine, uninstall any version of iCloud or iTunes you may have download
* Open the Settings app.
* Navigate to the 'Privacy and Security' section.
* Turn on 'Developer Mode' at the bottom.
5. Open SideStore and select "allow" for prompts until SideStore requests a pairing file. Exit the app now.

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