From ce2087e638e840f049d1a3787a441e2c2df917a8 Mon Sep 17 00:00:00 2001 From: Steven Polley Date: Sun, 4 Jun 2023 16:07:17 -0600 Subject: [PATCH] Update README.md with docker usage --- README.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 24e4965..b9b33bf 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,40 @@ # lineageos-ota-server -OTA Server for LineageOS. +OTA Server for LineageOS. The OTA server supports a single device, if you intend to support multiple devices, you just create an additional OTA server instance for that device. +### docker compose example + +The service listens on port 8080 by default. Mount the output directory for the builds of the device you wish to serve to the /out folder. Also, mount a persistent public directory which will be served publicly. The public folder can be shared across multiple OTA server instances if you wish. + +```yaml + +version: '3.8' + + lineageos-ota: + image: registry.deadbeef.codes/lineageos-ota-server:latest + restart: always + expose: + - "8080" + volumes: + - /data/android/lineage/out/target/product/sunfish:/out + - /data/android/public:/public + +``` ### How to point device to OTA server -We include the URL as a system build.prop by doing the following: +The recommended way is to include the configuration inside your build of the ROM. We do this by by including the URL as a system build.prop by doing the following: Create new file /data/android/lineage/vendor/lineage/build/core/deadbeef-ota.mk ```makefile -# deadbeef.codes LineageOS OTA update server +# deadbeef.codes LineageOS OTA update server - replace with your own URL ADDITIONAL_SYSTEM_PROPERTIES += \ - lineage.updater.uri=https://lineageos-ota.deadbeef.codes + lineage.updater.uri=https://lineageos-ota.deadbeef.codes ``` - Edit /data/android/lineage/vendor/lineage/build/core/main.mk to include deadbeef-ota.mk ```makefile