From f0ed5efe7fe92fb4e868dc4bf49c1591218cc69b Mon Sep 17 00:00:00 2001 From: Alexandre CATTEAU Date: Fri, 22 Oct 2021 17:00:31 +0200 Subject: [PATCH] Rewamp README --- README.md | 25 ++++--------------------- 1 file changed, 4 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 354d18a..e3ec032 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,10 @@ # Printscan server -## Version 2 +## Version 3 PROJECT -This repository contains files used to set up our printscan server on a freshly installed Armbian. Confirmed to work -with Buster. +This repository contains files used to set up our printscan server on a freshly installed Armbian. Target is Bullseye. ### Introduction (see wiki for need and concept explanation) -Version 2 implementation works roughly as follows: -* the Armbian-based device is connected to local network, and an all-in-one printer is connected to it via USB; -* SANE and CUPS services are installed and running on the device; -* CUPS is configured to provide a remote printer to network; -* SANE is configured for local use only (default behaviour); -* An headless X server is activable via [noVNC](https://github.com/novnc/noVNC); -* This X session presents [Simple Scan](https://github.com/GNOME/simple-scan) tool, allowing users to perform scans; -* The resulted document is automatically uploaded to Kloud, in a temporary directory; -* Every night, the directory from previous day is removed from Kloud. - -### Files -#### Installation -* `setup.sh` is a script automating the installation and configuration of required software -#### Run -* `novnc.service`, `vnc.socket` and `vnc@.service` manage the headless X session -* `scan.mount` configures a tmpfs at boot where to store scanned documents before they're sent to Kloud -* `scan-to-cloud.{sh,service,path}` trigger and manage the upload to Kloud -* `clean-cloud.{sh,service,timer}` trigger and manage the removal of previous directory from Kloud +The idea behind version 3 is to replace all the scan part with [scanservjs](https://github.com/sbs20/scanservjs). This +app would **not** be running on the same SBC, but on a dedicated applicative container.