Merge pull request #131 from CelloSerenity/main

idevice pair instructions for Linux + other fixes

Author: polymo1

docs/advanced/app-sources.mdx

@@ -5,10 +5,10 @@ description: A guide on custom app sources.
 
 # Make a Source
 
-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.
+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.
 
 Here are some recommended third-party tools that can assist in creating viewing your AltSources:
-- You can use the community-built [AltStudio](https://altstudio.app/) (WIP) to generate you an AltSource automatically using an IPA!
+- You can use the community-built [AltStudio](https://altstudio.app/) (WIP) to generate you an AltSource automatically using an IPA! (Caution- After using AltStudio to create a source, you must remove the autogenerated-by-default marketplaceID and Build fields, otherwise SideStore will believe it to be a notarized source and prevent your source being added)
 - 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!
 
 # Distributing your Source
@@ -17,8 +17,8 @@ You can create a link to automatically add your AltSource by using this template
 ```
 sidestore://source?url=[source url]
 ```
-For more info, see [URL Schema](/docs/advanced/url-schema). It is often helpful to create the link to your AltSource in this format, then put it into a link shortener such as ```tinyurl.com```. However, if a user tries to use a sidestore:// link without SideStore already installed, it will crash, so some documentation may be helpful.
+For more info, see [URL Schema](/docs/advanced/url-schema). It is often helpful to create the link to your AltSource in this format, then put it into a link shortener such as `tinyurl.com`. However, if a user tries to use a `sidestore://` link without SideStore already installed, it will crash, so some documentation may be helpful.
 
 ## That's it!
 
-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).
+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 [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

@@ -5,7 +5,9 @@ description: A tutorial on how to enable Just-in-Time (JIT) Compilation for apps
 
 :::note
 
-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.
+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). 
+
+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 with either Wi-Fi enabled/connected or with mobile data and Wi-Fi disabled (Airplane Mode).
 :::
 
 ## Prerequisites
@@ -20,17 +22,6 @@ There are many methods to enabling JIT, such as AltJIT, SideJITServer, and more.
 2. **Installation procedures:**
    Follow the standard installation procedures in the usage guide below.
 
-## StikDebug installation with SideStore
-   
-1. **Obtain StiDebug:**  
-   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).
-
-2. **Install:**
-   Use SideStore to install StikDebug.
-
-3. **Installation procedures:**
-   Follow the standard installation procedures in the usage guide below.
-
 
 ### Standard installation procedures:
 
@@ -43,10 +34,10 @@ There are many methods to enabling JIT, such as AltJIT, SideJITServer, and more.
 ## To enable JIT:
 
 1. **Enable VPN:**  
-   Start by activating StosVPN (if sideloading) or the built-in VPN in StikDebug.
+   Start by activating the built-in VPN in StikDebug.
 
 2. **Activate JIT:**  
-   Select the “Enable JIT” button and select an app from the list to attach a debugger/activate JIT functionality.
+   Select the “Enable JIT” button and select an app from the list (must be sideloaded with proper entitlements to appear in the list) to attach a debugger/activate JIT functionality.
 
 ### Offline JIT Enabling
 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/advanced/sparserestore.mdx

@@ -40,4 +40,4 @@ Due to certain limitations, this exploit must be done for every 3 additional app
 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.
 
 ## Alternatives
-If either the exploit doesn't work for you, or your iDevice is on an unsupported version, there is an alternative to be able to use more than 3 apps at once. LiveContainer, developed by Duy Tran Khanh ([khanhduytran0](https://github.com/khanhduytran0)) (the person who also made SparseBox), allows for iOS apps to be run in containers in-app rather than installing them separately. This may also be easier to use over SparseRestore in some cases. The GitHub page can be found [here](https://github.com/khanhduytran0/LiveContainer).
+If either the exploit doesn't work for you, or your iDevice is on an unsupported version, there is an alternative to be able to use more than 3 apps at once. [LiveContainer](https://livecontainer.github.io/), developed by Duy Tran Khanh ([khanhduytran0](https://github.com/khanhduytran0)) (the person who also made SparseBox), allows for iOS apps to be run in containers in-app rather than installing them separately. This may also be easier to use over SparseRestore in some cases. The GitHub page can be found [here](https://github.com/khanhduytran0/LiveContainer).

docs/faq.mdx

@@ -40,10 +40,6 @@ It does not, as it's only connecting to your own device. No remote servers are u
 
 It does not, as there is no remote server used.
 
-### I cannot connect to the internet when the VPN is on
-
-Make sure you don't have an alternate DNS set up in your Wi-Fi and WireGuard configuration. If you know the DNS IP address works, then try removing it from your Wi-Fi configuration and adding it into the WireGuard config under DNS.
-
 ### Updating SideStore hangs towards the end
 
 Go to the homescreen for it to finish. We don't know why this happens, but it might have to do with using a VPN to direct `installd` to refresh SideStore (itself).

docs/installation/linux.mdx

@@ -1,21 +1,28 @@
 ---
 title: Linux Instructions
 description: Instructions for installing SideStore using Linux
-sidebar_position: 5
+sidebar_position: 4
 ---
 
-To install SideStore (or any other IPA) on Linux, make sure you have Docker installed. Before you start, make sure to install StosVPN and any other and [prerequisites](prerequisites) that are satisfied!
+Before you start, make sure to have all steps completed found in the [prerequisites](prerequisites)!
 
