Dev/Redistribution
Donate
Design Documentation about Redistribution of Kicksecure
Introduction[edit]
Developers only!
These are notes for producing official downloadable binary Kicksecure images.
Pre Building[edit]
Only required if you want to redistribute (official) Kicksecure builds.
- check if https://github.com/Kicksecure/kicksecure-base-files/blob/master/etc/kicksecure_version
needs update - package
timesanitycheck:./usr/share/timesanitycheck/date-minimum-file-create - Dev/Maintenance
Clean source code
- [1]
- [2]
- You can get a list of unwanted files with
git clean -dfxnand remove them withgit clean -dfx.
- Update Kicksecure debian package repository.
- add your own
default-keyto your own/home/user/.gnupg/gpg.conf.
- Check that all packages point to a signed git commit and signed git tag.
~/derivative-maker/packages/kicksecure/developer-meta-files/debug-steps/packaging-helper-script pkg_verify_signed_commit_and_tag
- push the source code to github
git push origin master
- Check, that the current git commit is a signed. [3]
git log --show-signature HEAD^..HEAD
Or use the generic makefile as a shortcut.
make git-commit-verify
- Create an OpenPGP signed git tag. This will also be used as Kicksecure version number.
git tag -s version
- Make sure the current git head is a signed git commit and signed git tag.
To simplify this, you could use the generic makefile.
make git-verify
- Push the OpenPGP signed git tag to github.
git push origin version
- Enable Kicksecure stable repository by default.
export DERIVATIVE_APT_REPOSITORY_OPTS='--enable --repository stable'
- And use
sudo -Eso above environment is kept.
Building[edit]
Build[edit]
Build Kicksecure. For example Kicksecure with Xfce for VirtualBox.
sudo -E ./derivative-maker --build --repo true --target virtualbox --flavor whonix-gateway-xfce
Build Kicksecure. For example Kicksecure with Xfce for VirtualBox.
sudo -E ./derivative-maker --build --repo true --target virtualbox --flavor whonix-workstation-xfce
For other options and platforms also see build documentation.
Post Building[edit]
Only required if you want to redistribute (official) Kicksecure builds.
Image Signing
- A) own custom builds: Optionally sign the images.
- B) official Kicksecure builds: Mandatory sign the images.
- OpenPGP sign the images.
~/derivative-maker/packages/kicksecure/developer-meta-files/release/dm-prepare-release --flavor whonix-workstation --target virtualbox --build
Only required if you want to redistribute (official) Kicksecure builds.
- Upload the images.
~/derivative-maker/packages/kicksecure/developer-meta-files/release/upload_images
Testing[edit]
- /usr/share/whonix-ws-firewall/unit_tests/stream_isolation_test
- At least a few testers should test final releases before posting a news. Testers may be found by posting a news.
- LeakTests!
- Test the images before final release! (Testers-only releases can be uploaded straight away.)
Update Permanent Links[edit]
Git Tag[edit]
Create -testers-only or -stable git tag.
Announcement Text Creation[edit]
Create Changelog and Announcement.
./debug-steps/packaging-helper-script pkg_git_packages_git_log_writer
Wiki Page Updates[edit]
Only required if you want to redistribute (official) Kicksecure builds.
- Check, if Tor Browser/Manual Download is still up to date.
- Update Download Table.
- See if the download table works in Tor Browser using New Identity.
- Update Known Issues.
- See if Documentation still makes sense.
- Search the wiki for Special:WhatLinksHere/Template:Stable and Special:WhatLinksHere/Template:Testing and act accordingly.
- Update links on the Dev/Build Documentation page.
- Update Features.
- Update Template:VersionNew.
- Update Template:VersionShort.
- Incorporate new documentation which has been prepared on the page: Next.
- Template:Stable_project_version_based_on_Debian_codename
- Template:Stable_project_version_based_on_Debian_version_short
- Template:Debian_Codename_Testing
- Copy/move contents from Testers Release to Release Notes.
- Instructions containing backports.
Misc[edit]
Only required if you want to redistribute (official) Kicksecure builds.
- See https://github.com/Kicksecure?utf8=%E2%9C%93&q=deprecated&type=&language= for deprecated repositories to be deleted.
- https://www.qubes-os.org/doc/supported-releases/#templates
- ask for an announcement on https://www.qubes-os.org/news/
Announcement[edit]
Only required if you want to redistribute (official) Kicksecure builds.
Contents
- introduction (what is Kicksecure) (The release announcement may be the first thing that new people who learn about Kicksecure see.)
- similar to https://forums.whonix.org/t/whonix-14-has-been-released
- deprecation notice of old Kicksecure version with date of deprecation
Where
- Finally announce: Post a news. (Not nagging external lists. Common sense. Mostly only final releases.)
- In Kicksecure Important and Feature Blog.
- https://lists.debian.org/debian-derivatives/
- debian-derivatives@lists.debian.org
- https://lists.torproject.org/pipermail/tor-talk/
- tor-talk@lists.torproject.org
- https://nmap.org/mailman/listinfo/fulldisclosure
- fulldisclosure@seclists.org
- Also this will do the job as well:
Cleanup[edit]
- any deprecated repositories (none at time of writing)
Related[edit]
- To quality of redistributable builds: Distro Morphing vs Builds
Footnotes[edit]
- ↑
get rid of .directory files inside the source code:
thunar→preferences→general→behavior→use common view properties for all folders - ↑
Get rid of
~backupfiles. In other words, get rid of files starting with~. find ./ -name '*~' | xargs trash-put - ↑
You might wish using a
gitorbashalias to safe typing.
Unfinished: This wiki is a work in progress. Please do not report broken links until this notice is removed, use Search Engines First and contribute improving this wiki.
At Kicksecure we value freedom and trust, supporting Open Source and Freedom Software
ENCRYPTED SUPPORT LP,
2023
We believe security software like Kicksecure needs to remain open source and independent. Would you help sustain and grow the project? Learn more about our 10 year success story and maybe DONATE!