Dev/Build Documentation/generic-package
From Whonix
< Dev | Build Documentation(Redirected from Dev/Build Documentation/package-name)
The build process of building any of the packages by Whonix developers is always very similar. This very wiki page explain how to build package generic-package. By replacing the name of the package generic-package with the name of any other package you might be interested in building, the other package would be build. You have two options.
- A) Instructions on this page about how to build the generic-package package from source code while verifying software signatures for better security. OR
- B) Easier instructions click here.
Get Build Dependencies[edit]
Update your package lists.
sudo apt-get update
Install from Debian repository.
sudo apt-get install build-essential devscripts git
Change Directory to Build Folder[edit]
This chapter is recommended for better usability, but is not strictly required. [1]
Create folder ~/generic-package-build.
mkdir -p ~/generic-package-build
Change directory to folder ~/generic-package-build.
cd ~/generic-package-build
Get the Source Code[edit]
Get the the package's source code.
git clone https://github.com/Whonix/generic-package.git
Remember it is Whonix, not whonix! If you are prompted for a username for github, it means you have mistyped the web address.
Get the Signing Key[edit]
Get the Signing Key
This chapter is recommended for better security, but it is not strictly required. (See Trust)
1. Download Patrick Schleizer (adrelanos) OpenPGP key. patrick.asc
Note: If Whonix is already being used, this process can be simplified. See the footnotes. [2]
2. Store it as patrick.asc.
3. Import the key.
gpg --import patrick.asc
4. Verify the key using this fingerprint.
gpg --fingerprint 916B8D99C38EAF5E8ADC7A2A8D66066A2EEACCDA
The output should show.
pub rsa4096 2014-01-16 [SC] [expires: 2021-04-17]
916B 8D99 C38E AF5E 8ADC 7A2A 8D66 066A 2EEA CCDA
uid [ full ] Patrick Schleizer <adrelanos@riseup.net>
sub rsa4096 2014-01-16 [E] [expires: 2021-04-17]
sub rsa4096 2014-01-16 [A] [expires: 2021-04-17]
sub rsa4096 2014-01-16 [S] [expires: 2021-04-17]
5. This only retrieves the signing key from one source. For better security, learn more about the Whonix Signing Key.
Change Directory[edit]
Get into the package's source code folder because later on package build commands using make are expected to be run from the root of the source folder.
cd generic-package
OpenPGP Verify the Source Code[edit]
OpenPGP Verify the Source Code
This chapter is recommended for better security, but is not strictly required.[3]
Retrieve a list of available git tags.
git --no-pager tag
Verify the tag you want to build. Replace it with the tag chosen to build.
git tag -v 0.1
The output should look similar to this.
object 1844108109a5f2f8bddcf2257b9f3675be5cfb22
type commit
tag {{{version}}}
tagger Patrick Schleizer <adrelanos@whonix.org> 1392320095 +0000
.
gpg: Signature made Thu 13 Feb 2014 07:34:55 PM UTC using RSA key ID 77BB3C48
gpg: Good signature from "Patrick Schleizer <adrelanos@whonix.org>" [ultimate]
The warning.
gpg: WARNING: This key is not certified with a trusted signature! gpg: There is no indication that the signature belongs to the owner.
Is explained on the Whonix Signing Key page and can be safely ignored.
Choose Version[edit]
Retrieve a list of available git tags.
git --no-pager tag
Use git checkout to select the preferred version to build.
git checkout 0.1
Replace 0.1 with the actual version chosen for the build: the stable, testers-only or developers version. Common sense is required when choosing the right version number. For example, the latest available version number is not necessarily the most stable or suitable. Follow the Whonix ™ News Blog as it might contain information.
Check if you really got the version you want.
git describe
Should show:
0.1
Check if source folder is pristine.
git status
Should show nothing.
HEAD detached at 0.1
nothing to commit, working tree clean
If it shows something else, do not continue.
Build the Package[edit]
Install build dependencies.
sudo mk-build-deps --remove --install
If that did not work, have a look in debian/control file and manually install all packages listed under Build-Depends and Depends.
Build the package without signing it (not required for personal use) and install it.
dpkg-buildpackage -b
Build Result[edit]
When a package is build using dpkg-buildpackage the resulting packages will be created in the parent folder. I.e. in this case in the ~/generic-package-build folder.
ls ../
Should show something like this.
generic-package generic-package0.1-1_amd64.buildinfo generic-package0.1-1_amd64.changes
Install the Package[edit]
The package can be found in the parent folder.
sudo dpkg -i ../generic-package*.deb
Clean Up[edit]
Delete temporary files debhelper files in package source folder as well as debhelper artifacts (.deb file etc.) in parent folder.
1) Show extraneous (temporary files debhelper) files.
git clean -ndff
2) NOTE: Read above output carefully if you added files of your own files to that folder.
If that looks good, actually remove.
git clean -dff
3) Delete debhelper artifacts (.deb file etc.) in parent folder.
TODO: document
Footnotes[edit]
- ↑
When a package is build using
dpkg-buildpackagethe resulting packages will be created in the parent folder. It's better for usability if this is not the user's home folder since many other files may already reside there. Thereby making the build result files more difficult to find or delete. This is a missing Debian feature. See: dpkg-buildpackage: support output directory other than .. [archive] - ↑
Steps 1-3 can be completed with just one command.
gpg --import /usr/share/whonix/whonix-keys.d/patrick.asc
- ↑ See Trust.
Whonix ™ is Supported by Evolution Host DDoS Protected VPS. Stay private and get your VPS with Bitcoin or Monero.
Search engines: YaCy | Qwant | ecosia | MetaGer | peekier | Whonix ™ Wiki
Have you read our Documentation [archive], Technical Design [archive] and Developer Portal [archive] links yet?
This is a wiki. Want to improve this page? Help is welcome and volunteer contributions are happily considered! Read, understand and agree to Conditions for Contributions to Whonix ™, then Edit! Edits are held for moderation. Policy of Whonix Website and Whonix Chat and Policy On Nonfreedom Software applies.
Copyright (C) 2012 - 2020 ENCRYPTED SUPPORT LP. Whonix ™ is a trademark. Whonix ™ is a licensee [archive] of the Open Invention Network [archive]. Unless otherwise noted, the content of this page is copyrighted and licensed under the same Freedom Software license as Whonix ™ itself. (Why?)
Whonix ™ is a derivative of and not affiliated with Debian [archive]. Debian is a registered trademark [archive] owned by Software in the Public Interest, Inc [archive].
Whonix ™ is produced independently from the Tor® [archive] anonymity software and carries no guarantee from The Tor Project [archive] about quality, suitability or anything else.
By using our website, you acknowledge that you have read, understood and agreed to our Privacy Policy, Cookie Policy, Terms of Service, and E-Sign Consent. Whonix ™ is provided by ENCRYPTED SUPPORT LP. See Imprint, Contact.