devs/foxbox
1
0
Fork 0
forked from len0rd/rockbox
Code Pull requests Activity

docker-rbclient: update README

Browse source 
Change-Id: If7c3565147f1092e3104d7f08e705aaaf6aafd5d
This commit is contained in:
Franklin Wei 2019-07-28 15:39:25 -04:00
parent e499b75117
commit c5ed45d8c7
1 changed files with 30 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

46
tools/docker_rbclient/README
View file

@ -1,35 +1,49 @@
This directory builds a Docker container image for a rockbox build
Docker build client
===================
This directory builds a Docker container image for a Rockbox build
client with all toolchains except android.
There is a pre-built client available as built1n/rbclient on Docker
Hub if you would like to avoid having to build all the toolchains. See
the Docker documentation on how to pull and run it.
below for how to pull and run it.
To build from scratch:
Building from scratch
=====================
1. Make sure you have Docker installed and running.
1. Make sure you have Docker installed and running (i.e. `systemctl
start docker').
2. Run:
2. Build the image:
docker build . -t myclient
docker build . -t myclient
This will build the image and tag it as `myclient.'
This will build the image and tag it as `myclient.' The build process
can take several hours, as it downloads and compiles every Rockbox
toolchain. Fortunately, Docker will cache intermediate images, saving
you work if you must rebuild.
3. To run your client:
3. Run your image:
docker run -e USER=your username -e PASS=anything -e NAME=clientname \
myclient
docker run -e USER=your username -e PASS=anything -e NAME=clientname \
myclient
This will spin up a build image container in the background.
You can also run a bash shell interactively by issuing:
docker run -it myclient bash
docker run -it myclient bash
This will drop you into a fully-equiped rockbox development
This will drop you into a fully-equipped Rockbox development
environment.
It is also possible to pull straight from Docker Hub. Run:
Prebuilt image
==============
docker pull built1n/rbclient
Run:
Then you can use all the commands above, with `myclient' replaced with
`built1n/rbclient'.
docker pull built1n/rbclient
This will download a pre-built image from Docker Hub (fairly large,
will take some time). You can then use all the commands above, with
`myclient' replaced with `built1n/rbclient'.