-1. Run altcon with Docker
+1. The following commands will install usbmuxd and docker. Run these as a non-root user on your machine and you will only have to do this once.
 ```bash
-docker run --rm -it -e ALTSERVER_ANISETTE_SERVER="https://ani.sidestore.io/" -v ${PWD}/:/mnt/ -v /var/run:/var/run ghcr.io/sidestore/altcon
+sudo apt install -y usbmuxd
+curl -fsSL https://test.docker.com -o test-docker.sh
+sudo sh test-docker.sh
+sudo usermod -aG docker $USER
 ```
-
-You can also run altcon with Podman
+2. Restart your shell to ensure changes are made. Now, plug in your iDevice. If you recieve a prompt, select "trust" and enter your passcode. Now, run Altcon with Docker using this code (must be run every time to install SideStore):
 ```bash
-podman run --privileged --rm -it -e ALTSERVER_ANISETTE_SERVER="https://ani.sidestore.io/" -v ${PWD}/:/mnt/ -v /var/run:/var/run ghcr.io/sidestore/altcon
+docker 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:
+    * 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.
 
-Altcon will start to pair with your device, plug it in if you haven't. Press "trust" and enter your passcode.
-
-When you finish, then follow the [post-install instructions](post-install).
+Now, proceed to generate your [pairing file](pairing-file).

docs/installation/mac.mdx

@@ -1,16 +1,19 @@
 ---
 title: macOS Instructions
 description: Instructions for installing SideStore using macOS
-sidebar_position: 4
+sidebar_position: 2
 ---
 
-Before you start, make sure to have all steps completed found in the [Prerequisites](prerequisites), and that you have a [pairing file](pairing-file)!
+Before you start, make sure to have all steps completed found in the [prerequisites](prerequisites)!
 
-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.
+1. Download AltServer from [AltStore's website](https://cdn.altstore.io/file/altstore/altserver.zip). Copy AltServer.app to your `Applications` folder, then open it (using Finder, Launchpad, or Spotlight). It should appear as an icon in your menu bar.
 2. Download the SideStore IPA which you can find [here](https://github.com/sidestore/sidestore/releases/latest/download/sidestore.ipa).
 3. Hold option and click on the AltServer menu bar icon. Click "Sideload .ipa", and select the SideStore IPA file.
-4. Approve the "Developer App" with your Apple ID's email on your secondary device.
-    * You can find this in Settings, under "General", and then "VPN & Device Management".
-5. Open SideStore, select your pairing file, and sign in with your Apple ID.
+4. 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.
 
-When you finish, follow the [post-install instructions](post-install).
+Now, proceed to generate your [pairing file](pairing-file).

docs/installation/pairing-file.mdx

@@ -1,52 +1,49 @@
 ---
 title: Pairing File
 description: Pairing files are essential to SideStore's functionality.
-sidebar_position: 2
+sidebar_position: 5
 ---
 
-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.
+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.
+:::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.
+:::
 
-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)).
+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
 
-### Windows
+### 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. Install iTunes from Apple's website ([64-bit](https://apple.com/itunes/download/win64) or [32-bit](https://apple.com/itunes/download/win32)).
+### Windows (64-bit)
+
+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, open iDevicePair, and select your device in the drop-down menu.
+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.
 
-### macOS
+### Linux
 
-1. Download `iDevicePair--macos-universal.dmg`. Open the file and drag "iDevicePair" to your Applications folder.
+1. If not already installed for Altcon, in the linux commandline, run the following code to install usbmuxd:
+```bash
+sudo apt install -y usbmuxd
+```
+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, open iDevicePair, and select your device in the drop-down menu.
+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.
 
-### Linux
-
-:::note
-The iDevicePair instructions for Linux are a work-in-progress. For now, instructions to create a pairing file using JitterbugPair for Linux are below!
-:::
-
-These instructions expect that you are familiar with the linux commandline.
-
-1. **Download** `jitterbugpair-linux.zip` from [here](https://github.com/osy/Jitterbug/releases/download/v1.3.1/jitterbugpair-linux.zip), then extract it.
-2. Open a terminal in the extracted directory.
-3. Make the program executable:
-   ```bash
-   chmod +x ./jitterbugpair
-   ```
-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.
-5. Open your device to the homescreen.
-6. Execute the program:
-   ```bash
-   ./jitterbugpair
-   ```
-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.
-8. JitterbugPair will generate a **pairing file** with the extension `.mobiledevicepairing`.
-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.
+## Next steps
+Now, follow the [post-install instructions](post-install).

docs/installation/post-install.mdx

@@ -9,11 +9,12 @@ To do this, you need to:
 
 1. Connect to StosVPN.
 2. Open SideStore.
-3. If you haven't already, select the pairing file.
-4. Navigate to "My Apps".
-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".
-    * If successful, this will open a blank Safari tab or open to your home screen, accompanied by a notification notating this.
+3. If you haven't already, select your pairing file.
+4. Sign in with your Apple ID.
+5. Navigate to "My Apps".
+6. Tap the "x DAYS" button to the right of SideStore, (x is the number of days until an app's 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".
+    * If successful, this will open your device to your home screen, accompanied by a notification from SideStore documenting this behavior.
 
 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.
 
-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).
+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 all devices, if applicable).