Update doc

cea-sec · Jul 13, 2022 · 25cac00 · 25cac00
1 parent ac20ff8
commit 25cac00
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 2 deletions.
diff --git a/client/kiosk/Makefile b/client/kiosk/Makefile
@@ -6,7 +6,7 @@ PKG=../../target/debian/usbsas-kiosk_$(VER)_amd64.deb
 all: $(PKG)
 
 nwjs-v$(NWJS_VER)-linux-x64.tar.gz:
-	wget "https://dl.nwjs.io/v$(NWJS_VER)/nwjs-v$(NWJS_VER)-linux-x64.tar.gz"
+	curl -O "https://dl.nwjs.io/v$(NWJS_VER)/nwjs-v$(NWJS_VER)-linux-x64.tar.gz"
 
 usbsas-kiosk/opt/nwjs/nw: nwjs-v$(NWJS_VER)-linux-x64.tar.gz
 	mkdir -p usbsas-kiosk/opt/nwjs

diff --git a/client/kiosk/usbsas-kiosk/DEBIAN/copyright b/client/kiosk/usbsas-kiosk/DEBIAN/copyright
@@ -0,0 +1,5 @@
+Files: *
+License: GPL-3.0
+
+Files: opt/nwjs/*
+License: MIT
diff --git a/doc/build_usage.md b/doc/build_usage.md
@@ -141,6 +141,11 @@ or with nwjs:
 $ nw client/nwjs
 ```
 
+The antivirus analysis with the analyzer server is optional. To disable it,
+comment or remove the `[analyzer]` section of the `config.toml` file. The
+provided analyzer-server based on clamAV is mainly given as example, an
+analyzer-server with multiple antiviruses should be preferred.
+
 ### Other applications
 
 #### Fuse

diff --git a/doc/kiosk.md b/doc/kiosk.md
@@ -13,7 +13,13 @@ The generated packages will be located in `target/debian`.
 $ sudo apt install -y --no-install-recommends curl pkgconf clang cmake git
 $ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
 $ source $HOME/.cargo/env
-$ cargo install --git "https://github.com/kornelski/cargo-deb" cargo-deb
+$ cargo install cargo-deb
+```
+
+### Clone usbsas
+```shell
+$ git clone https://github.com/cea-sec/usbsas
+$ cd usbsas
 ```
 
 ### Set environment variables

diff --git a/usbsas-hid/hid-dealer/Cargo.toml b/usbsas-hid/hid-dealer/Cargo.toml
@@ -3,6 +3,7 @@ name = "hid-dealer"
 version = "0.1.0"
 edition = "2021"
 license = "GPL-3.0"
+description = "usbsas userland HID manager"
 
 [dependencies]
 env_logger = "0.9.0"

diff --git a/usbsas-server/Cargo.toml b/usbsas-server/Cargo.toml
@@ -3,6 +3,7 @@ name = "usbsas-server"
 version = "0.1.0"
 edition = "2021"
 license = "GPL-3.0"
+description = "usbsas web server"
 
 [dependencies]
 actix-files = "0.6.1"