docs

git clone https://github.com/notamitgamer/docs.git
ยท rebuilt hourlyOpen on GitHub
commit 8b841e886e5a60206f839543cd8b98414b86d534
parent 34bec80c3890cbe8ee6e23f421add4bd0d63a5a2
Author: Amit Dutta <mail@amit.is-a.dev>
Date:   Fri,  2 Oct 2026 05:46:33 +0530

added copyright

Diffstat:
Mgit-mirror/build-process.mdx | 4++++
Mgit-mirror/customization.mdx | 4++++
Mgit-mirror/deploy.mdx | 4++++
Mgit-mirror/index.mdx | 4++++
Mgithrun/cli-auth-and-tools.mdx | 4++++
Mgithrun/cli-find-download.mdx | 4++++
Mgithrun/cli-usage.mdx | 4++++
Mgithrun/configuration.mdx | 4++++
Mgithrun/index.mdx | 4++++
Mgithrun/python-api.mdx | 4++++
Mgithrun/vscode-extension.mdx | 4++++
Mmojic/algorithm.mdx | 4++++
Mmojic/index.mdx | 4++++
Mmojic/installation.mdx | 4++++
Mmojic/usage.mdx | 4++++
Mosma/index.mdx | 4++++
Mosma/notes.mdx | 4++++
Mosma/npm-api.mdx | 4++++
Mosma/pypi-api.mdx | 4++++
Mosma/quickstart.mdx | 4++++
Mosma/utility.mdx | 4++++
Asnippets/copyright.mdx | 3+++
Mveyrix/architecture.mdx | 4++++
Mveyrix/faq.mdx | 4++++
Mveyrix/index.mdx | 4++++
Mveyrix/performance.mdx | 4++++
Mveyrix/roadmap.mdx | 4++++
Mveyrix/security.mdx | 4++++
Mveyrix/usage-guide.mdx | 4++++
Mveyrix/veyrix-web.mdx | 4++++
Mwhatsapp-logger/connect-whatsapp.mdx | 4++++
Mwhatsapp-logger/deploy-backend.mdx | 4++++
Mwhatsapp-logger/faqs.mdx | 4++++
Mwhatsapp-logger/firebase-setup.mdx | 4++++
Mwhatsapp-logger/index.mdx | 4++++
Mwhatsapp-logger/keep-alive.mdx | 4++++
Mwhatsapp-logger/prerequisites.mdx | 4++++
Mwhatsapp-logger/setup-frontend.mdx | 4++++
Mwhatsapp-logger/troubleshooting.mdx | 4++++
Mwhatsapp-logger/usage.mdx | 4++++
40 files changed, 159 insertions(+), 0 deletions(-)

