Update README.md with docker usage
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Steven Polley 2023-06-04 16:07:17 -06:00
parent 9a2e992964
commit ce2087e638

View File

@ -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
```
Edit /data/android/lineage/vendor/lineage/build/core/main.mk to include deadbeef-ota.mk
```makefile