From 1211aee0206b0d829b1101348b2a9836996ceef9 Mon Sep 17 00:00:00 2001 From: Patrick Schleizer Date: Tue, 21 Aug 2018 05:18:37 +0800 Subject: [PATCH] readme --- README.md | 63 +++++++++++-------------------------------------------- 1 file changed, 12 insertions(+), 51 deletions(-) diff --git a/README.md b/README.md index 693690c..7eabef3 100644 --- a/README.md +++ b/README.md @@ -43,55 +43,18 @@ the kernel. (!) Hence, this package disables this feature by shipping the /etc/sysctl.d/nf_conntrack_helper.conf configuration file. +## How to install `security-misc` using apt-get ## -(This package description has been [automatically](https://github.com/Whonix/whonix-developer-meta-files/blob/master/debug-steps/packaging-helper-script) extracted and mirrored from `debian/control`.) - -# Generic Readme # -## Readme Version ## - -[Generic Readme](https://github.com/Whonix/whonix-developer-meta-files/blob/master/README_generic.md) Version 0.3 - -## Cooperating Anonymity Distributions ## - -[Generic Readme](https://github.com/Whonix/whonix-developer-meta-files/blob/master/README_generic.md) beings here. Have a look into the `man` sub folder (if available). - -The functionality of this package was once exclusively available in the [Whonix](https://www.whonix.org) ([github](https://github.com/Whonix/Whonix)) anonymity distribution. - -Because multiple projects and individuals stated interest in various of Whonix's functionality (examples: [Qubes OS](http://qubes-os.org/trac) ([discussion](https://groups.google.com/forum/#!topic/qubes-devel/jxr89--oGs0)); [piratelinux](https://github.com/piratelinux) ([discussion](https://github.com/adrelanos/VPN-Firewall/commit/6147f0e606377f5a801e98daf22e24ba2c750a21#commitcomment-6360713))), it's best to share as much source code as possible, it's best to share certain characteristics [(such as /etc/hostname etc.) among all anonymity distributions](https://mailman.boum.org/pipermail/tails-dev/2013-January/002457.html)) Whonix has been split into [multiple separate packages](https://github.com/Whonix). - -## Generic Packaging ## - -Files in `etc/...` in root source folder will be installed to `/etc/...`, files in `usr/...` will be installed to `/usr/...` and so forth. This should make renaming, moving files around, packaging, etc. very simple. Packaging of most packages looks very similar. - -## How to use outside of Debian or derivatives ## - -Although probably due to generic packaging not very hard. Still, this requires developer skills. [Ports](https://en.wikipedia.org/wiki/Porting) welcome! - -## How to Build deb Package ## - -See comments below and [instructions](https://www.whonix.org/wiki/Dev/Build_Documentation/apparmor-profile-torbrowser). - -* Replace `apparmor-profile-torbrowser` with the actual name of this package (equals the root source folder name of this package after you git cloned it). -* You only need [config-package-dev](https://packages.debian.org/wheezy/config-package-dev), when it is listed in the `Build-Depends:` field in `debian/control`. -* Many packages do not have signed git tags yet. You may request them if desired. -* We might later use a [documentation template](https://www.whonix.org/wiki/Template:Build_Documentation_Build_Package). - -## How to install in Debian using apt-get ## - -Binary packages are available in Whonix's APT repository. By no means you are required to use the binary version of this package. This might be interesting for users of Debian and derivatives. **Note, that usage of this package outside of Whonix is untested and there is no maintainer that supports this use case.** - -1\. Get [Whonix's Signing Key](https://www.whonix.org/wiki/Whonix_Signing_Key). - -2\. Add Whonix's Signing Key to apt-key. +1\. Add [Whonix's Signing Key](https://www.whonix.org/wiki/Whonix_Signing_Key). ``` -gpg --export 916B8D99C38EAF5E8ADC7A2A8D66066A2EEACCDA | sudo apt-key add - +sudo apt-key --keyring /etc/apt/trusted.gpg.d/whonix.gpg adv --keyserver hkp://ipv4.pool.sks-keyservers.net:80 --recv-keys 916B8D99C38EAF5E8ADC7A2A8D66066A2EEACCDA ``` 3\. Add Whonix's APT repository. ``` -echo "deb http://deb.whonix.org stretch main" > /etc/apt/sources.list.d/whonix.list +echo "deb http://deb.whonix.org stretch main" | sudo tee /etc/apt/sources.list.d/whonix.list ``` 4\. Update your package lists. @@ -100,23 +63,21 @@ echo "deb http://deb.whonix.org stretch main" > /etc/apt/sources.list.d/whonix.l sudo apt-get update ``` -5\. Install this package. Replace `package-name` with the actual name of this package. +5\. Install `security-misc`. ``` -sudo apt-get install package-name +sudo apt-get install security-misc ``` -## Cooperation ## +## How to Build deb Package ## -Most welcome. [Ports](https://en.wikipedia.org/wiki/Porting), distribution maintainers, developers, patches, forks, testers, comments, etc. all welcome. +Replace `apparmor-profile-torbrowser` with the actual name of this package with `security-misc` and see [instructions](https://www.whonix.org/wiki/Dev/Build_Documentation/apparmor-profile-torbrowser). ## Contact ## -* Professional Support: https://www.whonix.org/wiki/Support#Professional_Support -* Free Forum Support: https://www.whonix.org/forum -* Github Issues -* twitter: https://twitter.com/Whonix +* [Free Forum Support](https://forums.whonix.org) +* [Professional Support](https://www.whonix.org/wiki/Professional_Support) -## Donate ## +## Payments ## -* [Donate](https://www.whonix.org/wiki/Donate) +`security-misc` requires [payments](https://www.whonix.org/wiki/Payments) to stay alive!