|
1 | | -# papyrus |
| 1 | +<br/> |
| 2 | +<p align="center"> |
| 3 | + <a href="https://github.com/ooguz/papyrus"> |
| 4 | + <img src="https://github.com/ooguz/papyrus/assets/17238191/d8bf4dbe-117a-48d0-8905-9849e1119f57" alt="Logo" width="80" height="80"> |
| 5 | + </a> |
2 | 6 |
|
3 | | -A new Flutter project. |
| 7 | + <h3 align="center">Papyrus</h3> |
4 | 8 |
|
5 | | -## Getting Started |
| 9 | + <p align="center"> |
| 10 | + A simple paper backup tool |
| 11 | + <br/> |
| 12 | + <br/> |
| 13 | + <a href="https://github.com/ooguz/papyrus/issues">Report Bug</a> |
| 14 | + -- |
| 15 | + <a href="https://github.com/ooguz/papyrus/issues">Request Feature</a> |
| 16 | + </p> |
| 17 | +</p> |
6 | 18 |
|
7 | | -This project is a starting point for a Flutter application. |
| 19 | +     |
8 | 20 |
|
9 | | -A few resources to get you started if this is your first Flutter project: |
10 | 21 |
|
11 | | -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) |
12 | | -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) |
| 22 | +## About |
13 | 23 |
|
14 | | -For help getting started with Flutter development, view the |
15 | | -[online documentation](https://docs.flutter.dev/), which offers tutorials, |
16 | | -samples, guidance on mobile development, and a full API reference. |
| 24 | + |
| 25 | + |
| 26 | +If you are working with GnuPG or SSH, you will probably understand the fear of losing your keys. This tool makes a "hard copy" of your text files including but not limited to your keys, 2FA backups, config files etc. |
| 27 | + |
| 28 | +Papyrus can produce a PDF output which consist of QR codes made from your file to restore easily, in addition to OCR-friendly plain text version of your file, to prevent any failure on QR codes, with checksums for each line. |
| 29 | + |
| 30 | +My personal recommendation is to print your paper backup with laser printer to acid-free paper, put it into a plastic bag (Mylar is preferred) and seal it with a heat sealer (you can find one around 25 USD, also useful for food packaging). |
| 31 | + |
| 32 | +## Installation |
| 33 | + |
| 34 | +Go to the [Releases](https://github.com/ooguz/papyrus) page and download the package for your distribution and signatures. |
| 35 | + |
| 36 | +### Checksum and signature verification |
| 37 | + |
| 38 | +1. Download release files and checksums |
| 39 | +2. Get my GnuPG key to verify checksums |
| 40 | + |
| 41 | +```bash |
| 42 | +gpg --keyserver keyserver.ubuntu.com --recv-keys D854D9D85CB4910704BD9C5B2D33E2BD3D975818 |
| 43 | +``` |
| 44 | +3. Verify `SHA256SUMS` file by running: |
| 45 | + |
| 46 | +```bash |
| 47 | +gpg --verify SHA256SUMS.asc |
| 48 | +``` |
| 49 | +4. Verify SHA256 checksums with: |
| 50 | + |
| 51 | +```bash |
| 52 | +sha256sum -c SHA256SUMS |
| 53 | +``` |
| 54 | + |
| 55 | +### AppImage |
| 56 | + |
| 57 | +Give execution permission to AppImage file and run Papyrus: |
| 58 | + |
| 59 | +```bash |
| 60 | +chmod +x papyrus*-linux.AppImage |
| 61 | +./papyrus-*.AppImage |
| 62 | +``` |
| 63 | + |
| 64 | + |
| 65 | +### Ubuntu/Debian (deb) Package |
| 66 | + |
| 67 | +Install deb package and run Papyrus: |
| 68 | + |
| 69 | +```bash |
| 70 | +sudo dpkg -i papyrus*.deb |
| 71 | +papyrus |
| 72 | +``` |
| 73 | + |
| 74 | + |
| 75 | +## Roadmap |
| 76 | + |
| 77 | +* Implement andOTP (or similiar) backup parser function |
| 78 | +* Implement password manager (KeePassXC, pass etc.) parser |
| 79 | +* Add restore from scan function |
| 80 | +* Add custom title and description to PDF |
| 81 | + |
| 82 | +## Contributing |
| 83 | + |
| 84 | +Any contributions you make are **greatly appreciated**. |
| 85 | +* If you have suggestions for adding or removing features, feel free to [open an issue](https://github.com/ooguz/papyrus/issues/new) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes. |
| 86 | +* Please make sure you check your spelling and grammar. |
| 87 | +* Create individual PR for each suggestion. |
| 88 | + |
| 89 | +### Creating A Pull Request |
| 90 | + |
| 91 | +1. Fork the project |
| 92 | +2. Create your feature branch (`git checkout -b new_feature`) |
| 93 | +3. Commit your Changes (`git commit -m 'Add new feature'`) |
| 94 | +4. Push to the Branch (`git push origin new_feature`) |
| 95 | +5. Open a pull pequest |
| 96 | + |
| 97 | +## License |
| 98 | + |
| 99 | + Copyright (C) 2023 Özcan Oğuz |
| 100 | + |
| 101 | + This program is free software: you can redistribute it and/or modify |
| 102 | + it under the terms of the GNU General Public License as published by |
| 103 | + the Free Software Foundation, either version 3 of the License, or |
| 104 | + (at your option) any later version. |
| 105 | + |
| 106 | + This program is distributed in the hope that it will be useful, |
| 107 | + but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 108 | + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 109 | + GNU General Public License for more details. |
| 110 | + |
| 111 | + You should have received a copy of the GNU General Public License |
| 112 | + along with this program. If not, see <https://www.gnu.org/licenses/>. |
| 113 | + |
| 114 | +## Reading |
| 115 | + |
| 116 | +* [Paper Backup - KeePassXC](https://keepassxc.org/blog/2020-10-03-paper-backup/) |
| 117 | +* [Why you still need paper hard copy backups?](https://www.norpacpaper.com/blog/why-you-still-need-paper-hard-copy-backups) |
0 commit comments