diff options
Diffstat (limited to 'tools/docker_rbclient/README')
-rw-r--r-- | tools/docker_rbclient/README | 46 |
1 files changed, 30 insertions, 16 deletions
diff --git a/tools/docker_rbclient/README b/tools/docker_rbclient/README index 48026f2140..4073e069af 100644 --- a/tools/docker_rbclient/README +++ b/tools/docker_rbclient/README | |||
@@ -1,35 +1,49 @@ | |||
1 | This directory builds a Docker container image for a rockbox build | 1 | Docker build client |
2 | =================== | ||
3 | |||
4 | This directory builds a Docker container image for a Rockbox build | ||
2 | client with all toolchains except android. | 5 | client with all toolchains except android. |
3 | 6 | ||
4 | There is a pre-built client available as built1n/rbclient on Docker | 7 | There is a pre-built client available as built1n/rbclient on Docker |
5 | Hub if you would like to avoid having to build all the toolchains. See | 8 | Hub if you would like to avoid having to build all the toolchains. See |
6 | the Docker documentation on how to pull and run it. | 9 | below for how to pull and run it. |
10 | |||
11 | Building from scratch | ||
12 | ===================== | ||
7 | 13 | ||
8 | To build from scratch: | 14 | 1. Make sure you have Docker installed and running (i.e. `systemctl |
15 | start docker'). | ||
9 | 16 | ||
10 | 1. Make sure you have Docker installed and running. | 17 | 2. Build the image: |
11 | 18 | ||
12 | 2. Run: | 19 | docker build . -t myclient |
13 | 20 | ||
14 | docker build . -t myclient | 21 | This will build the image and tag it as `myclient.' The build process |
22 | can take several hours, as it downloads and compiles every Rockbox | ||
23 | toolchain. Fortunately, Docker will cache intermediate images, saving | ||
24 | you work if you must rebuild. | ||
15 | 25 | ||
16 | This will build the image and tag it as `myclient.' | 26 | 3. Run your image: |
17 | 27 | ||
18 | 3. To run your client: | 28 | docker run -e USER=your username -e PASS=anything -e NAME=clientname \ |
29 | myclient | ||
19 | 30 | ||
20 | docker run -e USER=your username -e PASS=anything -e NAME=clientname \ | 31 | This will spin up a build image container in the background. |
21 | myclient | ||
22 | 32 | ||
23 | You can also run a bash shell interactively by issuing: | 33 | You can also run a bash shell interactively by issuing: |
24 | 34 | ||
25 | docker run -it myclient bash | 35 | docker run -it myclient bash |
26 | 36 | ||
27 | This will drop you into a fully-equiped rockbox development | 37 | This will drop you into a fully-equipped Rockbox development |
28 | environment. | 38 | environment. |
29 | 39 | ||
30 | It is also possible to pull straight from Docker Hub. Run: | 40 | Prebuilt image |
41 | ============== | ||
42 | |||
43 | Run: | ||
31 | 44 | ||
32 | docker pull built1n/rbclient | 45 | docker pull built1n/rbclient |
33 | 46 | ||
34 | Then you can use all the commands above, with `myclient' replaced with | 47 | This will download a pre-built image from Docker Hub (fairly large, |
35 | `built1n/rbclient'. | 48 | will take some time). You can then use all the commands above, with |
49 | `myclient' replaced with `built1n/rbclient'. | ||