Skip to content
This repository has been archived by the owner on Jun 15, 2022. It is now read-only.

Commit

Permalink
Prominently documents 30GB disk space requirement
Browse files Browse the repository at this point in the history
During review of #107, @dachary mentioned running out of disk space. We
used to be better about documenting that! Added to the requirements
section of the README, and cross-referenced from the build guide.
  • Loading branch information
Conor Schaefer committed Jul 28, 2017
1 parent b82fb6c commit a41ee62
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
4 changes: 4 additions & 0 deletions README.md
Expand Up @@ -12,11 +12,15 @@ Build documentation can be found in the `docs/build.md` file.

## Requirements

### Resources
Only Debian and Ubuntu are supported, due to the use of make-kpkg.
For compiling the kernel, 2GB and 2 VCPUs is plenty. Depending on the config options
you specify, the compilation should take two to three hours on that hardware.
Naturally, you can speed up the build by providing more resources.

As for disk space, make sure you have at least 30GB to run the full kernel compile.

### Credentials
Furthermore, you must have a [grsecurity subscription] and export the
following environment variables:

Expand Down
3 changes: 2 additions & 1 deletion docs/build.md
Expand Up @@ -7,7 +7,8 @@ and is intended for two use cases:
* SecureDrop Admins recompiling a kernel from source

Users trying to recompile grsecurity-patched kernels for contexts other
than SecureDrop should look elsewhere.
than SecureDrop should look elsewhere. Make sure to review the requirements
in the README (such as 30GB free disk space) before continuing.

## Building the SecureDrop-specific packages for release
The automated build logic for preparing source directories will streamline most
Expand Down

0 comments on commit a41ee62

Please sign in to comment.