mirror of
https://github.com/palera1n/palera1n.git
synced 2026-10-23 18:49:48 +02:00
readme improvements (#356)
* Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md
This commit is contained in:
flower authored and 
GitHub committed
1 parent
ee8dd9f02d
commit
5e718b2929
1 file changed
+58
-89
@@ -1,129 +1,98 @@
|
||||
<h1 align="center">
|
||||
<img src="https://avatars.githubusercontent.com/u/114239186?s=100&v=4" alt="palera1n logo">
|
||||
<p>palera1n</p>
|
||||
</h1>
|
||||
<h3 align="center">An iOS 15.0-16.3 work-in-progress, (semi-)tethered checkm8 jailbreak.</h3>
|
||||
<p align="center">
|
||||
<strong><a href="CHANGELOG.md">Change Log</a></strong>
|
||||
<img align="left" height="120" src="https://cdn.discordapp.com/attachments/1017854329887129611/1073858292159352862/thing.png" alt="palera1n logo" style="float: left;"/>
|
||||
<h3 align="right">An iOS 15.0-16.3 work-in-progress, <br>(semi-)tethered checkm8 jailbreak</h3>
|
||||
|
||||
<p align="right" >
|
||||
<strong><a href="https://ios.cfw.guide/installing-palera1n">Guide</a></strong>
|
||||
•
|
||||
<strong><a href="COMMONISSUES.md">Common Issues</a></strong>
|
||||
•
|
||||
<strong><a href="CHANGELOG.md">Changelog</a></strong>
|
||||
•
|
||||
<strong><a href="https://dsc.gg/palera1n">Discord</a></strong>
|
||||
•
|
||||
<strong><a href="https://twitter.com/palera1n">Twitter</a></strong>
|
||||
</p>
|
||||
<div class="clear"></div>
|
||||
|
||||
# How does it work?
|
||||
|
||||
It boots the device with multiple patches required. On first run, it'll boot a ramdisk which dumps your onboard blob, creates a fakefs (if using semi-tethered), installs the loader app, and patches your kernel.
|
||||
It boots the device with multiple patches required. On first run, it'll boot a ramdisk which dumps your onboard blob, creates a fakefs (if using semi-tethered), installs the loader app, and patches your kernel.
|
||||
|
||||
# Warnings
|
||||
- We are **NOT** responsible for any data loss, or the result of a device being bricked. The user of this program accepts responsibility should something happen to their device. While nothing should happen, jailbreaking has risks in itself. If your device refuses to boot after using palera1n please use `iTunes` or `Finder` to restore iOS (or if you used tethered, use `--restorerootfs` at the end of your palera1n command).
|
||||
|
||||
- palera1n will never work in VirtualBox, VMware or any virtual machine that doesn't support a PCI passthrough.
|
||||
|
||||
# Requirements
|
||||
|
||||
- A checkm8 vulnerable iOS device on iOS 15 or 16 (A8-A11)
|
||||
- The device must be on iOS 15.0-16.3
|
||||
- **palera1n will never work with devices above the iPhone X/A11.** Please stop asking in the Discord, and remember: *this is mainly a developer jailbreak*
|
||||
- Needs a checkm8 vulnerable iOS device on iOS 15.x or 16.x (`A8` - `A11`)
|
||||
- If you want the device to be semi-tethered, **you will need 5-10GB of space** for the fakefs. This means that 16GB devices cannot be semi-tethered
|
||||
- ### A10 and A11 devices
|
||||
- If you are on A10(X), use [checkp4le](https://github.com/guacaplushy/checkp4le) instead for full SEP functionality (Passcode, TouchID, Apple Pay)
|
||||
- On A11, **you must disable your passcode while in the jailbroken state**.
|
||||
- On iOS 16 A11, if you EVER enabled a passcode on 16, you have to reset through the settings app/restore with a computer
|
||||
- In the meantime, we recommend [FakePass](https://repo.alexia.lol/depictions/net.cadoth.fakepass) if you would like a passcode
|
||||
- If you are on `A10(X)`, use [checkp4le](https://github.com/guacaplushy/checkp4le) instead for full SEP functionality (Passcode, TouchID, Apple Pay)
|
||||
- On `A11`, **you must disable your passcode while in the jailbroken state** (on iOS 16, you need to reset your device before proceeding with palera1n `A11`).
|
||||
|
||||
- A **USB-A to Lightning cable**
|
||||
- USB-C cables
|
||||
- 
|
||||
- **USB-A** cables are recommended to use, USB-C may have issues with palera1n and getting into DFU mode.
|
||||
|
||||
- A Linux or macOS computer
|
||||
- Python 3 must be installed.
|
||||
- This must be a **physical computer**. Virtual machines **do not work.**
|
||||
- AMD CPUs have an issue [with (likely) their USB controllers] that causes them to have a very low success rate with checkm8. It is not recommended that you use them with palera1n.
|
||||
- If your device does not successfully jailbreak, try a computer with an Intel or other CPU
|
||||
|
||||
# Warning
|
||||
# Still need help?
|
||||
|
||||
- We are **NOT** responsible for any data loss, or the result of a device being bricked. The user of this program accepts responsibility should something happen to their device. While nothing should happen, jailbreaking has risks in itself.
|
||||
|
||||
# How to use?
|
||||
|
||||
A tutorial can be found [here](https://ios.cfw.guide/installing-palera1n).
|
||||
|
||||
# Issues
|
||||
|
||||
**Please first check the [common issues](https://github.com/palera1n/palera1n/blob/main/COMMONISSUES.md) document.**
|
||||
|
||||
## Still need help?
|
||||
|
||||
If you still need help, **please** join our Discord. We disabled issues due to the flood of spam, and difficulty to respond in general. We are much more comfortable on Discord.
|
||||
|
||||
Please, please, please, provide necessary info:
|
||||
|
||||
- iOS version and device (eg. iPhone 6s 15.3.1, iPhone X 16.0)
|
||||
- Computer's OS and version (eg. Ubuntu 22.04, macOS 13.0)
|
||||
- The command you ran
|
||||
|
||||
- **Full log from the logs folder**
|
||||
|
||||
**DO NOT** harass tweak devs if tweaks don't work. Refer to [here](https://github.com/itsnebulalol/ios15-tweaks) for compatiblity.
|
||||
|
||||
You may join [here](https://dsc.gg/palera1n).
|
||||
|
||||
# Patreons
|
||||
|
||||
Thank you so much to our Patrons that make the future development possible! You may sub [here](https://patreon.com/palera1n), if you'd like to.
|
||||
|
||||
<a href="https://github.com/samh06"><img width=64 src="https://user-images.githubusercontent.com/18669106/206333607-881d7ca1-f3bf-4e18-b620-25de0c527315.png"></img></a>
|
||||
<a href="https://havoc.app"><img width=64 src="https://docs.havoc.app/img/standard_icon.png"></img></a>
|
||||
<a href="https://twitter.com/yyyyyy_public"><img width=64 src="https://pbs.twimg.com/profile_images/1429332550112079876/dQQgsURc_400x400.jpg"></img></a>
|
||||
<a href="https://twitter.com/0xSp00kyb0t"><img width=64 src="https://pbs.twimg.com/profile_images/1603601553226620935/1t4yD1bD_400x400.jpg"></img></a>
|
||||
<a href="https://chariz.com"><img width=64 src="https://chariz.com/img/favicon.png"></img></a>
|
||||
<a href="https://twitter.com/stars6220"><img width=64 src="https://pbs.twimg.com/profile_images/1611846176260689923/_n_js7gq_400x400.jpg"></img></a>
|
||||
<a href="https://github.com/beast9265"><img width=64 src="https://avatars.githubusercontent.com/u/79794946?v=4"></img></a>
|
||||
<a href="https://twitter.com/0x7FF7"><img width=64 src="https://pbs.twimg.com/profile_images/1616888462665306113/AsjJvtyt_400x400.jpg"></img></a>
|
||||
<a href="https://sideloadly.io/"><img width=64 src="https://sideloadly.io/icon.png"></img></a>
|
||||
<a href="https://blog.stevesec.com/"><img width=64 src="https://blog.stevesec.com/img/avatar.jpg"></img></a>
|
||||
|
||||
# Repos
|
||||
|
||||
### Tweaks mode
|
||||
|
||||
All repos work when using tweaks mode because it uses normal Procursus and not rootless.
|
||||
|
||||
### Rootless
|
||||
|
||||
Repos need to be updated for rootless, here are some that work currently:
|
||||
|
||||
- [Mineek's repo](https://mineek.github.io/repo) contains rootless Procursus packages
|
||||
- The official [palera1n repo](https://repo.palera.in) contains miscellaneous packages
|
||||
|
||||
If you want to make a rootless repo, use the official [palera1n repo](https://github.com/palera1n/repo) for reference. Every deb should use the `iphoneos-arm64` architecture, and *nothing* should be on the rootfs. Everything should be in /var/jb.
|
||||
Join the [Support Discord](https://dsc.gg/palera1n) if you need help with palera1n :)
|
||||
|
||||
# Credits
|
||||
<details><summary>palera1n Contributors</summary>
|
||||
<p>
|
||||
|
||||
- [Nathan](https://github.com/verygenericname)
|
||||
- [Nathan](https://github.com/verygenericname) for part of palera1n's development.
|
||||
- The ramdisk that dumps blobs, copies files, and duplicates rootfs is a slimmed down version of [SSHRD_Script](https://github.com/verygenericname/SSHRD_Script)
|
||||
- For modified [restored_external](https://github.com/verygenericname/sshrd_SSHRD_Script)
|
||||
- Also helped Mineek getting the kernel up and running and with the patches
|
||||
- Helping with adding multiple device support
|
||||
- Fixing issues relating to camera.. etc by switching to fsboot
|
||||
- [iBoot64Patcher fork](https://github.com/verygenericname/iBoot64Patcher)
|
||||
- [Mineek](https://github.com/mineek)
|
||||
- [Mineek](https://github.com/mineek) for more part of palera1n's development.
|
||||
- For the patching and booting commands
|
||||
- Adding tweak support
|
||||
- For patchfinders for RELEASE kernels
|
||||
- [Kernel15Patcher](https://github.com/mineek/PongoOS/tree/iOS15/checkra1n/Kernel15Patcher)
|
||||
- [Kernel64Patcher](https://github.com/mineek/Kernel64Patcher)
|
||||
- Work on jbinit, together with [Nick Chan](https://github.com/asdfugil)
|
||||
- [Amy](https://github.com/elihwyma) for the [Pogo](https://github.com/elihwyma/Pogo) app
|
||||
- [checkra1n](https://github.com/checkra1n) for the base of the kpf
|
||||
- [nyuszika7h](https://github.com/nyuszika7h) for the script to help get into DFU
|
||||
- [the Procursus Team](https://github.com/ProcursusTeam) for the amazing [bootstrap](https://github.com/ProcursusTeam/Procursus)
|
||||
- [F121](https://github.com/F121Live) for helping test
|
||||
- [m1sta](https://github.com/m1stadev) for [pyimg4](https://github.com/m1stadev/PyIMG4)
|
||||
- [tihmstar](https://github.com/tihmstar) for [pzb](https://github.com/tihmstar/partialZipBrowser)/original [iBoot64Patcher](https://github.com/tihmstar/iBoot64Patcher)/original [liboffsetfinder64](https://github.com/tihmstar/liboffsetfinder64)/[img4tool](https://github.com/tihmstar/img4tool)
|
||||
- [Tom](https://github.com/guacaplushy) for a couple patches and bugfixes
|
||||
- For maintaining [Kernel64Patcher](https://github.com/palera1n/Kernel64Patcher)
|
||||
- [Serena](https://github.com/SerenaKit) for helping with boot ramdisk.
|
||||
- [Nick Chan](https://github.com/asdfugil) general help with patches and iBoot payload stuff
|
||||
- [Dora](https://github.com/dora2-iOS) for iBoot payload and iBootpatcher2
|
||||
- [nyuszika7h](https://github.com/nyuszika7h) for the script to help get into DFU
|
||||
|
||||
</details>
|
||||
<details><summary>Other credits for tools used in palera1n</summary>
|
||||
|
||||
- [Amy](https://github.com/elihwyma) for the [Pogo](https://github.com/elihwyma/Pogo) app
|
||||
- [checkra1n](https://github.com/checkra1n) for the base of the kpf
|
||||
- [the Procursus Team](https://github.com/ProcursusTeam) for the amazing [bootstrap](https://github.com/ProcursusTeam/Procursus)
|
||||
- [m1sta](https://github.com/m1stadev) for [pyimg4](https://github.com/m1stadev/PyIMG4)
|
||||
- [tihmstar](https://github.com/tihmstar) for [pzb](https://github.com/tihmstar/partialZipBrowser)/original [iBoot64Patcher](https://github.com/tihmstar/iBoot64Patcher)/original [liboffsetfinder64](https://github.com/tihmstar/liboffsetfinder64)/[img4tool](https://github.com/tihmstar/img4tool)
|
||||
- [xerub](https://github.com/xerub) for [img4lib](https://github.com/xerub/img4lib) and [restored_external](https://github.com/xerub/sshrd) in the ramdisk
|
||||
- [Cryptic](https://github.com/Cryptiiiic) for [iBoot64Patcher](https://github.com/Cryptiiiic/iBoot64Patcher) fork, and [liboffsetfinder64](https://github.com/Cryptiiiic/liboffsetfinder64) fork
|
||||
- [libimobiledevice](https://github.com/libimobiledevice) for several tools used in this project (irecovery, ideviceenterrecovery etc), and [nikias](https://github.com/nikias) for keeping it up to date
|
||||
- [Nick Chan](https://github.com/asdfugil) general help with patches and iBoot payload stuff
|
||||
- [Dora](https://github.com/dora2-iOS) for iBoot payload and iBootpatcher2
|
||||
- [Sam Bingner](https://github.com/sbingner) for [Substitute](https://github.com/sbingner/substitute)
|
||||
- [Serena](https://github.com/SerenaKit) for helping with boot ramdisk.
|
||||
</p>
|
||||
</details>
|
||||
|
||||
<br>
|
||||
<p align="center">
|
||||
Thank you so much to our Patreons that make the future development possible! You may sub <a href="https://patreon.com/palera1n">here</a>, if you'd like to.</br>
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="https://github.com/samh06"><img width=64 style="border-radius: 25%;" src="https://user-images.githubusercontent.com/18669106/206333607-881d7ca1-f3bf-4e18-b620-25de0c527315.png"></img></a>
|
||||
<a href="https://havoc.app"><img width=64 style="border-radius: 25%;" src="https://docs.havoc.app/img/standard_icon.png"></img></a>
|
||||
<a href="https://twitter.com/yyyyyy_public"><img width=64 style="border-radius: 25%;" src="https://cdn.discordapp.com/attachments/1054239098006683688/1072587455779328040/image.png?size=400"></img></a>
|
||||
<a href="https://twitter.com/0xSp00kyb0t"><img width=64 style="border-radius: 25%;" src="https://pbs.twimg.com/profile_images/1603601553226620935/1t4yD1bD_400x400.jpg"></img></a>
|
||||
<a href="https://chariz.com"><img width=64 src="https://chariz.com/img/favicon.png"></img></a>
|
||||
<a href="https://twitter.com/stars6220"><img width=64 style="border-radius: 25%;" src="https://pbs.twimg.com/profile_images/1621062976982728706/pWVZQ-NO_400x400.jpg"></img></a>
|
||||
<a href="https://github.com/beast9265"><img width=64 style="border-radius: 25%;" src="https://avatars.githubusercontent.com/u/79794946?v=4"></img></a>
|
||||
<a href="https://twitter.com/0x7FF7"><img width=64 style="border-radius: 25%;" src="https://pbs.twimg.com/profile_images/1616888462665306113/AsjJvtyt_400x400.jpg"></img></a>
|
||||
<a href="https://sideloadly.io/"><img width=64 style="border-radius: 25%;" src="https://sideloadly.io/icon.png"></img></a>
|
||||
<a href="https://blog.stevesec.com/"><img width=64 style="border-radius: 25%;" src="https://blog.stevesec.com/img/avatar.jpg"></img></a>
|
||||
</p>
|
||||
Reference in new issue
Block a user