From e3a718f1f97319c50a3dde2be96f5ab2cbfdff21 Mon Sep 17 00:00:00 2001 From: dbarzin Date: Mon, 4 Jul 2022 21:03:16 +0200 Subject: [PATCH] documentation --- INSTALL.md | 33 +++++++++++++++++++++++++++++---- README.md | 3 ++- install.sh | 8 ++++---- 3 files changed, 35 insertions(+), 9 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 97f1ab3..27986d5 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -11,9 +11,34 @@ That's all, no other packages needed After reboot, login with the user create during the install and type : - sudo apt install git - git clone https://github.com/dbarzin/pandora-box - cd pandora-box - sudo ./install.sh + sudo apt install git + git clone https://github.com/dbarzin/pandora-box + cd pandora-box + sudo ./install.sh +You can configura Pandora-box in the _pandora-box.ini_ file : + + [DEFAULT] + ; Curses mode (full text) + CURSES = False + + ; Screen size (graphic mode) + SCREEN_SIZE = "1024x600" + + ; Set USB_AUTO_MOUNT to true is if the OS mount automaticaly mount USB keys + USB_AUTO_MOUNT = False + + ; Set PANDORA_ROOT_URL to the URL of the Pandora server + ; the default value is "http://127.0.0.1:6100" + PANDORA_ROOT_URL = http://127.0.0.1:6100 + + ; Set FAKE_SCAN to true to fake the scan process (used during developement only) + FAKE_SCAN = False + + ; Set to true to copy infected files to the quarantine folder + ; in the USB scanning station + QUARANTINE = True + + ; Set quarantine folder + QUARANTINE_FOLDER = /var/quarantine diff --git a/README.md b/README.md index 1a4049a..262963a 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ Pandora-box ============ Pandora-Box is a USB scaning station based on [Pandora](https://github.com/pandora-analysis). +It runs on Ubuntu 22.04 server LTS It is based on recycled ThinkCenter and an integrated HDMI touch screen. @@ -10,5 +11,5 @@ It is based on recycled ThinkCenter and an integrated HDMI touch screen. [](images/box3.jpg) [](images/box4.jpg) - +The installation procedure is described [here](INSTALL.md). diff --git a/install.sh b/install.sh index c2d8fe5..92eb3af 100755 --- a/install.sh +++ b/install.sh @@ -20,7 +20,7 @@ cd redis git checkout 6.2 make # Optionally, you can run the tests: -# make test +make test cd .. chown -R $SUDO_USER redis @@ -34,7 +34,7 @@ cd kvrocks git checkout 2.0 make -j4 # Optionally, you can run the tests: -# make test +make test cd .. chown -R $SUDO_USER kvrocks @@ -105,10 +105,10 @@ usermod -a -G video $SUDO_USER usermod -a -G input $SUDO_USER # Start Poetry at boot -echo "su - $SUDO_USER -c \"cd /home/$SUDO_USER/pandora ; poetry run start\" 2>&1 >storage/pandora.log" > /etc/rc.local +echo "su - $SUDO_USER -c \"cd /home/$SUDO_USER/pandora ; poetry run start\"" > /etc/rc.local chmod +x /etc/rc.local -# getty1 autostart +# Getty1 autostart mkdir -p /etc/systemd/system/getty@tty1.service.d echo "[Service]" > /etc/systemd/system/getty@tty1.service.d/override.conf echo "ExecStart=" >> /etc/systemd/system/getty@tty1.service.d/override.conf