kstitch/README.md

56 lines
1.8 KiB
Markdown

# 🧵 kstitch
service to automatically fetch, patch, and release GrapheneOS OTAs with KernelSU Next
## wip?
YES don't use it yet not that anybody will but don't
this readme also needs updates because its inaccurate rn
## why?
i like GOS but i depend on some apps that require fully passing Play Integrity. unfortunately, root is needed to bypass that
## should i use?
no, probably not if you don't need to .. normal android/graphene is very capable (especially with Shizuku)
if you don't have enough experience to understand whats going on and solve ur own problems then definitely no, you will hate it
## how to use?
ok, here is how:
### running `kstitch`
set up `kstitch` as a systemd service, windows service, or something like that
just make sure these env vars are set:
* `WORK_DIR` --- path to store intermediary data in. it's okay to use a temp dir (faster is better)
* `OUT_DIR` --- path to store output OTAs in. you'll publish this path w/ a web server
please make sure to pick dirs with enough disk space by the way!!!!
### publish the OTAs
use some kind of web server to serve the outputs folder you chose! it doesn't matter which one, but try not to use a really slow one because OTAs are big
### flash
copy the latest OTA for your device from the outputs folder and flash it onto your phone.
once you've done that, you should install these modules:
* **Custota** --- so you can install updates
* set the updater url to wherever you chose to serve your OTAs
* also the stock GOS updater app isn't needed, so disable it if you want
* **OEMUnlockOnBoot** --- insurance to avoid bricking your phone
also, dont use KSU direct install, or anything that will modify boot partition. that will break verified boot and your phone will not boot afterward
thats all!! hopefully it works for you!
## incremental otas?
no! not yet