alisinabh / paperify Goto Github PK

View Code? Open in Web Editor NEW

228.0 7.0 29.0 365 KB

Backup data using qrcode. Minimal PaperBackup solution for small to medium sized files using QR-Codes.

License: GNU General Public License v3.0

Shell 88.37% Dockerfile 11.63%

qrcode backup paper-backup zbar backups qr-code

paperify's Introduction

Paperify

Use QR codes to backup your data on papers. Simply backup your files, print them and store them in a safe place.

Printable version of paperify

You can print the image above and include them in your backups so you would have a copy of paperify with them. :)

Requirements

Make sure you have these binaries installed on your system.

qrencode (qrencode)
convert (imagemagick)
zbarimg (zbar >= 0.23.1) only for decoding with digitallify.sh

Zbar: Binary support is just added in zbar 0.23.1 and not supported in earlier versions. Please verify that your zbar version is higher or equal to 0.23.1. You can do that by running

zbarimg --version
0.23.1

You can download and build zbar from github.com/mchehab/zbar/. Note that zbar is not required for paperify.sh It is only required for digitallify.sh decoding.

Mac OS X

To install the requirements you can use Homebrew.

brew install coreutils qrencode zbar

Installation

These are just bash scripts. There is no need to install them.

You can either use git to clone this repo or download it in zip.

git clone https://github.com/alisinabh/paperify.git && cd paperify
# --- OR ---
wget https://github.com/alisinabh/paperify/archive/master.zip -O paperify.zip && \
     unzip paperify.zip && cd paperify-master

Or you can use paperify's Docker image at alisinabh/paperify. More details below.

Usage

# Creates FILE-qr directory with generated qr codes inside.
# Then you can print those files and store them.
./paperify.sh FILE


# Reads all files inside the DIRECTORY which you have all your
# scanned pages inside. Make sure the file namings are correct 
./digitalify.sh OUTPUT_FILE DIRECTORY

Use with Docker

You can mount your files at /target in paperify's docker container. Then run paperify.

For simplicity, You can just copy the bellow commands which will mount your current directory automatically.

# To Paperify
# FIRST: cd into the folder that your file is in
docker run -v$(pwd):/target alisinabh/paperify FILE

# To Digitallify
# First cd into the folder that your scanned images are in
docker run -v$(pwd):/target --entrypoint=/paperify/digitallify.sh alisinabh/paperify OUTPUT_FILE .

Recommendations

Multiple files

Use tarballs and gzip to store and compress your data.

tar cvfz files.tgz file1.txt file2.txt

Encryption

To protect your data you can encrypt them using gpg (GnuPG).

gpg --symmetric file.txt

Then use file.txt.gpg in paperify.

License

Paperify is licensed in GPL-3.0

paperify's People

Contributors

Stargazers

Watchers

paperify's Issues

./digitallify.sh: line 33: $outputfile: ambiguous redirect

Hi,

When I use the following command I get the error below:

Using the latest download from master branch.
zbar version 0.23.90

./digitallify.sh out.txt CODE_OF_CONDUCT

reconstructing CODE_OF_CONDUCT.md-000.png
WARNING: decoder/databar.c:1248: _zbar_decode_databar: Assertion "seg->finder >= 0" failed.
	i=2 f=-1(000) part=1
WARNING: decoder/databar.c:1248: _zbar_decode_databar: Assertion "seg->finder >= 0" failed.
	i=3 f=-1(000) part=1
reconstructing CODE_OF_CONDUCT.md-001.png
WARNING: decoder/databar.c:1248: _zbar_decode_databar: Assertion "seg->finder >= 0" failed.
	i=2 f=-1(000) part=1
WARNING: decoder/databar.c:1248: _zbar_decode_databar: Assertion "seg->finder >= 0" failed.
	i=3 f=-1(000) part=1
000-CODE_OF_CONDUCT.md-000.chunk 001-CODE_OF_CONDUCT.md-001.chunk
./digitallify.sh: line 33: $outputfile: ambiguous redirect

Warning with `digitallify.sh` and Docker

Hello,

I think we should suppress stderr of zbarimg. I get the following:

...
reconstructing LICENSE-001.png
Connection Error (Failed to connect to socket /var/run/dbus/system_bus_socket: No such file or directory)
Connection Null
...

Thoughts?

Script for installation of dependencies

It would be awesome if there would be a script helping installation of the following dependencies:

qrencode
imagemagick
zbar
Maybe a default font

This script should be able to determine OS type and install the packages preferably using a package manager (like apt, pacman or homebrew).

For the installation of zbar, this script should check for minimum required version because many package sources still use old versions of zbar (especially in Ubuntu and Debian sources)

Imagemagick fixed font does not work on Termux for android

Attempting to use Paperify with Termux produces the following error, unsure as how to resolve this issue.

