Please consider including instructions for building the project on the most common OS'

[yayoi-k]

Since this project is targeted at a broader community than developers, it would be wonderful to include instructions for building the project on the most common linux OS's such as Ubuntu. I've attempted to create the start of those instructions:

git clone https://github.com/pkoutoupis/rapiddisk.git
sudo apt update
sudo apt install libjansson-dev
sudo apt install libpcre2-dev
sudo apt install libdevmapper-dev
sudo apt install libmicrohttpd-dev

Unfortunately when I attempt the 'make' I get the following errors:

make -C module
make[1]: Entering directory '/root/development/rapiddisk/module'
make -C /lib/modules/5.15.0-79-generic/build M=/root/development/rapiddisk/module
make[2]: Entering directory '/root/development/rapiddisk/module'
make[2]: *** /lib/modules/5.15.0-79-generic/build: No such file or directory. Stop.
make[2]: Leaving directory '/root/development/rapiddisk/module'
make[1]: *** [Makefile:37: all] Error 2
make[1]: Leaving directory '/root/development/rapiddisk/module'
make: *** [Makefile:29: module] Error 2

I've tried manually creating the /build folder, however running make again then yields new errors.

This kind of thing can turn into hours and days for a non-developer, so it would be fantastic to include a built copy of the project or known-good instructions to deploy and use on Ubuntu. Many people end up giving up or turning away simply because they cannot build a project. Thats fine for developer-audience projects but this is really a beneficial project for any sys-admin.

[pkoutoupis]

@yayoi-k,

Thank you for your interest in my project. Based on your errors, it looks as if you do not have the kernel header/development packages installed for the kernel you are currently running (uname -r). Anyway, you can make sure that you get everything installed by looking at the build dependencies section for the kernel module at the top of this debian package control file: https://github.com/pkoutoupis/rapiddisk/blob/master/pkg/debian/control

To get past the current error though, you will likely have to run something like this:

$ sudo apt-get install linux-headers-`uname -r`

EDIT: Also, here is a guide: https://github.com/pkoutoupis/rapiddisk/wiki/A-Beginner's-Installation---Setup-Guide
Let me know if it needs updating.

[matteotenca]

You can also use the PPA which provides pre-built rapiddisk Ubuntu packages:

https://launchpad.net/~matteotenca/+archive/ubuntu/rapiddisk