Note: main repository: https://cgit.typeblog.net/Shelter/. The GitHub repository is only a mirror. I do not guarantee the GitHub repository will be up-to-date.
For bug reports and patches (pull requests), please use the following contact methods:
On GitHub, any new issues or pull requests will not be read or accepted. Please use the contacts listed above.
Note: The F-Droid version is automatically built and signed by the F-Droid server on each update of Shelter. The build is not managed by the author and could lag behind the updates from Play Store and this repository for several days due to high server load.
Shelter is a Free and Open-Source (FOSS) app that leverages the "Work Profile" feature of Android to provide an isolated space that you can install or clone apps into.
Shelter comes with absolutely no advertisement / statistics / tracking SDKs bundled with it. All source code is available in this public Git repository and the sources are licensed under WTFPL.
This app depends on your Android system's implementation of Work Profile. Some vendor / custom ROMs may have a broken implementation that may cause crashes and even bricking of your device. One such example is MIUI from Xiaomi. I currently provide no support for such ROMs because I personally do not own any of these devices. If you are running Shelter on these ROMs, you are on your own. If any developer out there own these devices and could make Shelter run on these ROMs, please send pull requests and I'll be happy to merge them.
Shelter is not a full sandbox implementation. It cannot protect you from:
For information that may still be exposed to the work profile, please refer to this support article by Google: https://support.google.com/work/android/answer/6191949?hl=en. Note that though the section "what data about my device is visible to my organization" is about the information visible to administrator, not necessarily every application, the fact that those information are not totally isolated is still a big caveat to the work profile feature.
Also, Shelter cannot create more than 1 work profile on one Android device, and cannot co-exist with any other apps that manages a Work Profile. This is due to the limitations of the Android system, and I can do nothing about this.
Q: Why not use Island by OasisFeng, the creator of Greenify?
Simply because it is not an FOSS app and it bundles with non-free SDKs. Note that this doesn't necessarily mean that Island has anti-features like tracking (and I don't think it has either), it's just that I wrote Shelter as an FOSS replacement of it. There is no other reason why one would prefer Shelter over Island except for this one. This is no longer true. Island is now also FOSS, but I am keeping this project for my stupid affection for WTFPL.
Q: Why does Shelter always run in background?
A: Please try removing Shelter from "Recent Apps" every time you close it. If it still persists in your notifications and eating up battery, you might have encountered a bug. Please file a bug report.
Q: How do I uninstall Shelter from my device?
A: 1) Go to Settings -> Accounts to remove the work profile; 2) Go to Settings -> Security -> Advanced -> Device admin apps to remove Shelter from Device Admin apps; 3) Uninstall Shelter normally.
Q: If I encounter bugs, how do I report them?
A: Please send a message to our mailing list https://lists.sr.ht/~petercxy/shelter. You may also join our Matrix chat room at #shelter:neo.angry.im.
Q: How do I support the project?
A: You can submit issues if you find a bug or have an idea about features of Shelter; you may also contribute code to this project if you can code; providing translations is also welcomed. If you have some extra money lying around, you can also support me on Patreon.