Skip to content

Commit 63908d1

Browse files
authored
fix: refactor device/account terminology (#187)
* Rework prerequisites and installation pages * Attempt to fix trailing slash bug * Change references of "iDevice" to "iPhone, iPad, or iPod touch" / "iPhone or iPad" and references of "Apple ID" to "Apple Account" * Fix link to pairing file page * Remove accidentally re-added "Next Steps" section * Fix links to pairing file page in i18ns * Make link to prerequisites on pairing file page absolute * Fix remaining i18n links * Change "will" to "may"
1 parent dff3e24 commit 63908d1

File tree

29 files changed

+156
-163
lines changed

29 files changed

+156
-163
lines changed

docs/advanced/alternative.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import TabItem from '@theme/TabItem';
2222
Before you start, make sure to have installed usbmuxd.
2323
1. Ensure you have usbmuxd installed and updated by running `sudo apt install -y usbmuxd` in the Linux terminal.
2424
2. Install either Docker or Podman on your machine.
25-
3. Plug in your secondary iDevice. If you receive a prompt, select "trust" and enter your passcode.
25+
3. Plug in your secondary iPhone, iPad, or iPod touch. If you receive a prompt, select "Trust" and enter your passcode.
2626
4. Now, run Altcon with Docker or Podman using the following command (may require `sudo`):
2727

2828
Docker setup:
@@ -43,14 +43,14 @@ import TabItem from '@theme/TabItem';
4343
Steps:
4444
1. Setup AltServer on macOS/Windows using instructions above
4545
2. Install AltStore to one device using AltServer
46-
3. Sign in Apple ID in AltStore
46+
3. Sign in Apple Account in AltStore
4747
4. Export Certificate
4848
5. Delete AltStore
4949

5050
Then for each device:
51-
1. Install SideStore using AltServer with the same Apple ID (Hold [Option/Mac, Shift/Windows] when clicking AltServer -> Install IPA -> Select SideStore.ipa)
51+
1. Install SideStore using AltServer with the same Apple Account (Hold [Option/Mac, Shift/Windows] when clicking AltServer -> Install IPA -> Select SideStore.ipa)
5252
2. Import certificate
53-
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)
53+
3. Sign in Apple Account in SideStore (We need to sign in after importing the certificate otherwise it won't let you sign in without revoking AltStore's certificate)
5454
4. Sideload
5555

5656
When the old certificate expires:
@@ -69,7 +69,7 @@ The SideStore WireGuard VPN **only works on SideStore versions between 0.3.1-0.6
6969

7070
SideStore utilizes an on-device WireGuard VPN which allows SideStore to communicate with internal services.
7171