convert: unable to read font `fixed' @ error/annotate.c/RenderFreetype/1398.

Reported by Ashley Nykiel

Syntax Error

Upon trying to encode a file I got this error:

Move to Github Actions

@circleci has banned my account with this appealing message

I don't know how opensource project CI pipeline is connected to US sanctions but anyhow I have decided to move to Github Actions for CI pipeline of paperify.

Font too big while using Docker

Hello,

pretty much the title:

Maybe set pointsize as an environment variable? It may have something to do with the font as well.

👋 👋 👋

What about adding gzip?

First of all, really nice idea 😄 .

So, since we're printing binary data, what about piping into gzip before splitting the file and after joining it?
I gave it a try and I don't see any issues with it.

👋 👋 👋

root@DESKTOP-0FHKGRJ:/mnt/c/Users/jackr/Downloads/paperify-master (1)/paperify-master# ./digitallify.sh NewConsoleApp2.exe ConsoleApp2.exe-qr
reconstructing 000-ConsoleApp2.exe-000.chunk
ERROR: invalid configuration setting: binary

usage: zbarimg [options] <image>...

scan and decode bar codes from one or more image files

options:
    -h, --help      display this help text
    --version       display version information and exit
    -q, --quiet     minimal output, only print decoded symbol data
    -v, --verbose   increase debug output level
    --verbose=N     set specific debug output level
    --nodbus        disable dbus message
    -d, --display   enable display of following images to the screen
    -D, --nodisplay disable display of following images (default)
    --xml, --noxml  enable/disable XML output format
    --raw           output decoded symbol data without symbology prefix
    -S<CONFIG>[=<VALUE>], --set <CONFIG>[=<VALUE>]
                    set decoder/scanner <CONFIG> to <VALUE> (or 1)

reconstructing 001-ConsoleApp2.exe-001.chunk
ERROR: invalid configuration setting: binary

usage: zbarimg [options] <image>...

scan and decode bar codes from one or more image files

options:
    -h, --help      display this help text
    --version       display version information and exit
    -q, --quiet     minimal output, only print decoded symbol data
    -v, --verbose   increase debug output level
    --verbose=N     set specific debug output level
    --nodbus        disable dbus message
    -d, --display   enable display of following images to the screen
    -D, --nodisplay disable display of following images (default)
    --xml, --noxml  enable/disable XML output format
    --raw           output decoded symbol data without symbology prefix
    -S<CONFIG>[=<VALUE>], --set <CONFIG>[=<VALUE>]
                    set decoder/scanner <CONFIG> to <VALUE> (or 1)

reconstructing ConsoleApp2.exe-000.png
ERROR: invalid configuration setting: binary

usage: zbarimg [options] <image>...

scan and decode bar codes from one or more image files

options:
    -h, --help      display this help text
    --version       display version information and exit
    -q, --quiet     minimal output, only print decoded symbol data
    -v, --verbose   increase debug output level
    --verbose=N     set specific debug output level
    --nodbus        disable dbus message
    -d, --display   enable display of following images to the screen
    -D, --nodisplay disable display of following images (default)
    --xml, --noxml  enable/disable XML output format
    --raw           output decoded symbol data without symbology prefix
    -S<CONFIG>[=<VALUE>], --set <CONFIG>[=<VALUE>]
                    set decoder/scanner <CONFIG> to <VALUE> (or 1)

reconstructing ConsoleApp2.exe-001.png
ERROR: invalid configuration setting: binary

usage: zbarimg [options] <image>...

scan and decode bar codes from one or more image files

options:
    -h, --help      display this help text
    --version       display version information and exit
    -q, --quiet     minimal output, only print decoded symbol data
    -v, --verbose   increase debug output level
    --verbose=N     set specific debug output level
    --nodbus        disable dbus message
    -d, --display   enable display of following images to the screen
    -D, --nodisplay disable display of following images (default)
    --xml, --noxml  enable/disable XML output format
    --raw           output decoded symbol data without symbology prefix
    -S<CONFIG>[=<VALUE>], --set <CONFIG>[=<VALUE>]
                    set decoder/scanner <CONFIG> to <VALUE> (or 1)

./digitallify.sh: line 32: cd: too many arguments

how do you use it?

Can't paperify/digitallify file with space

Files with spaces count as if they are another file.

user@debian/d/shm> paperify a\ a
/home/user/.local/bin/paperify: line 6: [: too many arguments
/home/user/.local/bin/paperify: line 9: [: too many arguments
Paperifying a a
rm: cannot remove 'a': Is a directory

Any information about the file size limit?

Notes to run on OS X

To run on OS X:

brew install coreutils qrencode zbarimg
change split to gsplit in paperify.sh line 41 because OS X split doesn't support -d

Thanks!

Docker switch to debian and compile zbar 0.23.1+

Using archlinux image is not very good since it's changing almost every day.

It is better if we switch to debian or alpine base images and compile zbar when building the image.

Too many files

There is like 100 image files now. How can I make it one?