adminconf/printscan-server
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Rewamp README

Browse Source
This commit is contained in:
Alexandre CATTEAU 2021-10-22 17:00:31 +02:00
parent f43d3d514f
commit f0ed5efe7f
1 changed files with 4 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,27 +1,10 @@
# Printscan server # 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 This repository contains files used to set up our printscan server on a freshly installed Armbian. Target is Bullseye.
with Buster.
### Introduction ### Introduction
(see wiki for need and concept explanation) (see wiki for need and concept explanation)
Version 2 implementation works roughly as follows: The idea behind version 3 is to replace all the scan part with [scanservjs](https://github.com/sbs20/scanservjs). This
* the Armbian-based device is connected to local network, and an all-in-one printer is connected to it via USB; app would **not** be running on the same SBC, but on a dedicated applicative container.
* 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