Skip to content

Commit

Permalink
Merge pull request #10 from chenxiaolong/docs
Browse files Browse the repository at this point in the history
README.md: Document update checks
  • Loading branch information
chenxiaolong authored Aug 19, 2023
2 parents c619977 + 4387225 commit 3db5f61
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ Custota is installed via a Magisk/KernelSU module so that it can run as a system

7. That's it!

Once the OTA server URL is configured, Custota will automatically check for updates periodically. The checks can be turned off completely or extended to automatically install the updates as well.

To reduce battery usage, the scheduling of the update checks is controlled by Android. They run at most once every 6 hours and will not run at all if the `Require unmetered network` or `Require sufficient battery level` conditions aren't met.

## OTA server

Custota only requires a basic webserver capable of serving static files and supporting the HTTP `Range` header. Any standard webserver, like Apache, Nginx, or Caddy, will do the trick. For testing, Caddy is very useful because it can serve files from a directory without setting up any config files:
Expand Down

0 comments on commit 3db5f61

Please sign in to comment.