Skip to content

Commit e062b88

Browse files
authored
feat(iloader): switch to iloader (#174)
Thank you to everyone who helped with translations!
1 parent c521c54 commit e062b88

File tree

120 files changed

+6499
-2711
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

120 files changed

+6499
-2711
lines changed

TODO.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
# Todo List for SideStore-Docs
22

3-
[ ] Fix error codes and troubleshooting
3+
- [ ] Error Codes and Troubleshooting cleanup
44

5-
[X] Add details in faq about 3 app limit
6-
7-
[X] macOS Pairing File Instructions
8-
9-
[X] Linux Pairing File Instructions
10-
11-
[ ] SideJITServer Docs (start)
5+
iloader translation:
6+
- [X] EN
7+
- [ ] ES
8+
- [ ] FR (partial)
9+
- [ ] DE (partial)
10+
- [X] IT
11+
- [ ] NL (partial)
12+
- [X] ZH
13+
- [ ] JA
14+
- [ ] RU
15+
- [X] KO
16+
- [X] SV
17+
- [ ] VI

docs/advanced/alternative.mdx

Lines changed: 184 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
---
2+
title: Alternative/Outdated instructions
3+
description: "A place for alternative/outdated SideStore setup instructions. Note: many of these walkthroughs may be incompatible with latest iOS or SideStore versions."
4+
---
5+
6+
## Installation
7+
### AltServer
8+
#### macOS
9+
Follow the instructions (steps 1-3) [here](https://faq.altstore.io/altstore-classic/how-to-install-altstore-macos) to setup AltServer
10+
#### Windows
11+
Follow the instructions (steps 1-3) [here](https://faq.altstore.io/altstore-classic/how-to-install-altstore-windows) to setup AltServer
12+
#### Linux (Altcon)
13+
Before you start, make sure to have installed usbmuxd.
14+
15+
1. Ensure you have usbmuxd installed and updated by running `sudo apt install -y usbmuxd` in the Linux terminal.
16+
2. Install either Docker or Podman on your machine.
17+
2. Plug in your secondary iDevice. If you recieve a prompt, select "trust" and enter your passcode.
18+
19+
3. Now, run Altcon with Docker or Podman using the following command (may require `sudo`):
20+
21+
Docker setup:
22+
```bash
23+
docker run --rm -it -v ${PWD}/:/mnt/ -v /var/run/usbmuxd:/var/run/usbmuxd -v /var/lib/lockdown:/tmp/lockdown ghcr.io/sidestore/altcon
24+
```
25+
Podman setup:
26+
```bash
27+
podman run --rm -it -v ${PWD}/:/mnt/ -v /var/run/usbmuxd:/var/run/usbmuxd -v /var/lib/lockdown:/tmp/lockdown ghcr.io/sidestore/altcon
28+
```
29+
5. Altcon will pair with your device. When you receive another prompt, select "trust" and enter your passcode again.
30+
31+
#### Setting up SideStore for multiple devices on the same account using AltServer
32+
Steps:
33+
1. Setup AltServer on macOS/Windows using instructions above
34+
2. Install AltStore to one device using AltServer (We need AltStore once since it seems AltServer won't put machine identifier in apps other than AltStore)
35+
3. Sign in Apple ID in AltStore
36+
4. Export Certificate
37+
5. Delete AltStore
38+
39+
Then for each device:
40+
1. Install SideStore using AltServer with the same Apple ID (Hold [Option/Mac, Shift/Windows] when clicking AltServer -> Install IPA -> Select SideStore.ipa)
41+
2. Import certificate
42+
3. Sign in Apple ID in SideStore (We need to sign in after importing the certificate otherwise it won't let you sign in without revoking AltStore's certificate)
43+
4. Sideload
44+
45+
When the old certificate expires:
46+
1. SideStore will prompt to reinstall itself on one device
47+
2. After reinstalling, export the certificate
48+
49+
Then for each other device:
50+
1. Import new certificate
51+
2. Sideload SideStore ipa from SideStore
52+
53+
54+
## Pairing
55+
### idevice_pair
56+
#### Installation Instructions
57+
58+
##### macOS
59+
60+
1. Download [idevice pair for macOS](https://github.com/jkcoxson/idevice_pair/releases/latest/download/idevice_pair--macos-universal.dmg).
61+
2. Open the Disk Image and drag `idevice pair` to `Applications`.
62+
63+
##### Windows
64+
65+
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).
66+
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.
67+
68+
##### Linux
69+
70+
1. Ensure usbmuxd is installed on your machine by running `sudo apt install -y usbmuxd` in the Linux terminal.
71+
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.
72+
73+
#### Pairing Instructions
74+
75+
1. Connect your secondary device to your computer via cable. If a prompt appears, select `trust` and type in your passcode.
76+
2. Unlock your device, then open `idevice pair` and select your device in the drop-down menu.
77+
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.
78+
4. Ensure your device is still open to the home screen, then scroll down and select `install` underneath "SideStore". `Success` should appear in green.
79+
80+
### JitterbugPair
81+
JitterbugPair (*not* the Jitterbug app) allows us to create a pairing file for programs like SideStore to talk to your device remotely. This is required to use SideStore, or it will not function.
82+
83+
Download JitterbugPair for [Windows (64-bit)](https://github.com/osy/Jitterbug/releases/download/v1.3.1/jitterbugpair-win64.zip), [macOS](https://github.com/osy/Jitterbug/releases/download/v1.3.1/jitterbugpair-macos.zip), or [Linux](https://github.com/osy/Jitterbug/releases/download/v1.3.1/jitterbugpair-linux.zip).
84+
85+
#### Pairing Instructions
86+
87+
:::tip
88+
89+
Depending on your method, when transferring your .mobiledevicepariring file, the file extension might change (usually to .txt or cropping off the "ing"). It is always recommended to zip your pairing file before transferring it. SideStore only accepts .mobiledevicepairing files (or .plist files in older versions).
90+
:::
91+
92+
##### Windows
93+
94+
1. **Extract** `jitterbugpair-win64.zip`.
95+
2. **Set a passcode** for your device if you haven't already. Unlock your device and connect it to your computer via cable. If a prompt appears, tap "trust" and type in your passcode.
96+
3. Open your device to the homescreen.
97+
4. In File Explorer, locate `jitterbugpair.exe` and run it by double-clicking or right-clicking and selecting "open". The first time you run the tool, you will get a prompt for your passcode on your secondary device. Type it in, then keep the screen on and unlocked and run the tool again.
98+
5. JitterbugPair will generate a **pairing file** in the same folder. This file will have the extension `.mobiledevicepairing`.
99+
6. For best results, compress the file into a .zip folder. Then, **transfer the pairing file** to your iOS device using One/iCloud/Google Drive, email, or another method you prefer.
100+
101+
On Windows, you might have to execute the program using Command Prompt or Powershell, as double-clicking the `.exe` file doesn't always open it.
102+
103+
7. In File Explorer, navigate to the folder where jitterbugpair is located.
104+
8. In the navigation bar where the folder location is, click an empty spot and type `powershell`. It should open a (possibly blue colored) window called PowerShell.
105+
9. From there, type `./jitterbugpair.exe` and press enter while your device is plugged in.
106+
107+
##### macOS
108+
109+
1. **Extract** `jitterbugpair-macos.zip`.
110+
2. **Set a passcode** for your device if you haven't already. Unlock your device and connect it to your computer via cable. If a prompt appears, tap "trust" and type in your passcode.
111+
3. Open your device to the homescreen.
112+
4. Find and open the extracted `jitterbugpair` file (it should have a black and green icon) by double-clicking it or right-clicking it and selecting "open". The first time you run the tool, you will get a prompt for your passcode on your secondary device. Type it in, then keep the screen on and unlocked and run the tool again.
113+
5. If you get the message" "macOS cannot verify that this app is free from malware":
114+
- Go to System Settings > Privacy & Security
115+
- Scroll down to the message about the app
116+
- Click "Open Anyway," if the program doesn't run automatically, try manually running it again
117+
6. JitterbugPair will generate a **pairing file** with the extension `.mobiledevicepairing` to your user's home folder.
118+
7. If you can't find the pairing file:
119+
- Copy the name of the pairing file generated
120+
- Paste it into Finder
121+
- If you ran the program more than once, all pairing files for your device should appear since they share the same name
122+
8. For best results, compress the file into a .zip folder. Then, **transfer the pairing file** to your iOS device via AirDrop, iCloud/One/Google Drive, email, or another method you prefer.
123+
124+
##### Linux
125+
126+
These instructions expect that you are familiar with the linux commandline.
127+
128+
1. **Extract** `jitterbugpair-linux.zip`.
129+
2. Open a terminal in the extracted directory.
130+
3. Make the program executable:
131+
```bash
132+
chmod +x ./jitterbugpair
133+
```
134+
4. **Set a passcode** for your device if you haven't already. Unlock your device and connect it to your computer via cable. If a prompt appears, tap "trust" and type in your passcode.
135+
5. Open your device to the homescreen.
136+
6. Execute the program:
137+
```bash
138+
./jitterbugpair
139+
```
140+
7. The first time you execute the tool, you will get a prompt for your passcode on your secondary device. Type it in, then keep the screen on and unlocked and run the tool again. Type it in, then keep the screen on and unlocked and execute the tool again.
141+
8. JitterbugPair will generate a **pairing file** with the extension `.mobiledevicepairing`.
142+
9. For best results, compress the file into a .zip folder. Then, **transfer the pairing file** to your iOS device using email, cloud storage, or another method you prefer.
143+
## SideStore exploits
144+
### SparseRestore (3-app limit)
145+
:::note
146+
147+
The SparseRestore "Bypass 3 app limit" exploit **only works on iOS/iPadOS versions between 17.0 and 18.1 beta 4 (not including 17.7.1)**. If you are not on these versions and it doesn't work, **please do not ask for support on this**.
148+
149+
:::
150+
151+
#### Prerequisites
152+
* An iDevice running versions supported by the SparseRestore exploit (see note above).
153+
* At least 1 free app slot.
154+
* SideStore version 0.5.9 or later. You can find the latest versions [here](https://github.com/SideStore/SideStore/releases).
155+
* To perform this exploit, you MUST have **Find My** turned off on your iDevice during the process. It will not work otherwise. Here is how you can turn it off:
156+
- Open the Settings app.
157+
- Tap on your name at the top.
158+
- Tap on Find My.
159+
- Tap on Find My iPhone/iPad.
160+
- Turn off Find My iPhone/iPad.
161+
- You may be required to enter your Apple ID password to confirm.
162+
163+
> **Note:** You may still not be able to turn off Find My since having Stolen Device Protection on might prevent you from turning it off. Turn off Stolen Device Protection before trying to turn off Find My.
164+
165+
#### Steps
166+
1. Install SparseBox. This can be done with a variety of methods, but for the purposes of this, install it with SideStore. The latest version can be found [here](https://nightly.link/khanhduytran0/SparseBox/workflows/build/main/artifact.zip) (unzip artifact.zip for the .ipa file).
167+
168+
2. Tick on "Disable App Limit" in SideStore, and make sure SideStore is **closed** (not in background), then open SparseBox.
169+
170+
3. Enable StosVPN, select your pairing file and tap 'Bypass 3-app limit'. This should bring up a log output. Wait for it to say `idevicebackup2 exited with code -18` or `idevicebackup2 exited with code 2`, then close the app. No need to hit apply.
171+
172+
4. Re-open SideStore, and scroll down in SideStore settings. Press "clear cache", this will allow the exploit to be seen by SideStore.
173+
174+
5. Test that the exploit has worked (you may need to install more than one app to test, depending on how many free slots you have). If it throws an error about the limit, reopen SideStore or retry the exploit. If it installs the app, congratulations! You can now have more than 3 apps installed at one time.
175+
176+
#### Notes
177+
Due to certain limitations, this exploit must be done for every 3 additional apps you sideload.
178+
179+
If you want/need Find My for other purposes, you can now turn it back on. However, if you want to install or refresh more apps, you will need to turn it off again.
180+
181+
### MacDirtyCow (3-app limit)
182+
[MDC-Compatible IPA](https://cdn.discordapp.com/attachments/949183273827983370/1074037820328521829/SideStore_MDC_14.ipa)
183+
184+
The MDC version of SideStore above (bypass 3-app limit) is only compatible with iOS 15.0-16.1.2, and is very outdated, and so you may experience issues. If you want to have this feature, we reccomend you join our Discord and go to the [sidestore-downloads](https://discord.com/channels/949183273383395328/1126118099930861638) channel, which will contain MDC compatible SideStore builds. Then, [seperately install WDBRemoveThreeAppLimit with SideStore](https://github.com/zhuowei/WDBRemoveThreeAppLimit/releases/tag/v1.0) to apply the patch.

docs/advanced/jit.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,23 @@ description: A tutorial on how to enable Just-in-Time (JIT) Compilation for apps
44
---
55

66
:::note
7-
iOS 26 has broken JIT once again. An update has been released to StikDebug with a fix, but support is **very** limited. As of writing (Sep 16), the only supported apps are:
7+
iOS 26 has broken JIT once again. An update has been released to StikDebug with a fix, but support is limited. As of writing (Nov 10), the only supported apps are:
88
* UTM
99
* Amethyst
1010
* MeloNX
11-
* maciOS (not fully released)
11+
* maciOS
12+
* DolphiniOS (beta)
13+
* Geode
1214

1315
Please keep an eye on our announcements channel in our Discord server and on the [idevice server](https://discord.gg/mACqxMxP3X)'s announcements and compatibility channels for further updates.
1416

15-
There are many methods to enabling JIT, such as AltJIT, SideJITServer, and more. This tutorial will cover the use of StikDebug (formerly StikJIT), as it is the method we currently recommend. For more information, consult the [official StikDebug pairing guide](https://github.com/StephenDev0/StikDebug-Guide/blob/main/pairing_file.md).
17+
There are many methods to enabling JIT, depending on your iOS version. This tutorial will cover the use of StikDebug (formerly StikJIT), as it is the method we currently recommend. For more information, consult the [official StikDebug pairing guide](https://github.com/StephenDev0/StikDebug-Guide/blob/main/pairing_file.md).
1618

1719
As an alternative, SideStore 0.6.2 includes updates to minimuxer, allowing built-in JIT functionality similar to StikDebug. To use this, simply ensure you are connected to StosVPN with either Wi-Fi connected or Airplane Mode enabled, then navigate to "My Apps," longpress the app you wish to enable JIT for, and tap "enable JIT".
1820
:::
1921

2022
## Prerequisites
21-
* An iDevice running iOS/iPadOS 17.4-18.6, excluding 18.4b1. If you are on 17.0-17.3, you must use an alternative such as [SideJITServer](https://github.com/nythepegasus/SideJITServer). As stated above, versions newer than 18.6 are currently unsupported.
23+
* An iDevice running iOS/iPadOS 17.4-all iOS 18 versions, excluding 18.4b1. If you are on 17.0-17.3, you must use an alternative such as [SideJITServer](https://github.com/nythepegasus/SideJITServer). SideStore's JIT enabler will only work on iOS 26 if your device is about 4+ years old (non-TXM capable).
2224

2325
## StikDebug installation with Apple App Store
2426

@@ -37,7 +39,7 @@ As an alternative, SideStore 0.6.2 includes updates to minimuxer, allowing built
3739
Open and close StikDebug to build the app's folder in files, then import the same **pairing file** you use for SideStore using idevice pair. For more information on this process, see [here](https://github.com/StephenDev0/StikDebug-Guide/blob/main/pairing_file.md).
3840

3941
2. **Mount the DDI:**
40-
Open StikDebug with Wi-Fi and the VPN connected and the pairing file imported, then close it and reopen it. This mounts the DDI and must be performed every time you restart your idevice.
42+
Open StikDebug with Wi-Fi and the VPN connected and the pairing file imported, then close it and reopen it. This mounts the DDI and must be performed every time you restart your iDevice.
4143

4244
## To enable JIT:
4345

docs/advanced/pairing-file.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Pairing File
3+
description: A guide on manually reimporting your pairing file.
4+
---
5+
:::warning
6+
Caution, if you update or reset your iDevice, your pairing file will expire and you will need to reimport it. This also occurs at random times. This is simply because of how Apple's software works, and there is nothing we can do at this point to fix it. This guide instructs you how to manually replace your pairing file with iloader.
7+
:::
8+
9+
## Replacing your pairing file
10+
1. Make sure you have followed the steps in the [install guide](../installation/prerequisites) to install and setup iloader and SideStore.
11+
2. For best results, connect your iDevice to your computer via USB cable, but if your device only appears wirelessly, that should work too.
12+
3. Click "Manage Pairing File"
13+
4. To the right of "SideStore" and any other apps you wish, click "Place". "Pairing file placed successfully!" should appear in green.

docs/advanced/sparserestore.mdx

Lines changed: 0 additions & 43 deletions
This file was deleted.

0 commit comments

Comments
 (0)