docker-lineageos/README.md

docker-lineageos
==================

Create a [Docker] based environment to build [LineageOS].

This Dockerfile will create a docker container which is based on Ubuntu 16.04.
It will install the "repo" utility and any other build dependencies which are required to compile LineageOS (formerly known as CyanogenMod).

The main working directory is a shared folder on the host system, so the Docker container can be removed at any time.

**NOTE:** Remember that LineageOS is a huge project. It will consume a large amount of disk space (~80 GB) and it can easily take hours to build.

### How to run/build

**NOTES:**
* You will need to [install Docker][Docker_Installation] to proceed!
* If an image does not exist, ```docker build``` is executed first

```
git clone https://github.com/stucki/docker-lineageos.git
cd docker-lineageos
./run.sh
```

The `run.sh` script accepts the following switches:

| Switch | Alternative | Description  |
|---|---|---|
| `-u` | `--enable-usb` | Runs the container in privileged mode (this way you can use adb right from the container) |
| `-r` | `--rebuild` | Force rebuild the image from scratch |
| `-ws` | `--with-su` | Sets the WITH_SU environment variable to true (your builds will include the su binary) |

The container uses "screen" to run the shell. This means that you will be able to open additional shells using [screen keyboard shortcuts][Screen_Shortcuts].

### ADB in the container
If you're on Linux and want to use adb from within the container running with `-u` might not be enough. Make sure you have the [Android udev rules](https://github.com/M0Rf30/android-udev-rules/blob/master/51-android.rules) installed on your host system so you can access your device without needing superuser permissions.

### How to build LineageOS for your device

```
repo init -u git://github.com/lineageos/android.git -b lineage-15.1
repo sync -c -j 16
source build/envsetup.sh
breakfast <device codename>   # example: breakfast grouper
brunch <device codename>      # example: brunch grouper
```

### Links

For further information, check the following links:

* [CyanogenMod Building Basics][Cyanogenmod_Building_Basics]
* [Build Instructions for Google Nexus 5][LineageOS_Build_Nexus5] (example device, search the wiki for other devices)

### More information

* [Discussion thread @ XDA developers]

==================

