Skip to content

Latest commit

 

History

History
95 lines (58 loc) · 2.96 KB

README.md

File metadata and controls

95 lines (58 loc) · 2.96 KB
Raw

🌈 Chai: Your Zero Trust Document Viewer! 🌟

Visit us on GitHub

Please note: right now this repository is mirroring the version of chai used in BrowserBox and has not been tested to run separate to BrowserBox. The goal eventually is to create an isomorphic chai that mirrors BrowserBox's latest changes while continuing to operate independently when not configured nor run as part of BrowserBox remote browser isolation system.

The Future of Secure Document Viewing is Here! 🎉

Convert documents into spectacular images for each page, and view them securely in your browser! No downloads, no third-party apps—just pure, joyful, Zero Trust goodness! Proudly part of the BrowserBox Pro cloud browser product by Dosyago.

🌈 Why You'll Love Chai 🌈

  • Zero Trust Security: Your document stays with you, always! 🛡️
  • Universal Formats: PDF, DOC, XLSX—we speak all languages! 🌐
  • High-Performance: Get ready to be amazed by the speed! 🚀
  • Open Source: Built by the community, for the community! 💖

✨ How the Magic Happens ✨

  1. Send Us Your Document: Upload a file or just drop a URL.
  2. Transformation Time: We convert it into a beautiful gallery of high-quality images. 🎨
  3. Enjoy: Open your browser to a vivid, scrollable display of your document. 🌠

🌟 SEO Keywords 🌟

  • Zero Trust Document Viewer
  • Secure PDF Viewer
  • Browser-based Document Viewer
  • Multi-Format Document Viewer

🚀 Quick Start Guide 🚀

# Clone the treasure!
git clone https://github.com/dosyago/chai.git
# Enter the magical kingdom
cd chai
# Set up the wizardry
./scripts/setup.sh
# Ignite the spark!
./scripts/restart.sh

If you just want to run the server temporarily, you can hit npm start instead of the pm2-using ./scripts/restart.sh

🌠 Pro Tips and Tricks 🌠

  • Got SSL certs? Place them in $HOME/sslcerts/ and we'll go HTTPS! 🌐
  • Tweak the secret=<your secret> URL parameter for extra magical powers. 🌟
  • Document lifespan is 3 days by default, but feel free to change that in /public/uploads/clean.sh. 🕰️

🎉 Turn It into an API 🎉

Want more? Use the POST endpoint with a secret= parameter to authorize conversion via a secure HTTPS API.

🌈 System Requirements 🌈

We recommend a beefy machine with at least 4 cores and 8 GB RAM for a spellbinding experience.

🌟 Special Thanks 🌟

*No affiliation

📜 License 📜

Non-commercial (Polyform Noncommercial 1.0) use or commercial licenses purchasable. For custom licensing options, email us at [email protected].

Enjoy your Documents Responsibly with Chai! 🌈