diff --git a/git-mirror/build-process.mdx b/git-mirror/build-process.mdx @@ -2,6 +2,8 @@ title: "How the Build Works" --- +import Copyright from "/snippets/copyright.mdx"; + `build.sh` runs the whole pipeline, driven by GitHub Actions. Here's what it does, step by step. ## 1. Setup & metadata @@ -45,3 +47,5 @@ For every public repo (minus the filtered ones): - Generates a styled `404.html` The final output lands in `./site`, ready to be deployed via GitHub Pages. + +<Copyright /> diff --git a/git-mirror/customization.mdx b/git-mirror/customization.mdx @@ -2,6 +2,8 @@ title: "Customization" --- +import Copyright from "/snippets/copyright.mdx"; + ## Filter repositories Open `build.sh` and find the `gh repo list` command. The `select` statement controls which repos are excluded โ€” by default it skips `git-mirror`, `register`, and `osma`: @@ -27,3 +29,5 @@ These get copied into the site root and into every generated repo subfolder duri If you're using a custom domain, create a file named `CNAME` in the repository root containing your domain name. The build script automatically copies it to the site output and uses it to build `sitemap.xml` URLs. Continue to [How the Build Works](/git-mirror/build-process). + +<Copyright /> diff --git a/git-mirror/deploy.mdx b/git-mirror/deploy.mdx @@ -3,6 +3,8 @@ title: "How to Fork and Deploy" sidebarTitle: "Fork & Deploy" --- +import Copyright from "/snippets/copyright.mdx"; + Follow these steps to create and host your own version of this repository mirror. ## 1. Fork the repository @@ -29,3 +31,5 @@ GitHub automatically disables workflows in forked repositories for security reas 3. Click **Run workflow** to fetch your repositories, generate the HTML, and deploy the site. Continue to [Customization](/git-mirror/customization). + +<Copyright /> diff --git a/git-mirror/index.mdx b/git-mirror/index.mdx @@ -3,6 +3,8 @@ title: "Git Mirror Site Generator" sidebarTitle: "Git Mirror" --- +import Copyright from "/snippets/copyright.mdx"; + An automated setup that generates a fast, static HTML mirror of your public GitHub repositories, using [`stagit`](https://codemadness.org/stagit.html) and GitHub Actions. Instead of hitting the GitHub UI, this gives you a lightweight, self-hosted browsing experience for your repos โ€” plain HTML, no JavaScript framework, no tracking, and fast to load. @@ -23,3 +25,5 @@ For each public repo, the build produces: - [How to Fork & Deploy](/git-mirror/deploy) - [Customization](/git-mirror/customization) - [How the Build Works](/git-mirror/build-process) + +<Copyright /> diff --git a/githrun/cli-auth-and-tools.mdx b/githrun/cli-auth-and-tools.mdx @@ -3,6 +3,8 @@ title: "Authentication (Private Repos & Rate Limits)" sidebarTitle: "CLI - Auth, Bookmarks & Tools" --- +import Copyright from "/snippets/copyright.mdx"; + GitHub limits unauthenticated requests to 60/hour. Logging in raises this to 5,000 and grants access to private repositories. ```bash @@ -42,3 +44,5 @@ You must add `~/.githrun/bin` to your system PATH for installed tools to be runn </Warning> Continue to [Find, Search & Download](/githrun/cli-find-download). + +<Copyright /> diff --git a/githrun/cli-find-download.mdx b/githrun/cli-find-download.mdx @@ -3,6 +3,8 @@ title: "Find & Search" sidebarTitle: "CLI - Find & Download" --- +import Copyright from "/snippets/copyright.mdx"; + Search for files inside a remote repository without cloning it. ```bash @@ -35,3 +37,5 @@ githrun show https://github.com/user/repo/tree/main/src ``` Continue to [Python API](/githrun/python-api). + +<Copyright /> diff --git a/githrun/cli-usage.mdx b/githrun/cli-usage.mdx @@ -3,6 +3,8 @@ title: "Installation" sidebarTitle: "CLI - Install & Run" --- +import Copyright from "/snippets/copyright.mdx"; + ```bash pip install githrun ``` @@ -40,3 +42,5 @@ githrun run https://github.com/user/repo/blob/main/script.py --inspect ``` Continue to [Auth, Bookmarks & Tool Install](/githrun/cli-auth-and-tools). + +<Copyright /> diff --git a/githrun/configuration.mdx b/githrun/configuration.mdx @@ -2,6 +2,8 @@ title: "Configuration" --- +import Copyright from "/snippets/copyright.mdx"; + Githrun stores configuration and cache files in your home directory: | Path | Purpose | @@ -9,3 +11,5 @@ Githrun stores configuration and cache files in your home directory: | `~/.githrun/config.json` | Tokens, bookmarks | | `~/.githrun/cache/` | Cached API responses | | `~/.githrun/bin/` | Installed tools | + +<Copyright /> diff --git a/githrun/index.mdx b/githrun/index.mdx @@ -2,6 +2,8 @@ title: "Githrun" --- +import Copyright from "/snippets/copyright.mdx"; + Githrun is a command-line tool and VS Code extension that lets you execute, explore, and install Python scripts directly from GitHub and Gists โ€” handling dependencies, private repositories, and local tool installation along the way. ## Features @@ -23,3 +25,5 @@ Githrun is a command-line tool and VS Code extension that lets you execute, expl - [Python API](/githrun/python-api) - [VS Code Extension](/githrun/vscode-extension) - [Configuration](/githrun/configuration) + +<Copyright /> diff --git a/githrun/python-api.mdx b/githrun/python-api.mdx @@ -3,6 +3,8 @@ title: "Python API Usage" sidebarTitle: "Python API" --- +import Copyright from "/snippets/copyright.mdx"; + Githrun can be used inside your own Python scripts. ```python @@ -24,3 +26,5 @@ exit_code = githrun.execute_remote_code("https://github.com/user/repo/blob/main/ ``` Continue to [VS Code Extension](/githrun/vscode-extension). + +<Copyright /> diff --git a/githrun/vscode-extension.mdx b/githrun/vscode-extension.mdx @@ -2,6 +2,8 @@ title: "VS Code Extension" --- +import Copyright from "/snippets/copyright.mdx"; + ## Installation & setup ### 1. Install the extension @@ -39,3 +41,5 @@ The extension tries to auto-detect your Githrun installation: 2. If not found, falls back to `python -m githrun` (or `python3` on Mac/Linux) Continue to [Configuration](/githrun/configuration). + +<Copyright /> diff --git a/mojic/algorithm.mdx b/mojic/algorithm.mdx @@ -3,6 +3,8 @@ title: "Under the Hood: Operation Ironclad" sidebarTitle: "How It Works" --- +import Copyright from "/snippets/copyright.mdx"; + Mojic v2.1.0 implements a custom crypto-system dubbed "Operation Ironclad." ## 1. Derivation phase @@ -31,3 +33,5 @@ The whitened data is buffered into 5-byte chunks, treated as a single large inte ## 6. The header The salt and a 4-byte auth check are written to the file header using the Moon/Clock alphabet (`๐ŸŒ‘๐ŸŒ’๐ŸŒ“๐ŸŒ”...`). This lets Mojic report "Incorrect Password" instantly, rather than churning out garbage data first. + +<Copyright /> diff --git a/mojic/index.mdx b/mojic/index.mdx @@ -2,6 +2,8 @@ title: "Mojic" --- +import Copyright from "/snippets/copyright.mdx"; + **Operation Ironclad: obfuscate C source code into a randomized, password-seeded stream of emojis.** Mojic (Magic + Emoji + Logic) is a CLI tool that transforms readable C code into an unrecognizable, chaotic stream of emojis. Unlike a simple substitution cipher, Mojic uses your password to seed a cryptographically strong PRNG, creating a unique "Emoji Universe" and rolling cipher for every session. @@ -38,3 +40,5 @@ This makes the `mojic` command available globally, same as an npm install would. - [Installation](/mojic/installation) - [CLI Usage](/mojic/usage) - [How It Works (Operation Ironclad)](/mojic/algorithm) + +<Copyright /> diff --git a/mojic/installation.mdx b/mojic/installation.mdx @@ -2,6 +2,8 @@ title: "Installation" --- +import Copyright from "/snippets/copyright.mdx"; + <Warning> **npm install is currently broken** @@ -31,3 +33,5 @@ Or without installing: ```bash npx mojic encode main.c ``` + +<Copyright /> diff --git a/mojic/usage.mdx b/mojic/usage.mdx @@ -2,6 +2,8 @@ title: "CLI Usage" --- +import Copyright from "/snippets/copyright.mdx"; + ## 1. Encrypting code (`encode`) Transforms a `.c` file into a `.mojic` file. You'll be prompted to create a password โ€” it's required to decrypt. @@ -43,3 +45,5 @@ mojic srt --re secret.mojic ``` Continue to [How It Works](/mojic/algorithm). + +<Copyright /> diff --git a/osma/index.mdx b/osma/index.mdx @@ -3,6 +3,8 @@ title: "OSMA (Open Source Module Archive)" sidebarTitle: "OSMA" --- +import Copyright from "/snippets/copyright.mdx"; + **Registry lookups, without the wait.** OSMA is a lightning-fast, static search archive for querying open-source packages across NPM and PyPI, bypassing live registry bottlenecks. ## Why it exists @@ -38,3 +40,5 @@ The backend runs on **FastAPI**, serving static `.csv` snapshots pulled securely - [PyPI API Reference](/osma/pypi-api) - [Utility Endpoints](/osma/utility) - [Notes, Limits & FAQ](/osma/notes) + +<Copyright /> diff --git a/osma/notes.mdx b/osma/notes.mdx @@ -3,6 +3,8 @@ title: "Notes & Reference" sidebarTitle: "Notes & FAQ" --- +import Copyright from "/snippets/copyright.mdx"; + ## Limits & notes **Rate limits** โ€” APIs are strictly rate-limited to 10 requests/minute and 100 requests/hour per IP to protect the free-tier infrastructure. Send the `X-Bypass-Token` header to override this. @@ -72,3 +74,5 @@ The current focus is strictly NPM and PyPI; other ecosystems may be considered w **How do I report a bug or vulnerability?** General bugs/UI issues โ†’ [open a GitHub issue](https://github.com/notamitgamer/osma/issues). Security vulnerabilities โ†’ email [mail@amit.is-a.dev](mailto:mail@amit.is-a.dev) directly instead of filing a public issue. + +<Copyright /> diff --git a/osma/npm-api.mdx b/osma/npm-api.mdx @@ -2,6 +2,8 @@ title: "NPM API" --- +import Copyright from "/snippets/copyright.mdx"; + **Base URL:** `https://notamitgamer-osma-npm-api.hf.space` ## GET /ping @@ -93,3 +95,5 @@ curl "https://notamitgamer-osma-npm-api.hf.space/search?q=react&limit=5" ] } ``` + +<Copyright /> diff --git a/osma/pypi-api.mdx b/osma/pypi-api.mdx @@ -2,6 +2,8 @@ title: "PyPI API" --- +import Copyright from "/snippets/copyright.mdx"; + **Base URL:** `https://notamitgamer-osma-pypi-api.hf.space` ## GET /ping @@ -92,3 +94,5 @@ curl "https://notamitgamer-osma-pypi-api.hf.space/search?q=requests&limit=5" ] } ``` + +<Copyright /> diff --git a/osma/quickstart.mdx b/osma/quickstart.mdx @@ -2,6 +2,8 @@ title: "Quick Start" --- +import Copyright from "/snippets/copyright.mdx"; + OSMA has fully open CORS and requires no authentication keys, so you can start fetching package data immediately โ€” from a backend script, a CLI tool, or directly inside a browser application. ## JavaScript (browser & Node.js) @@ -73,3 +75,5 @@ curl -s "https://notamitgamer-osma-npm-api.hf.space/search?q=express&limit=3" | These endpoints are subject to the standard free-tier rate limits (10 requests/minute, 100/hour). If you're writing a script that loops through hundreds of packages, you'll need an `X-Bypass-Token` โ€” see [Utility Endpoints](/osma/utility). </Info> + +<Copyright /> diff --git a/osma/utility.mdx b/osma/utility.mdx @@ -2,6 +2,8 @@ title: "Utility Endpoints" --- +import Copyright from "/snippets/copyright.mdx"; + These endpoints are available on both the NPM and PyPI APIs. Examples below use the NPM base URL. ## GET /debug-ip @@ -35,3 +37,5 @@ curl "https://notamitgamer-osma-npm-api.hf.space/get-bypass?secret=YOUR_SECRET_H ## GET /rebuild Forces the server to re-download the latest CSV dataset from HuggingFace and rebuild the SQLite database in the background. Requires the `secret` parameter. Responds with `503` while rebuilding. + +<Copyright /> diff --git a/snippets/copyright.mdx b/snippets/copyright.mdx @@ -0,0 +1,3 @@ +<p className="mt-16 border-t border-gray-200 pt-6 text-sm text-gray-500 dark:border-gray-800 dark:text-gray-400"> + Copyright ยฉ 2025โ€“2026 <a href="https://github.com/notamitgamer" target="_blank" rel="noopener noreferrer">Amit Dutta</a> +</p> diff --git a/veyrix/architecture.mdx b/veyrix/architecture.mdx @@ -3,6 +3,8 @@ title: "Architecture & State Management" sidebarTitle: "Architecture & State" --- +import Copyright from "/snippets/copyright.mdx"; + ## Visual system design Data flows through three strictly isolated layers: @@ -61,3 +63,5 @@ Compresses the payload with `LZString.compressToEncodedURIComponent`, yielding a ### 2. Cloud share (Firestore) Authenticates using `signInAnonymously()`, pushes the payload to the `shared_snippets` root collection, and returns a lightweight document ID reference in the URL. + +<Copyright /> diff --git a/veyrix/faq.mdx b/veyrix/faq.mdx @@ -3,6 +3,8 @@ title: "Frequently Asked Questions" sidebarTitle: "FAQ" --- +import Copyright from "/snippets/copyright.mdx"; + **Where are my files stored?** All files are stored locally on your device inside your browser's secure IndexedDB. They're never uploaded to any server automatically โ€” you maintain full ownership and privacy of your code. Only cloud share sends files to a server. @@ -17,3 +19,5 @@ Syntax highlighting for 50+ languages via Ace Editor. Common formats โ€” HTML, C **Can I install Veyrix as an app?** Yes โ€” it's a Progressive Web App. Tap the menu button, then "Install Web App." It runs fullscreen without browser toolbars. + +<Copyright /> diff --git a/veyrix/index.mdx b/veyrix/index.mdx @@ -2,6 +2,8 @@ title: "Veyrix IDE" --- +import Copyright from "/snippets/copyright.mdx"; + _v1.1.0 โ€” Stable_ Veyrix is a lightweight, offline-first Progressive Web App (PWA) that turns your browser into a highly responsive code editor. It's designed to run smoothly in strict or restricted browser environments, keeping all processing and storage entirely client-side with no backend server. @@ -47,3 +49,5 @@ Visit the live site to start using Veyrix IDE immediately โ€” no installation re ## Legal disclaimer & licensing Veyrix IDE and its documentation are provided "as is" under the **Apache License 2.0**, without warranty of any kind, express or implied. The creator reserves the right to modify or permanently discontinue the project at any time without prior notice, is not responsible for data loss, service interruptions, or damages arising from use of the software, and places sole responsibility for local data management on the user. + +<Copyright /> diff --git a/veyrix/performance.mdx b/veyrix/performance.mdx @@ -3,6 +3,8 @@ title: "Performance & Benchmarks" sidebarTitle: "Performance & Errors" --- +import Copyright from "/snippets/copyright.mdx"; + By stripping away Webpack overhead, Virtual DOM reconciliation, and heavy language servers, Veyrix operates on a fraction of the hardware requirements of modern cloud IDEs. | Environment | Base RAM (idle) | Editor engine | Time to interactive | @@ -26,3 +28,5 @@ Safari and Firefox frequently restrict or completely block IndexedDB access in P ## DOMException: QuotaExceededError Triggered when the device runs out of disk space, or the browser's origin quota is exceeded. Veyrix catches this in the `DB.save()` promise rejection, halting autosave and notifying the user to clear space or delete older snapshots. + +<Copyright /> diff --git a/veyrix/roadmap.mdx b/veyrix/roadmap.mdx @@ -3,6 +3,8 @@ title: "Current Limitations" sidebarTitle: "Limitations & Roadmap" --- +import Copyright from "/snippets/copyright.mdx"; + - **Flat file system** โ€” the main IDE has no directory/subfolder support; flat array mapping only (Veyrix Web solves this separately with a true VFS) - **Snapshot limit** โ€” hardcoded FIFO limit of 5 snapshots per file, to prevent storage quota bloat - **No language servers** โ€” relies entirely on basic Ace autocompletion arrays; no deep IntelliSense (LSP) @@ -23,3 +25,5 @@ sidebarTitle: "Limitations & Roadmap" **v1.0.2** โ€” Implemented a draggable split-pane interface (Dynamic Viewport Resizer), letting users manually adjust preview width to simulate and test designs across device breakpoints. **v1.0.1** โ€” Introduced nested folder mapping, batch file uploads, and a persistence-linked tab system for navigating complex project structures (Advanced File System & Workspace). + +<Copyright /> diff --git a/veyrix/security.mdx b/veyrix/security.mdx @@ -3,6 +3,8 @@ title: "Cryptography & Security Model" sidebarTitle: "Security & Threat Model" --- +import Copyright from "/snippets/copyright.mdx"; + ## Zero-knowledge cloud password protection When a user applies a password to a Cloud Share snippet, the plaintext password is **never** transmitted to Firebase. Veyrix uses the native Web Crypto API to generate a SHA-256 hash locally instead: @@ -30,3 +32,5 @@ Veyrix is an editor, not an evaluator. The Ace Editor parses content into Abstra ### 3. Cloud anonymity Firebase interactions use `signInAnonymously()`. Data is tied to a temporary, anonymous session UID. Firebase Security Rules are assumed to enforce read/write access correctly based on the snippet UID, but shared URLs are considered semi-public unless protected with the SHA-256 password hash described above. + +<Copyright /> diff --git a/veyrix/usage-guide.mdx b/veyrix/usage-guide.mdx @@ -3,6 +3,8 @@ title: "Comprehensive Usage Guide" sidebarTitle: "Usage Guide" --- +import Copyright from "/snippets/copyright.mdx"; + How to operate Veyrix IDE effectively โ€” file management, keyboard shortcuts, versioning, and sharing. ## 1. Managing files @@ -36,3 +38,5 @@ Click the Share icon to open the sharing modal. Three options: **Cloud share** โ€” uploads your code to an anonymous, secure Firebase database and generates a short link. Can optionally be protected with a password (hashed client-side โ€” see [Security & Threat Model](/veyrix/security)). **Share via device** โ€” uses your phone or computer's native share menu (AirDrop, WhatsApp, Email, etc.) to send the raw text of your code. + +<Copyright /> diff --git a/veyrix/veyrix-web.mdx b/veyrix/veyrix-web.mdx @@ -3,6 +3,8 @@ title: "Veyrix Web (Multi-File IDE)" sidebarTitle: "Veyrix Web (Multi-File)" --- +import Copyright from "/snippets/copyright.mdx"; + Veyrix Web (`web.html`) is an advanced, multi-file environment built specifically for web development. Unlike the single-file main IDE, it uses a robust virtual file system with directory structures, multi-tab editing, and an integrated real-time preview window. ## Isolated database (VeyrixWebFS) @@ -35,3 +37,5 @@ Unlike the main IDE (flat single files), Veyrix Web lets you export your entire - **Combine HTML** โ€” leverages the PreviewEngine to bundle all CSS, JavaScript, and Base64 images into a single monolithic `index.html`. Good for quick sharing or embedding in systems that don't support multi-file directories. - **ZIP archive export** โ€” dynamically loads the `JSZip` library only when requested, maps over the virtual file system, constructs a standard directory structure, and outputs a downloadable `.zip` preserving all relative paths and binary formats. + +<Copyright /> diff --git a/whatsapp-logger/connect-whatsapp.mdx b/whatsapp-logger/connect-whatsapp.mdx @@ -3,6 +3,8 @@ title: "Step 3: Connect WhatsApp" sidebarTitle: "3. Connect WhatsApp" --- +import Copyright from "/snippets/copyright.mdx"; + 1. Open your Render URL (`https://your-app.onrender.com`) in a browser. 2. Log in with the `AUTH_USER` / `AUTH_PASS` you set in Render. 3. You'll see a **QR code**. @@ -13,3 +15,5 @@ sidebarTitle: "3. Connect WhatsApp" 6. The page refreshes and shows **"System Operational"** โ€” your backend is now listening. Continue to [Setup the Frontend](/whatsapp-logger/setup-frontend). + +<Copyright /> diff --git a/whatsapp-logger/deploy-backend.mdx b/whatsapp-logger/deploy-backend.mdx @@ -3,6 +3,8 @@ title: "Step 2: Deploy Backend (The Listener)" sidebarTitle: "2. Deploy Backend" --- +import Copyright from "/snippets/copyright.mdx"; + 1. **Fork the repository** to your own GitHub account: [WhatsApp-Logger-Self-Hosted-](https://github.com/notamitgamer/WhatsApp-Logger-Self-Hosted-) 2. Log in to [Render](https://render.com/). 3. Click **New +** โ†’ **Web Service**. @@ -53,3 +55,5 @@ module.exports = { `EXCLUDED_JIDS` is a set of full JIDs (the `...@s.whatsapp.net` / `...@g.us` / `...@lid` identifiers, not just a phone number) that are skipped entirely โ€” they won't be cached, streamed, or included in exports. It ships empty by default. You can find a chat's exact JID from the live server logs (see the tip above) the first time it logs a message, then add it here, e.g. `new Set(['917278779512@s.whatsapp.net', '201554426618024@lid'])`, and redeploy. Continue to [Connect WhatsApp](/whatsapp-logger/connect-whatsapp). + +<Copyright /> diff --git a/whatsapp-logger/faqs.mdx b/whatsapp-logger/faqs.mdx @@ -2,6 +2,8 @@ title: "Frequently Asked Questions" --- +import Copyright from "/snippets/copyright.mdx"; + ## General - **Is this really free?** @@ -69,3 +71,5 @@ The logger starts empty. It only records messages that arrive *after* you have l **I forgot my App PIN/Password** On the lock screen, click "Forgot PIN". You can reset your local security using the server credentials (`AUTH_USER` and `AUTH_PASS`) you set in Render. + +<Copyright /> diff --git a/whatsapp-logger/firebase-setup.mdx b/whatsapp-logger/firebase-setup.mdx @@ -3,6 +3,8 @@ title: "Step 1: Firebase Setup (The Database)" sidebarTitle: "1. Firebase Setup" --- +import Copyright from "/snippets/copyright.mdx"; + 1. Go to the [Firebase Console](https://console.firebase.google.com/) and create a new project. ## Create the database @@ -51,3 +53,5 @@ This file grants admin access to your database. You'll paste its contents into a That's everything you need from Firebase โ€” the frontend doesn't need any Firebase configuration at all. It only ever talks to your Render backend, which uses the service account credentials above. Continue to [Deploy the Backend](/whatsapp-logger/deploy-backend). + +<Copyright /> diff --git a/whatsapp-logger/index.mdx b/whatsapp-logger/index.mdx @@ -3,6 +3,8 @@ title: "WhatsApp Logger (Self-Hosted)" sidebarTitle: "WhatsApp Logger" --- +import Copyright from "/snippets/copyright.mdx"; + A privacy-focused, self-hosted WhatsApp archiving tool. It captures messages โ€” including deleted ones โ€” via a linked device connection and stores them in your own Firebase Firestore database. ## Upgrade notes (v4.2.x) @@ -49,3 +51,5 @@ Yes. WhatsApp bans accounts for *sending* spam or unauthorized automated message ## Disclaimer This tool is for personal archiving purposes. Using it to log conversations without consent may violate privacy laws in your jurisdiction. The author is not responsible for misuse. + +<Copyright /> diff --git a/whatsapp-logger/keep-alive.mdx b/whatsapp-logger/keep-alive.mdx @@ -3,6 +3,8 @@ title: "Step 6: Keep it Alive (UptimeRobot)" sidebarTitle: "6. Keep it Alive" --- +import Copyright from "/snippets/copyright.mdx"; + Render's free tier spins down after inactivity. To keep your logger running 24/7: 1. Create a free account on [UptimeRobot](https://uptimerobot.com/). @@ -12,3 +14,5 @@ Render's free tier spins down after inactivity. To keep your logger running 24/7 5. **URL (or IP)**: `https://your-app.onrender.com/ping` (make sure to include `/ping`) 6. **Monitoring Interval**: 5 minutes 7. Click **Create Monitor**. + +<Copyright /> diff --git a/whatsapp-logger/prerequisites.mdx b/whatsapp-logger/prerequisites.mdx @@ -2,6 +2,8 @@ title: "Prerequisites" --- +import Copyright from "/snippets/copyright.mdx"; + Before you start, make sure you have the following: 1. A **GitHub** account @@ -18,3 +20,5 @@ Before you start, make sure you have the following: - **UptimeRobot** โ€” pings your Render backend every 5 minutes so the free tier doesn't spin down from inactivity Continue to [Firebase Setup](/whatsapp-logger/firebase-setup). + +<Copyright /> diff --git a/whatsapp-logger/setup-frontend.mdx b/whatsapp-logger/setup-frontend.mdx @@ -3,6 +3,8 @@ title: "Step 4: Setup Frontend (The Viewer)" sidebarTitle: "4. Setup Frontend" --- +import Copyright from "/snippets/copyright.mdx"; + 1. Download `index.html` from the repository. 2. Open it in a text editor. 3. Find the configuration line near the top of the `<script>` block. Before editing, it looks like this: @@ -24,3 +26,5 @@ You can host this single file anywhere: - **Netlify / Vercel**: drag and drop the folder containing `index.html` Continue to [Usage](/whatsapp-logger/usage). + +<Copyright /> diff --git a/whatsapp-logger/troubleshooting.mdx b/whatsapp-logger/troubleshooting.mdx @@ -2,6 +2,8 @@ title: "Troubleshooting" --- +import Copyright from "/snippets/copyright.mdx"; + **"No chats found"** : Send a message to the linked WhatsApp account to trigger the first log. @@ -10,3 +12,5 @@ title: "Troubleshooting" **Chat shows a long ID (e.g. `1155...@lid`) instead of a phone number** : Wait a few minutes โ€” the backend automatically syncs contacts and updates the record with the real phone number. + +<Copyright /> diff --git a/whatsapp-logger/usage.mdx b/whatsapp-logger/usage.mdx @@ -3,6 +3,8 @@ title: "Step 5: Usage" sidebarTitle: "5. Usage" --- +import Copyright from "/snippets/copyright.mdx"; + 1. Navigate to your hosted frontend URL. 2. You'll see a login screen. 3. Enter the same `AUTH_USER` / `AUTH_PASS` configured on Render. @@ -20,3 +22,5 @@ If you open a chat and it shows nothing even though the server has history for i Pick between Catppuccin Latte (light), Catppuccin Mocha (dark), or a true-black AMOLED theme under `Settings` โ†’ `Appearance` โ†’ `Theme`. Continue to [Keep it Alive](/whatsapp-logger/keep-alive). + +<Copyright />