*Setup instructions for a Gitian build of Monero using a VM or physical system.*
*Setup instructions for a Gitian build of Monero using a VM or physical system.*
Gitian is the deterministic build process that is used to build the Bitcoin
Gitian is the deterministic build process that is used to build the Monero CLI
Core executables. It provides a way to be reasonably sure that the
executables. It provides a way to be reasonably sure that the
executables are really built from the git source. It also makes sure that
executables are really built from the git source. It also makes sure that
the same, tested dependencies are used and statically built into the executable.
the same, tested dependencies are used and statically built into the executable.
@ -22,8 +22,7 @@ Table of Contents
Please note that these instructions have been forked from bitcoin's gitian build
Please note that these instructions have been forked from bitcoin's gitian build
instructions. Please also consult their documentation, when running into problems.
instructions. Please also consult their documentation, when running into problems.
The signing is left as inherited from bitcoin at the moment, since building currently
The signing is left as inherited from bitcoin at the moment.
still fails with libiconv.
- [Preparing the Gitian builder host](#preparing-the-gitian-builder-host)
- [Preparing the Gitian builder host](#preparing-the-gitian-builder-host)
- [Getting and building the inputs](#getting-and-building-the-inputs)
- [Getting and building the inputs](#getting-and-building-the-inputs)
@ -37,9 +36,10 @@ Preparing the Gitian builder host
The first step is to prepare the host environment that will be used to perform the Gitian builds.
The first step is to prepare the host environment that will be used to perform the Gitian builds.
This guide explains how to set up the environment, and how to start the builds.
This guide explains how to set up the environment, and how to start the builds.
Gitian builds are for now executed on Ubuntu 18.04 "Bionic Beaver". Please run Ubuntu in either a VM, or on your physical machine.
Gitian builds are for now executed on Ubuntu 18.04 "Bionic Beaver". A solution is being worked on to run
it in docker in the future. Please run Ubuntu in either a VM, or on your physical machine.
You need to be logged in as the `gitianuser` in order to build gitian builds. If this user does not exist yet on your system,
You need to be logged in as the `gitianuser` in order to build gitian builds. If this user does not exist yet on your system,
create him.
create it.
Note that a version of `lxc-execute` higher or equal to 2.1.1 is required.
Note that a version of `lxc-execute` higher or equal to 2.1.1 is required.
You can check the version with `lxc-execute --version`.
You can check the version with `lxc-execute --version`.
@ -79,11 +79,8 @@ This setup is required to enable networking in the container.
Manual and Building
Manual and Building
-------------------
-------------------
The instructions below use the automated script [gitian-build.py](https://github.com/betcoin/bitcoin/blob/master/contrib/gitian-build.py) which only works in Ubuntu. For manual steps and instructions for fully offline signing, see [this guide](./gitian-building/gitian-building-manual.md).
The instructions below use the automated script [gitian-build.py](https://github.com/betcoin/bitcoin/blob/master/contrib/gitian-build.py) which only works in Ubuntu.
It calls all available descriptors. Help for the build steps taken can be accessed with `./gitian-build.py --help`.
MacOS code signing
------------------
In order to sign builds for MacOS, you need to download the free SDK and extract a file. The steps are described [here](./gitian-building/gitian-building-mac-os-sdk.md). Alternatively, you can skip the OSX build by adding `--os=lw` below.
Initial Gitian Setup
Initial Gitian Setup
--------------------
--------------------
@ -93,66 +90,57 @@ The `gitian-build.py` script will checkout different release tags, so it's best
cp monero/contrib/gitian/gitian-build.py .
cp monero/contrib/gitian/gitian-build.py .
```
```
You only need to do this once:
Setup the required environment, you only need to do this once:
```
```
./gitian-build.py --setup fluffypony 0.0.20
./gitian-build.py --setup fluffypony 0.14.0
```
```
Where `fluffypony` is your Github name and `0.0.20` is the most recent tag (without `v`).
Where `fluffypony` is your Github name and `0.14.0` is the version tag you want to build (without `v`).
In order to sign gitian builds on your host machine, which has your PGP key, fork the gitian.sigs repository and clone it on your host machine:
While gitian and this build script does provide a way for you to sign the build directly, it is recommended to sign in a seperate step.
This script is only there for convenience. Seperate steps for building can still be taken.
In order to sign gitian builds on your host machine, which has your PGP key,
fork the gitian.sigs repository and clone it on your host machine,
or pass the signed assert file back to your build machine.
To speed up the build, use `-j 5 -m 5000` as the first arguments, where `5` is the number of CPU's you allocated to the VM plus one, and 5000 is a little bit less than then the MB's of RAM you allocated. If there is memory corruption on your machine, try to tweak these values.
To speed up the build, use `-j 5 -m 5000` as the first arguments, where `5` is the number of CPU's you allocated to the VM plus one, and 5000 is a little bit less than then the MB's of RAM you allocated. If there is memory corruption on your machine, try to tweak these values.
If all went well, this produces a number of (uncommited) `.assert` files in the gitian.sigs repository.
If all went well, this produces a number of (uncommited) `.assert` files in the gitian.sigs repository.
You need to copy these uncommited changes to your host machine, where you can sign them:
If you do detached, offline signing, you need to copy these uncommited changes to your host machine, where you can sign them. For example:
You may have other .assert files as well (e.g. `signed` ones), in which case you should sign them too. You can see all of them by doing `ls ${VERSION}-*/${SIGNER}`.
This will create the `.sig` files that can be committed together with the `.assert` files to assert your
parser.add_argument('-u','--url',dest='url',default='https://github.com/monero-project/monero',help='Specify the URL of the repository. Default is %(default)s')
parser.add_argument('-u','--url',dest='url',default='https://github.com/monero-project/monero',help='Specify the URL of the repository. Default is %(default)s')
parser.add_argument('-v','--verify',action='store_true',dest='verify',help='Verify the Gitian build')
parser.add_argument('-v','--verify',action='store_true',dest='verify',help='Verify the Gitian build')
parser.add_argument('-b','--build',action='store_true',dest='build',help='Do a Gitian build')
parser.add_argument('-b','--build',action='store_true',dest='build',help='Do a Gitian build')
parser.add_argument('-s','--sign',action='store_true',dest='sign',help='Make signed binaries for Windows and MacOS')
parser.add_argument('-B','--buildsign',action='store_true',dest='buildsign',help='Build both signed and unsigned binaries')
parser.add_argument('-B','--buildsign',action='store_true',dest='buildsign',help='Build both signed and unsigned binaries')
parser.add_argument('-o','--os',dest='os',default='lwm',help='Specify which Operating Systems the build is for. Default is %(default)s. l for Linux, w for Windows, m for MacOS')
parser.add_argument('-o','--os',dest='os',default='lwm',help='Specify which Operating Systems the build is for. Default is %(default)s. l for Linux, w for Windows, m for MacOS')
parser.add_argument('-j','--jobs',dest='jobs',default='2',help='Number of processes to use. Default %(default)s')
parser.add_argument('-j','--jobs',dest='jobs',default='2',help='Number of processes to use. Default %(default)s')
@ -184,7 +165,7 @@ def main():
# Add leading 'v' for tags
# Add leading 'v' for tags
ifargs.commitandargs.pull:
ifargs.commitandargs.pull:
raiseException('Cannot have both commit and pull')
raiseException('Cannot have both commit and pull')
TheCharlatan
6 years ago