[Docker]:                      https://www.docker.io/
[LineageOS]:                   http://lineageos.org/
[Docker_Installation]:         https://www.docker.io/gettingstarted/
[Screen_Shortcuts]:            http://www.pixelbeat.org/lkdb/screen.html
[CyanogenMod_Building_Basics]: https://web-beta.archive.org/web/20161224192643/http://wiki.cyanogenmod.org/w/Development
[LineageOS_Build_Nexus5]:    https://wiki.lineageos.org/devices/hammerhead/build
[Discussion thread @ XDA developers]: http://forum.xda-developers.com/showthread.php?t=2650345
[dotcloud/docker#2224]:        https://github.com/dotcloud/docker/issues/2224
Change all references of "CyanogenMod" to "LineageOS" 2017-01-03 15:32:06 -05:00			`docker-lineageos`
Add README.md 2014-02-16 07:30:32 -05:00			`==================`

Change all references of "CyanogenMod" to "LineageOS" 2017-01-03 15:32:06 -05:00			`Create a [Docker] based environment to build [LineageOS].`
Add README.md 2014-02-16 07:30:32 -05:00
readme.md typo 16.04 2017-01-06 18:34:10 -05:00			`This Dockerfile will create a docker container which is based on Ubuntu 16.04.`
Change all references of "CyanogenMod" to "LineageOS" 2017-01-03 15:32:06 -05:00			`It will install the "repo" utility and any other build dependencies which are required to compile LineageOS (formerly known as CyanogenMod).`
Add README.md 2014-02-16 07:30:32 -05:00
[TASK] Fix typo in README.md 2014-07-18 14:24:20 -04:00			`The main working directory is a shared folder on the host system, so the Docker container can be removed at any time.`
Add README.md 2014-02-16 07:30:32 -05:00
Change all references of "CyanogenMod" to "LineageOS" 2017-01-03 15:32:06 -05:00			`NOTE: Remember that LineageOS is a huge project. It will consume a large amount of disk space (~80 GB) and it can easily take hours to build.`
Add README.md 2014-02-16 07:30:32 -05:00
refactor(run.sh): Combined run and build scripts fix(Dockerfile): Removed unnecessary PPA fix(Dockerfile): Removed duplicate curl package chore(Readme.md): Update documentation 2014-07-14 01:30:56 -04:00			`### How to run/build`
Add README.md 2014-02-16 07:30:32 -05:00
Add note on dotcloud/docker#2224 2014-02-20 11:09:33 -05:00			`NOTES:`
			`* You will need to [install Docker][Docker_Installation] to proceed!`
Fix some typos 2014-07-18 17:48:18 -04:00			* If an image does not exist, ```docker build``` is executed first
Add a note that Docker is required for this. No Docker, no fun. 2014-02-18 08:05:05 -05:00
Add README.md 2014-02-16 07:30:32 -05:00			```
Change all references of "CyanogenMod" to "LineageOS" 2017-01-03 15:32:06 -05:00			`git clone https://github.com/stucki/docker-lineageos.git`
			`cd docker-lineageos`
Add README.md 2014-02-16 07:30:32 -05:00			`./run.sh`
			```

workaround for docker issue #8755 2016-04-04 12:55:21 -04:00			The `run.sh` script accepts the following switches:

Docs: Use a table for available switches Overall this looks cleaner to me, feel free to revert if you feel like it's not. 2017-10-12 02:02:34 -04:00			`\| Switch \| Alternative \| Description \|`
			`\|---\|---\|---\|`
			\| `-u` \| `--enable-usb` \| Runs the container in privileged mode (this way you can use adb right from the container) \|
			\| `-r` \| `--rebuild` \| Force rebuild the image from scratch \|
			\| `-ws` \| `--with-su` \| Sets the WITH_SU environment variable to true (your builds will include the su binary) \|
workaround for docker issue #8755 2016-04-04 12:55:21 -04:00
Add README.md 2014-02-16 07:30:32 -05:00			`The container uses "screen" to run the shell. This means that you will be able to open additional shells using [screen keyboard shortcuts][Screen_Shortcuts].`

Docs: Use a table for available switches Overall this looks cleaner to me, feel free to revert if you feel like it's not. 2017-10-12 02:02:34 -04:00			`### ADB in the container`
			If you're on Linux and want to use adb from within the container running with `-u` might not be enough. Make sure you have the [Android udev rules](https://github.com/M0Rf30/android-udev-rules/blob/master/51-android.rules) installed on your host system so you can access your device without needing superuser permissions.

Change all references of "CyanogenMod" to "LineageOS" 2017-01-03 15:32:06 -05:00			`### How to build LineageOS for your device`
Add README.md 2014-02-16 07:30:32 -05:00
			```
Adjust LineageOS version to lineage-15.1 2018-11-02 12:19:21 -04:00			`repo init -u git://github.com/lineageos/android.git -b lineage-15.1`
Update documentation (speed up `repo sync`) Fixes #26 2017-01-20 12:14:41 -05:00			`repo sync -c -j 16`
Add README.md 2014-02-16 07:30:32 -05:00			`source build/envsetup.sh`
			`breakfast <device codename> # example: breakfast grouper`
			`brunch <device codename> # example: brunch grouper`
			```

			`### Links`

			`For further information, check the following links:`

			`* [CyanogenMod Building Basics][Cyanogenmod_Building_Basics]`
Update info links * CyanogenMod Building Basics served from archive.org as a temporary workaround * Learning to Build removed as it is only a section within the Building Basics * Build info for hammerhead changed to LineageOS wiki Relevant to issue #23 2017-04-19 10:39:49 -04:00			`* [Build Instructions for Google Nexus 5][LineageOS_Build_Nexus5] (example device, search the wiki for other devices)`
Add README.md 2014-02-16 07:30:32 -05:00
Add link to discussion thread at XDA 2014-02-16 08:44:45 -05:00			`### More information`

			`* [Discussion thread @ XDA developers]`

Add README.md 2014-02-16 07:30:32 -05:00			`==================`

			`[Docker]: https://www.docker.io/`
Change all references of "CyanogenMod" to "LineageOS" 2017-01-03 15:32:06 -05:00			`[LineageOS]: http://lineageos.org/`
Add a note that Docker is required for this. No Docker, no fun. 2014-02-18 08:05:05 -05:00			`[Docker_Installation]: https://www.docker.io/gettingstarted/`
Add README.md 2014-02-16 07:30:32 -05:00			`[Screen_Shortcuts]: http://www.pixelbeat.org/lkdb/screen.html`
Update info links * CyanogenMod Building Basics served from archive.org as a temporary workaround * Learning to Build removed as it is only a section within the Building Basics * Build info for hammerhead changed to LineageOS wiki Relevant to issue #23 2017-04-19 10:39:49 -04:00			`[CyanogenMod_Building_Basics]: https://web-beta.archive.org/web/20161224192643/http://wiki.cyanogenmod.org/w/Development`
			`[LineageOS_Build_Nexus5]: https://wiki.lineageos.org/devices/hammerhead/build`
Add link to discussion thread at XDA 2014-02-16 08:44:45 -05:00			`[Discussion thread @ XDA developers]: http://forum.xda-developers.com/showthread.php?t=2650345`
Add note on dotcloud/docker#2224 2014-02-20 11:09:33 -05:00			`[dotcloud/docker#2224]: https://github.com/dotcloud/docker/issues/2224`