96 lines
2.6 KiB
Markdown
96 lines
2.6 KiB
Markdown
# PiHelper
|
|
|
|
PiHelper is designed to be a simple, lightweight, portable client library for the
|
|
[Pi-hole](https://pi-hole.net/). There is also a CLI tool available.
|
|
|
|
## CLI Usage
|
|
|
|
-c, --configure Configure Pi-Helper
|
|
-d, --disable <duration> Disable the Pi-hole for a given duration, or permanently if empty
|
|
-e, --enable Enable the Pi-hole
|
|
-f, --file <config-file> Use the given config file instead of the default
|
|
-h, --help Display this message
|
|
-q, --quiet Don't print anything
|
|
-v, --verbose Print debug logs
|
|
|
|
## Library Usage
|
|
|
|
Include the `pihelper.h` file.
|
|
|
|
## Dependencies
|
|
|
|
PiHelper depends on cmake, curl, openssl, and json-c.
|
|
|
|
### Ubuntu Install Command
|
|
|
|
sudo apt install cmake \
|
|
make \
|
|
gcc \
|
|
g++ \
|
|
libcurl4-openssl-dev \
|
|
libssl-dev \
|
|
libjson-c-dev
|
|
|
|
### Fedora Install Command
|
|
|
|
sudo dnf install cmake \
|
|
make \
|
|
gcc \
|
|
gcc-c++ \
|
|
libcurl-devel \
|
|
openssl-devel \
|
|
json-c-devel
|
|
|
|
### MacOS Install Command
|
|
|
|
brew install cmake \
|
|
autoconf \
|
|
automake \
|
|
libtool
|
|
|
|
## Building
|
|
|
|
Once you have the dependencies installed, you can build the project with cmake:
|
|
|
|
mkdir build
|
|
cd build
|
|
cmake ..
|
|
make
|
|
|
|
By default, this will build a static library you can link to. If you'd like to build a shared library, use
|
|
this cmake command instead:
|
|
|
|
cmake -DPIHELPER_SHARED=BOOL:ON ..
|
|
|
|
If you'd like to have the command line tool as well, you can use this:
|
|
|
|
cmake -DPIHELPER_EXECUTABLE=BOOL:ON ..
|
|
|
|
If you need the development headers on your system, you can run this:
|
|
|
|
cmake -DPIHELPER_DEV=BOOL:ON ..
|
|
|
|
Once you've run cmake with the desired options, you can install pihelper to your system by runnning the
|
|
following after building:
|
|
|
|
sudo make install
|
|
|
|
## License
|
|
|
|
Copyright © 2019, 2020 William Brawner.
|
|
|
|
This file is part of PiHelper.
|
|
|
|
PiHelper is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
PiHelper is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with PiHelper. If not, see <https://www.gnu.org/licenses/>.
|
|
|