72-
1. Download the WireGuard app from the [Official App Store](https://apps.apple.com/us/app/wireguard/id1441195209).
72+
1. Download the WireGuard app from the [Apple App Store](https://apps.apple.com/app/wireguard/id1441195209).
7373
2. Also, download the WireGuard config found [here](https://github.com/SideStore/SideStore/releases/download/0.3.1/SideStore.conf).
7474
3. Open WireGuard, and press the 'Add a Tunnel' or '+' button.
7575
4. Select 'Create from file or archive', and choose the SideStore.conf file.
@@ -178,16 +178,16 @@ The SparseRestore "Bypass 3 app limit" exploit **only works on iOS/iPadOS versio
178178
:::
179179

180180
#### Prerequisites
181-
* An iDevice running versions supported by the SparseRestore exploit (see note above).
181+
* An iPhone or iPad running versions supported by the SparseRestore exploit (see note above).
182182
* At least 1 free app slot.
183183
* SideStore version 0.5.9 or later. You can find the latest versions [here](https://github.com/SideStore/SideStore/releases).
184-
* 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:
184+
* To perform this exploit, you MUST have **Find My** turned off on your iPhone or iPad during the process. It will not work otherwise. Here is how you can turn it off:
185185
- Open the Settings app.
186186
- Tap on your name at the top.
187187
- Tap on Find My.
188188
- Tap on Find My iPhone/iPad.
189189
- Turn off Find My iPhone/iPad.
190-
- You may be required to enter your Apple ID password to confirm.
190+
- You may be required to enter your Apple Account password to confirm.
191191

192192
> **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.
193193

docs/advanced/anisette.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ With this, it is **highly recommended** to use a v3 server for normal use of Sid
1111

1212
Anisette data is information used in the app signing process that needs to be generated each time you install or refresh apps. SideStore gets this information from a server that spoofs a Mac and sends you back the anisette data. No account info is sent to the server ever in this process.
1313

14-
When many people use the same Anisette server (specifically a v1 server), it trips Apple's security, and locks the accounts that were using that machine. This is why we recommended using a separate burner Apple ID instead of your main one.
14+
When many people use the same Anisette server (specifically a v1 server), it trips Apple's security, and locks the accounts that were using that machine. This is why we recommended using a separate burner Apple Account instead of your main one.
1515

1616
Our team has worked on better approaches to avoid locked accounts (in the form of _anisette-v3_). However, if you are using an older version of SideStore, hosting your own anisette server is a great way to avoid locked accounts. This is made incredibly easy thanks to our current server being open source and made for docker environments. This means we can deploy a server with nothing more than the GitHub link.
1717

docs/advanced/jit.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ As an alternative, SideStore 0.6.2 includes updates to minimuxer, allowing built
2020
:::
2121

2222
## Prerequisites
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).
23+
* An iPhone or iPad 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).
2424

2525
## StikDebug installation procedures:
2626

2727
1. **Install StikDebug**
28-
Install StikDebug from the [Apple App Store](https://apps.apple.com/us/app/stikdebug/id6744045754). Note: you can't sideload apps with VPNs on a free account.
28+
Install StikDebug [from the Apple App Store](https://apps.apple.com/app/stikdebug/id6744045754) or [from the AltStore PAL source](https://api.altstore.io/source/stikdebug.xyz/apps.json?app=com.stik.sj).
2929

30-
:::note Something nice- the VPN present in StikDebug functions the same as one used in SideStore, meaning you can also use it to install and refresh apps in SideStore, similar to LocalDevVPN.
30+
:::note The VPN present in StikDebug functions the same as one used in SideStore, meaning you can also use it to install and refresh apps in SideStore, similar to LocalDevVPN.
3131
:::
3232

3333
2. **Place the Pairing File:**

docs/advanced/pairing-file.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ title: Pairing File
33
description: A guide on manually reimporting your pairing file.
44
---
55
:::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.
6+
Your pairing file may expire and need to be reimported if you update or reset your iPhone, iPad, or iPod touch. This also occurs at random times. This is Apple's fault and there is nothing we can do to fix it. This guide instructs you how to manually replace your pairing file with iloader.
77
:::
88

99
## 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. If iloader prompts you to update it, click 'Yes'.
11-
2. For most reliable results, connect your iDevice to your computer via USB cable, but if your device only appears wirelessly, that should work too.
10+
1. Make sure you have followed the steps in the [install guide](/docs/installation/prerequisites) to install and setup iloader and SideStore. If iloader prompts you to update it, click 'Yes'.
11+
2. For most reliable results, connect your iPhone, iPad, or iPod touch to your computer via a USB cable. If your device only appears wirelessly, that should work too.
1212
3. Click 'Manage Pairing File'.
1313
4. To the right of "SideStore" and any other apps you wish, click 'Place'. "Pairing file placed successfully!" should appear in green.

docs/installation/install.mdx

Lines changed: 57 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,69 @@
11
---
22
title: Install
3-
description: Installing SideStore to your iDevice
3+
description: Installing SideStore to your iPhone, iPad, or iPod touch
44
sidebar_position: 2
55
---
6+
7+
```mdx-code-block
8+
import Tabs from '@theme/Tabs';
9+
import TabItem from '@theme/TabItem';
10+
```
11+
612
Before you start, make sure to download all software and complete all setup found in the [prerequisites page](prerequisites)!
713

814
## Installing SideStore
9-
### On your Computer
10-
1. Connect your iDevice to your computer via cable. If you are prompted, trust the computer and enter your passcode.
15+
### On your computer
16+
1. Connect your iPhone, iPad, or iPod touch to your computer via a USB cable. If you are prompted, trust the computer and enter your passcode.
1117
2. Open iloader.
12-
3. Sign in to an Apple Account (It doesn't need to be the account associated with the device. Remember that it is case-sensitive!).
13-
4. Select your iDevice.
18+
3. Sign in with your Apple Account. (It doesn't need to be the account associated with the device. Remember that it is case-sensitive!)
19+
4. Select your iPhone, iPad, or iPod touch.
1420
5. Select 'Install SideStore (Stable)'.
1521

16-
### On your iDevice
17-
1. Open the Settings app.
18-
2. Navigate to 'General', and then 'VPN & Device Management'.
19-
3. Approve the "Developer App" under the Apple Account's email.
20-
4. Navigate to 'Privacy and Security'.
21-
5. Scroll to the bottom, and turn on "Developer Mode". Your phone will restart.
22-
6. Open LocalDevVPN and select 'Connect'.
23-
7. Open SideStore.
24-
9. Sign in to the Apple Account you used with iloader.
25-
10. Navigate to 'My Apps'.
26-
11. Tap the '7 DAYS' counter to the right of SideStore to manually refresh it ("7" represents the number of days until an app's expiry, it will update dynamically to show the number of days left. Tap it to refresh the associated app.).
27-
12. If you receive a prompt asking to revoke or create a new signing certificate, tap 'Yes' or 'Refresh Now'.
28-
29-
If this process is successful, SideStore will open your device to your home screen (accompanied by a notification), and SideStore will be available again within a few seconds.
22+
### On your iPhone, iPad, or iPod touch
23+
<Tabs groupId="ios-versions">
24+
<TabItem value="15" label="iOS/iPadOS 15.0-15.8.5">
25+
1. Open the Settings app.
26+
2. Navigate to 'General', and then 'VPN & Device Management'.
27+
3. Under the "Developer App" section, select the option named after your Apple Account.
28+
4. Select "Trust [Apple Account name]", then select "Trust" to confirm.
29+
5. Open LocalDevVPN and select 'Connect'.
30+
6. Open SideStore.
31+
7. Sign in to the Apple Account you used with iloader.
32+
8. Navigate to 'My Apps'.
33+
9. Tap the '7 DAYS' counter to the right of SideStore to manually refresh it and finish setting up SideStore. (7 represents the number of days until an app's expiry. It will update dynamically to show the number of days left. Tap it to refresh the associated app.)
34+
10. If you receive a prompt asking to revoke or create a new signing certificate, tap 'Yes' or 'Refresh Now'.
35+
</TabItem>
36+
<TabItem value="16" label="iOS/iPadOS 16.0-17.7.7">
37+
1. Open the Settings app.
38+
2. Navigate to 'General', and then 'VPN & Device Management'.
39+
3. Under the "Developer App" section, select the option named after your Apple Account.
40+
4. Select "Trust [Apple Account name]", then select "Trust" to confirm.
41+
5. Navigate to 'Privacy and Security'.
42+
6. Scroll to the bottom, and turn on "Developer Mode". Your device will restart.
43+
7. Open LocalDevVPN and select 'Connect'.
44+
8. Open SideStore.
45+
9. Sign in to the Apple Account you used with iloader.
46+
10. Navigate to 'My Apps'.
47+
11. Tap the '7 DAYS' counter to the right of SideStore to manually refresh it and finish setting up SideStore. (7 represents the number of days until an app's expiry. It will update dynamically to show the number of days left. Tap it to refresh the associated app.)
48+
12. If you receive a prompt asking to revoke or create a new signing certificate, tap 'Yes' or 'Refresh Now'.
49+
</TabItem>
50+
<TabItem value="18" label="iOS/iPadOS 18.0-26.2" default>
51+
1. Open the Settings app.
52+
2. Navigate to 'General', and then 'VPN & Device Management'.
53+
3. Under the "Developer App" section, select the option named after your Apple Account.
54+
4. Select "Trust [Apple Account name]", then select "Allow & Restart".
55+
5. Enter your passcode to confirm you want to trust the app.
56+
6. Navigate to 'Privacy and Security'.
57+
7. Scroll to the bottom, and turn on "Developer Mode". Your device will restart.
58+
8. Open LocalDevVPN and select 'Connect'.
59+
9. Open SideStore.
60+
10. Sign in to the Apple Account you used with iloader.
61+
11. Navigate to 'My Apps'.
62+
12. Tap the '7 DAYS' counter to the right of SideStore to manually refresh it and finish setting up SideStore. (7 represents the number of days until an app's expiry. It will update dynamically to show the number of days left. Tap it to refresh the associated app.)
63+
13. If you receive a prompt asking to revoke or create a new signing certificate, tap 'Yes' or 'Refresh Now'.
64+
</TabItem>
65+
</Tabs>
3066

31-
Caution, if you update or reset your iDevice, your pairing file may expire, requiring you to replace it using [this guide](../advanced/pairing-file). This also occurs at random times because of Apple's software.
67+
If this process is successful, SideStore will open your device to your Home Screen (accompanied by a notification). SideStore will be available again within a few seconds.
3268

69+
Your pairing file may expire if you update or reset your iPhone, iPad, or iPod touch. If this happens, you'll need to replace it using [this guide](/docs/advanced/pairing-file). This also occurs at random times because of Apple's software.

docs/installation/prerequisites.mdx

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,18 @@ import Tabs from '@theme/Tabs';
99
import TabItem from '@theme/TabItem';
1010
```
1111

12-
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!
13-
1412
## Requirements
15-
1613
To install SideStore, you will need:
17-
18-
- An iPhone/iPad [with a passcode](https://support.apple.com/en-us/119586) running iOS/iPadOS 14 or higher
19-
- A computer (one-time)
20-
- An Apple Account
14+
- An iPhone, iPad, or iPod touch [with a passcode](https://support.apple.com/en-us/119586) running iOS/iPadOS 15.0 or higher
15+
- A computer running Windows 7 or higher, macOS High Sierra or higher, or an up-to-date Linux distribution; only for initial install
16+
- An Apple Account (also called an Apple ID)
2117
- A Wi-Fi connection
22-
- Some time (This is a quick process, but you should [leave time for troubleshooting](/docs/troubleshooting/))
18+
- Some time! This is a quick and easy process, but you should [leave time for troubleshooting](/docs/troubleshooting)
2319

2420
## Preparing Your Devices
25-
26-
### On your iPhone/iPad:
27-
2821
SideStore utilizes an on-device VPN which allows SideStore to communicate with internal services.
2922

30-
1. Install the LocalDevVPN app from the [Apple App Store](https://apps.apple.com/us/app/localdevvpn/id6755608044). If you are in the EU and it doesn't appear, you can try the [AltStore PAL source](https://intradeus.github.io/http-protocol-redirector?r=altstore-pal://source?url=https://adp.se2crid.me/). Note: you can't sideload VPNs properly on a free developer account.
23+
1. Install the LocalDevVPN app [from the Apple App Store](https://apps.apple.com/app/localdevvpn/id6755608044) or [from the AltStore PAL source](https://api.altstore.io/source/adp.se2crid.me?app=com.jkcoxson.LocalDevVPN).
3124
2. Connect to the VPN. If you are prompted to "Allow VPN Configurations", tap 'Allow' and enter your passcode.
3225

3326
This VPN is required to be turned on any time you wish to install, update, or refresh apps in SideStore.
@@ -36,15 +29,35 @@ Now, follow the instructions corresponding to your computer's OS:
3629

3730
<Tabs groupId="operating-systems">
3831
<TabItem value="mac" label="macOS">
39-
1. Download and install iloader for [Mac](https://github.com/nab138/iloader/releases/latest/download/iloader-darwin-universal.dmg).
32+
Download and install [iloader](https://github.com/nab138/iloader/releases/latest/download/iloader-darwin-universal.dmg).
4033
</TabItem>
4134
<TabItem value="win" label="Windows">
42-
1. Download and install [iTunes](https://apple.co/ms).
43-
2. Download the iloader installer ([.exe](https://github.com/nab138/iloader/releases/latest/download/iloader-windows-x64.exe) or [.msi](https://github.com/nab138/iloader/releases/latest/download/iloader-windows-x64.msi)). (Note: The iloader installer .exe is currently flagged as a virus/trojan, we are positive it's not and are looking into it, but in the meantime we recommend you download the .msi).
35+
:::warning
36+
32-bit versions of Windows, as well as Windows 10 on Arm, are not supported.
37+
38+
<details>
39+
<summary>**Most versions of Windows are 64-bit.** However, if you want to determine if you are using an unsupported version of Windows or not, you can follow these instructions.</summary>
40+
1. Open the Run dialog with Windows+R (or Command+R or Super+R).
41+
2. Enter `control /name microsoft.system`. The Control Panel will open.
42+
3. Under the "System" tab, locate "System type".
43+
44+
* If you have a "32-bit Operating System", your version of Windows is not supported.
45+
* If you have an "ARM64 processor" AND you're using Windows 10, your version of Windows is not supported.
46+
</details>
47+
:::
48+
49+
1. Download and install iTunes [from the Microsoft Store](https://apps.microsoft.com/store/detail/9PB2MZ1ZMB1S) or [directly from Apple](https://www.apple.com/itunes/download/win64).
50+
2. Download the iloader installer [as an MSI](https://github.com/nab138/iloader/releases/latest/download/iloader-windows-x64.msi) (recommended) or [as an EXE](https://github.com/nab138/iloader/releases/latest/download/iloader-windows-x64.exe).
4451
3. Run the installer.
4552
</TabItem>
4653
<TabItem value="linux" label="Linux">
47-
1. Download and install `usbmuxd` (may be preinstalled for your distro, otherwise install with your package manager).
48-
2. Download and install iloader for your distro ([.deb](https://github.com/nab138/iloader/releases/latest/download/iloader-linux-amd64.deb) for Debian/Ubuntu, [.rpm](https://github.com/nab138/iloader/releases/latest/download/iloader-linux-x86_64.rpm) for Fedora/openSUSE, [.AppImage](https://github.com/nab138/iloader/releases/latest/download/iloader-linux-amd64.AppImage) for other).
54+
:::warning
55+
Only 64-bit distributions are supported.
56+
57+
**Most Linux distributions are 64-bit.** To determine if you're using a 64-bit distribution, open a terminal and run `uname -m`. The expected output is `x86_64`.
58+
:::
59+
60+
1. Download and install `usbmuxd`. It may be preinstalled with your distribution, otherwise you can install it with your package manager: a Google search for "install usbmuxd [distribution name]" might help you.
61+
2. Download and install iloader for your distribution. It is available as a [DEB](https://github.com/nab138/iloader/releases/latest/download/iloader-linux-amd64.deb) for Debian/Ubuntu, [RPM](https://github.com/nab138/iloader/releases/latest/download/iloader-linux-x86_64.rpm) for Fedora/openSUSE, and as an [AppImage](https://github.com/nab138/iloader/releases/latest/download/iloader-linux-amd64.AppImage) for others. (There are also community-maintained packages, such as [this one on the Arch Linux AUR](https://aur.archlinux.org/packages/iloader-bin), but please know that we cannot guarantee their safety or security. You should always do your due diligence before installing unknown packages onto your system.)
4962
</TabItem>
50-
</Tabs>
63+
</Tabs>

0 commit comments

Comments
 (0)