From 49da1eaa3f37dfc05d71ac9cebea9eec24efee0e Mon Sep 17 00:00:00 2001 From: Tyler <68524461+TySP-Dev@users.noreply.github.com> Date: Mon, 25 Aug 2025 13:17:51 -1000 Subject: [PATCH] Update README.md --- README.md | 89 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 48 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index ef6b260..cafc9b8 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,61 @@ # PacCrypt -**PacCrypt** is a secure, feature-rich web app for encrypting and decrypting text and files โ€” built with Flask, JavaScript, and AES-GCM encryption. -Now with an admin control panel, GitHub updater, and a built-in Pac-Man easter egg! ๐Ÿ•น๏ธ +> [!IMPORTANT] +> PacCrypt is still in the beginning stages of development. +> PacCrypt has not been examined for vulnerabilities yet. +> Due to this, PacCrypt and PacShare are not recommended for PII or sensitive information. +> User discretion is advised. + +**PacCrypt** is used for text encoding and decoding (using a basic Cypher), text and file encrypting and decrypting (using AES-GCM more algorithms coming) โ€” built with Flask, JavaScript, and AES-GCM encryption. +Built in admin control panel, GitHub updater, and a Pac-Man __like__ game! ๐Ÿ•น๏ธ --- -## โœจ Features +> [!NOTE] +> Windows as a server host is not offically supported. +> Some features may not work, or work incorrectly, if hosted on Windows. +> It is recommended to host the server on Linux. +> PacCrypt Server has been tested on Debian and Arch. +> The official server is hosted using Debian. -- ๐Ÿ”’ Basic and Advanced Encryption for Text & Files -- ๐Ÿ“ Secure File Uploads with Pickup Passwords +## Features + +- ๐Ÿ”’ Basic Cypher for Text +- ๐Ÿ” AES Encryption for Text & Files +- ๐Ÿ“ PacShare for Encrypted File Sharing - ๐Ÿ”‘ Random Password Generator -- ๐ŸŽฎ Hidden Pac-Man Game โ€” type `pacman` to play -- ๐Ÿง  Smart UI: Auto-switches input sections, toggles encryption labels -- ๐Ÿ“‹ Clipboard Copy Feedback with styled status boxes +- ๐ŸŽฎ Pac-Man __Like__ Game โ€” type `pacman` into input - ๐Ÿงพ Admin Panel: - Site map with live route list - Server restart & GitHub update button - - Secure admin credential management + - Admin credential management - Server logs & upload cleanup -- ๐Ÿงฉ System Settings Page for upload config -- ๐Ÿ“œ Custom 403, 404, and 500 Error Pages -- ๐Ÿค– robots.txt and /sitemap for crawlers -- ๐Ÿ“ฑ Mobile-Responsive UI + - Server Settings +- ๐Ÿ“œ Error Landing Pages +- ๐Ÿ“ฑ Mobile UI --- -## ๐Ÿ‘จโ€๐Ÿ’ป Installation +## Installation -### ๐Ÿ“‹ Prerequisites +### Prerequisites - Python 3.7+ - Flask 3+ - Cryptography 42+ - Waitress 2.1+ -- Git (For update feature) +- Git - Nginx (Recommended) -- Cockpit (Recommended if hosted on **Linux**) --- ### โšก Quick Setup ```bash -git clone https://github.com/TySP-Dev/PacCrypt.git -cd paccrypt-webapp-final +git clone https://github.com/TySP-Dev/PacCrypt-Webapp.git +cd PacCrypt-Webapp python -m venv venv -source venv/bin/activate # or venv\Scripts\activate on Windows +source venv/bin/activate pip install -r requirements.txt ``` @@ -53,26 +63,27 @@ Then run: - Development Mode: ```bash - ./start_dev.sh #<-- start_dev.bat (Windows) + ./start_dev.sh ``` - Production Mode: ```bash - ./start_prod.sh #<-- start_prod.bat (Windows) + ./start_prod.sh ``` -Visit [http://127.0.0.1:5000](http://127.0.0.1:5000) or [http://localhost:5000](http://localhost:5000) - *If* you **are** on the host system -Visit http://hosts_private_ip - *If* you are **not** on the host system +Visit [http://127.0.0.1:5000](http://127.0.0.1:5000) or [http://localhost:5000](http://localhost:5000) - If you **are** on the host system +Visit http://hosts_private_ip - If you are **not** on the host system but on the same network +Visit http://hosts_public_ip:5000 - If you are **not** on the host system but on a different network --- -## ๐Ÿงญ Navigation & Usage +## Navigation & Usage ### ๐Ÿ”‘ Generate Passwords - Click Generate -- Then hit `๐Ÿ“‹ Copy Password` -- **Note:** This is also used as a seed generator for the Pac-Man *like* game +- Boom a Password +- **Note:** This is also used as a seed generator for the Pac-Man __like__ game ### ๐Ÿ” Encrypt & Decrypt @@ -81,32 +92,34 @@ Visit http://hosts_private_ip - *If* you are **not** on the host system - Type your message or upload a file - Enter password (Advanced AES) - Hit Execute -- Then hit `๐Ÿ“‹ Copy Output` +- Boom Encrypted/Decrypted Text/File ### ๐Ÿ“ค Share Files - Upload a file with two passwords: - Encryption password - Pickup password -- Get a shareable URL and click `๐Ÿ“‹ Copy Link` +- Get a shareable URL and click `Copy Link` -### ๐ŸŽฎ Pac-Man *like* Game +### ๐ŸŽฎ Pac-Man __like__ Game - Type `pacman` in the input box -- Game appears with `Restart` and `Exit` buttons -- Arrow key and Swipe controls ๐Ÿ•น๏ธ -- Game restarts and a new seed is generated once all dots are eaten +- Arrow key and Swipe controls +- Game restarts and a new seed is generated once all dots are gone --- ## ๐Ÿ› ๏ธ Admin Panel -Visit `/adminpage` after setting up credentials at `/admin-setup`. +Visit `/adminpage` + +> [!NOTE] +> You will be redirected to `/admin-setup` if you have not set a username and password yet. Features: - ๐Ÿ”„ Restart server - ๐Ÿ”ƒ Update from GitHub (git pull) -- ๐Ÿงฝ Clear uploads +- ๐Ÿงฝ Clear PacShare uploads - ๐Ÿ” Change admin password - ๐Ÿ“ View logs - โš™๏ธ Adjust upload settings @@ -114,7 +127,6 @@ Features: --- ## ๐Ÿ›ก๏ธ Deployment Tips -##### I recommend using Linux as the host server, the follow confs are Linux focused The official PacCrypt host is **Debian** minimal install. **HTTP** Nginx config (Not recommended): @@ -261,9 +273,4 @@ PacCrypt/ โ”œโ”€โ”€ start_prod.sh ``` ---- - -## ๐Ÿ“„ License - -MIT ยฉ [TySP-Dev](https://github.com/TySP-Dev)