diff --git a/docker/gitian-bitcoin-host/README.md b/docker/gitian-bitcoin-host/README.md index e676f71..e1e6d11 100644 --- a/docker/gitian-bitcoin-host/README.md +++ b/docker/gitian-bitcoin-host/README.md @@ -1,35 +1,35 @@ -Building bitcoin with the gitian-builder host image -=================================================== +Building bitcoin with a gitian-builder Docker container +======================================================= -This image currently supports only building of bitcoin 0.9.1, but it can be easily adapted to build other versions. +This image allows automated gitian builds of bitcoin 0.9.1 using a docker container. +Before proceeding make sure you have created the necessary *wheezy* and *gitian-host* images, see [these instructions](../gitian-host/README.md). -It is based on https://github.com/bitcoin/bitcoin/blob/0.9.1/doc/release-process.md (and more recent versions). +Afterwards you can create this image by running [this script](../scripts/create-gitian-bitcoin-host.sh). -Before proceeding make sure you have created the necessary gdm85/wheezy and gdm85/gitian-host images, see [these instructions](../gitian-host/README.md). - -Afterwards you can create this image by running scripts/create-gitian-bitcoin-host.sh. +NOTE: this image currently supports only building of bitcoin 0.9.1, but it can be easily adapted to build other versions. Preparing the gitian environment -------------------------------- -If you have already prepared the base VMs inside the gitian host container, all what you need to do is: +If you have already prepared the base VMs (./build-base-vms.sh) inside the gitian host container, all what you need to do is: ```sh ssh -o SendEnv= debian@your-gitian-host ./build-bitcoin.sh ``` -That is a script that will build dependencies and bitcoin for both i386 and amd64 Linux architectures. +[build-bitcoin.sh](build-bitcoin.sh) is a script that will download & build all the dependencies and then bitcoin itself, for both i386 and amd64 Linux architectures. -**NOTE:** the SendEnv= is there to overcome an issue in gitian-builder that allows pollution of the LXC environment. +**NOTE:** the SendEnv= is there to overcome an [issue](https://github.com/devrandom/gitian-builder/issues/56) in gitian-builder that allows pollution of the LXC environment. Signing ------- Now you have completed the build of bitcoin and only the signing part is left. -Before doing that, you can inspect that signatures are matching with other developers by peeking inside ~/gitian.sigs of the running container. +Before doing that, you can verify if signatures are matching with those of [other developers](https://github.com/bitcoin/gitian.sigs) by peeking inside *~/gitian.sigs* of the running container. + +In order to sign you have to either put your private key in the container's *~/.gnupg* or perform the signing externally, at your option. -In order to sign you have to either put your private key in the container's ~/.gnupg or perform the signing externally, at your option. -If you have the private key in the container (so displayed by `gpg -K`), then you can use this script: +If you have the private key in the container (also displayed by `gpg -K`), then you can use this script: ```bash #!/bin/bash set -e