Skip to content

Commit e5a0d51

Browse files
authored
Merge pull request #115 from CelloSerenity/main
Adds iDevicePair instructions for macOS and Windows + some fixes
2 parents 689a543 + 964c1fd commit e5a0d51

File tree

12 files changed

+91
-101
lines changed

12 files changed

+91
-101
lines changed

docs/advanced/app-sources.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ description: A guide on custom app sources.
55

66
# Make a Source
77

8-
SideStore is fully compatible with AltSources. The official AltStore [source documentation](https://faq.altstore.io/developers/make-a-source) provides all the details you need to make your own AltSource. AltSources allow your audience to view, install, and update all your available apps easily across both AltStore and SideStore.
8+
SideStore is fully compatible with AltStore Sources (or AltSources). The official AltSource [documentation](https://faq.altstore.io/developers/make-a-source) provides all the details you need to make your own AltSource. AltSources allow your audience to view, install, and update all your available apps easily using either AltStore and SideStore.
99

10-
When editing your source, it is highly recommended to create and view a draft of your changes using the [AltSource Browser](https://altsource.by.lao.sb/browse) to see a visual display of your source and correct any errors before finalizing and publishing changes to your source.
10+
Here are some recommended third-party tools that can assist in creating viewing your AltSources:
11+
- You can use the community-built [AltStudio](https://altstudio.app/) (WIP) to generate you an AltSource automatically using an IPA!
12+
- You can use the community-built [AltSource Browser](https://altsource.by.lao.sb/browse/) to view a visual display of your updates to an AltSource draft before finalizing your changes, allowing you to correct any errors before publishing them!
1113

1214
# Distributing your Source
1315

@@ -19,4 +21,4 @@ For more info, see [URL Schema](/docs/advanced/url-schema). It is often helpful
1921

2022
## That's it!
2123

22-
Here are some good existing AltSources: The [official AltStore](https://apps.altstore.io) source, the [SideStore community](https://github.com/SideStore/Community-Source) source, the [StikJIT](https://raw.githubusercontent.com/StephenDev0/StikJIT/refs/heads/main/repo.json) source, and the [DolphiniOS](https://altstore.oatmealdome.me) source.
24+
Here are some good existing AltSources you can copy-and-paste into SideStore: The [SideStore Community Source](https://github.com/SideStore/Community-Source), the [official AltStore Source](https://apps.altstore.io), the [StikDebug Source](https://raw.githubusercontent.com/StephenDev0/StikDebug/refs/heads/main/repo.json) source, the [LiveContainer Source](https://raw.githubusercontent.com/LiveContainer/LiveContainer/refs/heads/main/apps.json), and the [DolphiniOS Source](https://altstore.oatmealdome.me).

docs/advanced/jit.mdx

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,47 +5,48 @@ description: A tutorial on how to enable Just-in-Time (JIT) Compilation for apps
55

66
:::note
77

8-
There are many methods to enabling JIT, such as AltJIT, SideJITServer, and more. This tutorial will cover the use of StikJIT/StikDebug, as it is the method we currently recommend. As an alternative, SideStore 0.6.2-nightly.2025.04.15 also includes updates to minimuxer, allowing built-in JIT functionality similar to StikDebug. To use this, simply ensure you are connected to StosVPN and Wi-Fi or with mobile data and Wi-Fi disabled.
8+
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. As an alternative, SideStore 0.6.2-nightly.2025.04.15 also includes updates to minimuxer, allowing built-in JIT functionality similar to StikDebug. To use this, simply ensure you are connected to StosVPN and Wi-Fi or with mobile data and Wi-Fi disabled.
99
:::
1010

1111
## Prerequisites
1212
* An iDevice on iOS/iPadOS 17.4 or above, excluding 18.4b1. If you are on 17.0-17.3, you must use an alternative such as [SideJITServer](https://github.com/nythepegasus/SideJITServer)
13-
* At least 1 free app slot for StikJIT
13+
* At least 1 free app slot (if sideloading)
1414

15-
## StikJIT installation with SideStore
16-
17-
1. **Obtain StikJIT:**
18-
Add the StikJIT AltSource to SideStore [here](sidestore://source?url=https://raw.githubusercontent.com/StephenDev0/StikJIT/refs/heads/main/repo.json) (You must have SideStore installed or this link will not function).
15+
## StikDebug installation with Apple App Store (Doesn't require an app slot)
1916

20-
2. **Install:**
21-
Use SideStore to install StikJIT.
17+
1. **Install StikDebug**
18+
Install StikDebug from the [Apple App Store](https://apps.apple.com/us/app/stikdebug/id6744045754). Something nice- the VPN present in StikDebug is similar to the one used in SideStore, meaning you use it to install and refresh apps as well.
2219

23-
3. **Installation procedures:**
20+
2. **Installation procedures:**
2421
Follow the standard installation procedures in the usage guide below.
2522

26-
## StikDebug installation with App Store (Doesn't require an app slot)
23+
## StikDebug installation with SideStore
24+
25+
1. **Obtain StiDebug:**
26+
Add the StikJIT AltSource to SideStore [here](sidestore://source?url=https://raw.githubusercontent.com/StephenDev0/StikDebug/refs/heads/main/repo.json) (You must have SideStore installed or this link will not function).
2727

28-
1. **Install StikDebug**
29-
Install StikDebug from the App Store [here](https://apps.apple.com/us/app/stikdebug/id6744045754). Something nice- the VPN present in StikDebug is similar to the one used in SideStore, meaning you use it to install and refresh apps as well.
28+
2. **Install:**
29+
Use SideStore to install StikDebug.
3030

31-
2. **Installation procedures:**
31+
3. **Installation procedures:**
3232
Follow the standard installation procedures in the usage guide below.
3333

34+
3435
### Standard installation procedures:
3536

3637
1. **Enable VPN:**
37-
Start by activating StosVPN for StikJIT or the built-in VPN in StikDebug.
38+
Start by activating StosVPN (if sideloading StikDebug) or the built-in VPN in the official StikDebug.
3839

3940
2. **Upload the Pairing File:**
40-
When prompted, import the same **unzipped pairing file** obtained via JitterbugPair you use for SideStore. For more information on obtaining this pairing file, see [here](/docs/installation/pairing-file).
41+
Import the same **pairing file** you use for SideStore using iDevicePair. For more information on obtaining this pairing file, see [here](/docs/installation/pairing-file).
4142

4243
## To enable JIT:
4344

4445
1. **Enable VPN:**
45-
Start by activating StosVPN for StikJIT or the built-in VPN in StikDebug.
46+
Start by activating StosVPN (if sideloading) or the built-in VPN in StikDebug.
4647

4748
2. **Activate JIT:**
48-
Click the “Enable JIT” button and select an app from the list to activate the JIT functionality.
49+
Select the “Enable JIT” button and select an app from the list to attach a debugger/activate JIT functionality.
4950

5051
### Offline JIT Enabling
51-
To enable JIT offline, enable the StosVPN VPN or StikDebug. Then, turn both Wi-Fi and Mobile Data OFF when you launch StikJIT (use Airplane Mode). You can then enable JIT as normal.
52+
To enable JIT offline, activate StosVPN (if sideloading) or the StikDebug VPN. Then, turn both Wi-Fi and Mobile Data OFF when you launch StikDebug (use Airplane Mode). You can then enable JIT as normal.

docs/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ SideStore is an iOS application that allows you to sideload apps onto your iOS d
1818

1919
For users using iOS/iPadOS 16 or lower, you can activate JIT directly from the SideStore 'My Apps' page by holding down on your app and selecting 'Enable JIT'.
2020

21-
Users on iOS or iPadOS 17.4 or higher will need to use a solution such as StikJIT/StikDebug or SideStore nightly. Please refer to the tutorial in the [Advanced](advanced/jit) section.
21+
Users on iOS or iPadOS 17.4 or higher will need to use a solution such as StikDebug (formerly StikJIT) or SideStore nightly. Please refer to the tutorial in the [Advanced](advanced/jit) section.
2222

2323
### When will SideStore release?
2424

docs/installation/mac.mdx

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

77
Before you start, make sure to have all steps completed found in the [Prerequisites](prerequisites), and that you have a [pairing file](pairing-file)!
88

9-
1. Download and run AltServer from [AltStore's website](https://AltStore.io).
9+
1. Download AltServer from [AltStore's website](https://cdn.altstore.io/file/altstore/altserver.zip). Copy AltServer.app to your /Applications folder, then run it. It should appear as an icon in your menu bar.
1010
2. Download the SideStore IPA which you can find [here](https://github.com/sidestore/sidestore/releases/latest/download/sidestore.ipa).
11-
3. Hold option/alt and click on the AltServer menu bar icon. Click "Sideload .ipa", and select the SideStore IPA file.
12-
4. Approve the "Developer App" with your Apple ID's email.
11+
3. Hold option and click on the AltServer menu bar icon. Click "Sideload .ipa", and select the SideStore IPA file.
12+
4. Approve the "Developer App" with your Apple ID's email on your secondary device.
1313
* You can find this in Settings, under "General", and then "VPN & Device Management".
1414
5. Open SideStore, select your pairing file, and sign in with your Apple ID.
1515

16-
When you finish, then follow the [post-install instructions](post-install).
16+
When you finish, follow the [post-install instructions](installation/post-install).

docs/installation/pairing-file.mdx

Lines changed: 32 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -4,64 +4,49 @@ description: Pairing files are essential to SideStore's functionality.
44
sidebar_position: 2
55
---
66

7-
Using JitterbugPair (*not* the Jitterbug app) allows us to create a pairing file for programs like SideStore to talk to your device. This is required to use SideStore, or it will not function.
7+
iDevicePair 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.
88

9-
Download JitterbugPair for [Windows (64-bit)](https://github.com/osy/Jitterbug/releases/download/v1.3.1/jitterbugpair-win64.zip), [macOS](https://github.com/SideStore/SideStore-Docs/releases/download/need-a-place-to-put-jittterbug/jitterbugpair), or [Linux](https://github.com/osy/Jitterbug/releases/download/v1.3.1/jitterbugpair-linux.zip).
9+
Download iDevicePair for [Windows (64-bit)](https://github.com/jkcoxson/idevice_pair/releases/latest/download/iDevicePair--windows-x86_64.exe), [macOS](https://github.com/jkcoxson/idevice_pair/releases/latest/download/iDevicePair--macos-universal.dmg), or 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)).
1010

1111
## Pairing Instructions
1212

13-
:::tip
14-
15-
When using cloud storage, the file extension might change (usually to .txt). It is always recommended to zip your pairing file before transferring it. SideStore only accepts .mobiledevicepairing files.
16-
:::
17-
1813
### Windows
1914

20-
1. Extract the JitterbugPair zip file.
21-
2. Plug your device into your computer, and open your device to its home screen. Once done, execute the program.
22-
* Your device may ask you to trust your computer. Make sure to accept this prompt, as it is required for the pairing process.
23-
3. Once it is done, you will get a file that ends with `.mobiledevicepairing`.
24-
4. Transfer this file to your device using iTunes, or any other method. Zipping the file before sending it off is the best way to ensure the pairing file won't break during transport.
25-
* Transferring using cloud storage may change the file's extension (most likely turning into a .txt file), so be careful. It is also possible to change the extension to `.plist` for use with older SideStore versions, like `0.1.1`.
26-
27-
On Windows, you might have to execute the program using Command Prompt or Powershell, as it can sometimes not open by double clicking the `.exe` file.
28-
29-
5. In File Explorer, navigate to the folder where jitterbugpair is located.
30-
6. 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.
31-
7. From there, type `./jitterbugpair.exe` and press enter while your device is plugged in.
32-
15+
1. Install iTunes from Apple's website ([64-bit](https://apple.com/itunes/download/win64) or [32-bit](https://apple.com/itunes/download/win32)).
16+
2. Download `iDevicePair--windows-x86_64.exe` (move it somewhere you won't lose it).
17+
3. Connect your secondary device to your computer via cable. If a prompt appears, tap "trust" and type in your passcode.
18+
4. Unlock your device, open iDevicePair, and select your device in the drop-down menu.
19+
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.
20+
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.
3321

3422
### macOS
3523

36-
1. **Extract** `Jitterbugpair-macos.zip`.
37-
2. **Set a passcode** for your device if you haven't already. Unlock your device, connect it to your computer via cable. If a prompt appears: tap "Trust."
38-
3. Open your device to the homescreen.
39-
4. Find the extracted `jitterbugpair` file (it should have a black and green icon).
40-
5. Open Terminal (in Launchpad, it's in the "Utilities" folder).
41-
6. Drag the `jitterbugpair` file into Terminal and press "Return" or Enter.
42-
7. If you get "macOS cannot verify that this app is free from malware":
43-
- Go to System Settings > Privacy & Security
44-
- Scroll down to the message about the app
45-
- Click "Open Anyway"
46-
- Try running the program again
47-
8. JitterBugPair will generate a **pairing file** with the extension `.mobiledevicepairing`.
48-
9. If you can't find the pairing file:
49-
- Copy the name of the pairing file generated
50-
- Paste it into Finder
51-
- If you ran the program more than once all pairing files for your device should appear since they share the same name
52-
10. **Transfer the pairing file** to your iOS device using AirDrop, iCloud/One/Google Drive, email, or any other method. For best results, compress the file into a .zip folder first.
24+
1. Download `iDevicePair--macos-universal.dmg`. Open the file and drag "iDevicePair" to your Applications folder.
25+
3. Connect your secondary device to your computer via cable. If a prompt appears, tap "trust" and type in your passcode.
26+
4. Unlock your device, open iDevicePair, and select your device in the drop-down menu.
27+
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.
28+
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.
5329

5430
### Linux
5531

56-
These instructions expect that you are familiar with the linux commandline.
57-
58-
1. Extract the Jitterbug zip file, and open a terminal (if you haven't already) to the extracted directory.
59-
2. In that terminal, run `chmod +x ./jitterbugpair`
60-
3. Plug your device into your computer, and open your device to its home screen. Once done, execute the program in your terminal with `./jitterbugpair`
61-
* If you get a prompt saying you need to trust the computer from your iDevice, make sure to do so. You may need to rerun jitterbugpair.
62-
4. Once it is done, you will get a file that ends with `.mobiledevicepairing` in the directory you ran jitterbugpair from.
63-
5. Transfer this file to your device in a way of your choosing. Zipping the file before sending it off is the best way to ensure the pairing file won't break during transport
64-
* Transferring using cloud storage may change the file's extension (most likely turning into a .txt file), so be careful. It is also possible to change the extension to `.plist` for use with older SideStore versions, like `0.1.1`.
32+
:::note
33+
The iDevicePair instructions for Linux are a work-in-progress. For now, instructions to create a pairing file using JitterbugPair for Linux are below!
34+
:::
6535

66-
You might have success by just adding execute permissions and running jitterbugpair from a file manager, but it is recommended to just do it from the terminal.
36+
These instructions expect that you are familiar with the linux commandline.
6737

38+
1. **Download** `jitterbugpair-linux.zip` from [here](https://github.com/osy/Jitterbug/releases/download/v1.3.1/jitterbugpair-linux.zip), then extract it.
39+
2. Open a terminal in the extracted directory.
40+
3. Make the program executable:
41+
```bash
42+
chmod +x ./jitterbugpair
43+
```
44+
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.
45+
5. Open your device to the homescreen.
46+
6. Execute the program:
47+
```bash
48+
./jitterbugpair
49+
```
50+
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.
51+
8. JitterbugPair will generate a **pairing file** with the extension `.mobiledevicepairing`.
52+
9. 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.

docs/installation/post-install.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,17 @@ title: Post-Install Instructions
33
description: Almost there, just a few more steps!
44
sidebar_position: 6
55
---
6-
The last step to installing SideStore is to refresh SideStore, within itself.
6+
The last step to installing SideStore is to refresh SideStore within itself.
77

88
To do this, you need to:
99

1010
1. Connect to StosVPN.
1111
2. Open SideStore.
1212
3. If you haven't already, select the pairing file.
13-
4. Go to "My Apps".
14-
5. Select the "x DAYS" button, where x is the number of days until expire.
15-
* If successful, this will open a blank Safari tab or go to your home screen. You will get a notification also telling you to do this.
13+
4. Navigate to "My Apps".
14+
5. Select the "x DAYS" button, (x is the number of days until expiry). A prompt asking about your signing certificate should appear, tap "Refresh Now". If a prompt appears asking you if you want to revoke a certificate from AltStore, tap "yes".
15+
* If successful, this will open a blank Safari tab or open to your home screen, accompanied by a notification notating this.
1616

1717
If SideStore is not refreshed, a bug causing early expiry will require you to reinstall SideStore. There is a plan to have this done automatically, but for now it needs to be done manually.
18+
19+
If you reinstall SideStore or install it on another device under the same Apple ID using AltServer, your certificate will be revoked and you will need to refresh it manually again as shown above (on both devices, if applicable).

docs/installation/prerequisites.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ description: 'The first steps of installation.'
44
sidebar_position: 1
55
---
66

7-
SideStore's installation process can seem tricky, but with the ***one-time*** use of a computer, and some time, you'll have SideStore on your device!
7+
SideStore's installation process may seem tricky, but with the ***one-time*** use of a computer and some time, you'll have SideStore on your device!
88

99
## Requirements
1010

1111
To install SideStore, you will need:
12-
- An iOS or iPadOS device running iOS or iPadOS 14 or higher.
12+
- An iPhone or iPad [with a passcode](https://support.apple.com/en-us/119586) running iOS/iPadOS 14 or higher.
1313
- A Windows, macOS, or Linux computer (Linux support is experimental).
1414
- An Apple ID.
1515
- The StosVPN app.
@@ -26,10 +26,10 @@ Users of iOS/iPadOS 16 or higher *must* have Developer Mode enabled. Do this by:
2626

2727
SideStore utilizes an on-device VPN which allows SideStore to communicate with internal services.
2828

29-
1. Download the StosVPN app from the [Official App Store](https://apps.apple.com/us/app/stosvpn/id6744003051).
29+
1. Download the StosVPN app from the [Apple App Store](https://apps.apple.com/us/app/stosvpn/id6744003051).
3030
2. Enable the VPN.
3131

32-
This VPN is required to be on any time you wish to install or update apps in SideStore.
32+
This VPN is required to be turned on any time you wish to install or update apps in SideStore.
3333

3434
## Next Steps
3535

0 commit comments

Comments
 (0)