mirror/docker-lineage-cicd
1
0
Fork 0
mirror of https://github.com/lineageos4microg/docker-lineage-cicd synced 2024-11-09 10:09:56 +01:00
Code Issues

Add some more documentation

Browse Source
This commit is contained in:
Julian Xhokaxhiu 2017-01-08 19:49:38 +01:00
parent e623387130
commit 4dd1c01080
1 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -29,11 +29,13 @@ You can configure the Docker by passing custom environment variables to it. See
## How to use ## How to use
### Simple mode ### Simple mode
build LineageOS for `hammerhead` with default settings build cm14.1 LineageOS for `hammerhead` with default settings
``` ```
docker run \ docker run \
--restart=always \ --restart=always \
-d \ -d \
-e "USER_NAME=John Doe" \
-e "USER_MAIL=john.doe@awesome.email" \
-e "DEVICE_LIST=hammerhead" \ -e "DEVICE_LIST=hammerhead" \
-v "/home/user/ccache:/srv/ccache" \ -v "/home/user/ccache:/srv/ccache" \
-v "/home/user/source:/srv/src" \ -v "/home/user/source:/srv/src" \
@ -47,10 +49,30 @@ build cm-13.0 LineageOS for `hammerhead` and `bullhead`
docker run \ docker run \
--restart=always \ --restart=always \
-d \ -d \
-e "USER_NAME=John Doe" \
-e "USER_MAIL=john.doe@awesome.email" \
-e "BRANCH_NAME=cm-13.0" \ -e "BRANCH_NAME=cm-13.0" \
-e "DEVICE_LIST=hammerhead,bullhead" \ -e "DEVICE_LIST=hammerhead,bullhead" \
-v "/home/user/ccache:/srv/ccache" \ -v "/home/user/ccache:/srv/ccache" \
-v "/home/user/source:/srv/src" \ -v "/home/user/source:/srv/src" \
-v "/home/user/zips:/srv/out" \ -v "/home/user/zips:/srv/out" \
julianxhokaxhiu/docker-lineage-cicd julianxhokaxhiu/docker-lineage-cicd
```
### Expert mode
build cm-14.1 LineageOS for a device that doesn't exist inside the main project, but comes from a special manifest. Finally provide a custom OTA URL for this ROM so users can update using built-in OTA Updater.
```
docker run \
--restart=always \
-d \
-e "USER_NAME=John Doe" \
-e "USER_MAIL=john.doe@awesome.email" \
-e "BRANCH_NAME=cm-14.1" \
-e "DEVICE_LIST=n80xx" \
-e "CUSTOM_MANIFEST_URL=http://cool.domain/manifest.xml" \
-e "OTA_URL=http://cool.domain/api" \
-v "/home/user/ccache:/srv/ccache" \
-v "/home/user/source:/srv/src" \
-v "/home/user/zips:/srv/out" \
julianxhokaxhiu/docker-lineage-cicd
``` ```