Git-Mirrors/onionshare
1
0
Fork 0
mirror of https://github.com/onionshare/onionshare.git synced 2025-08-10 23:30:34 -04:00
Code Issues Projects Releases Packages Wiki Activity
Securely and anonymously share files, host websites, and chat with friends using the Tor network
5599 commits 37 branches 46 tags 49 MiB
Find a file
nadim 650178d029
Update README.md
2025-07-07 16:50:34 +06:00
.github Update build workflow for windows as platform name has changed for get-tor.py 2025-04-01 16:13:01 +11:00
cli Merge pull request #2022 from onionshare/mig/jinja2-3.1.6 2025-03-06 12:40:56 +05:30
desktop Translated using Weblate (Tamil) 2025-06-20 17:04:57 +00:00
docs Translated using Weblate (Tamil) 2025-06-20 17:04:57 +00:00
flatpak Update Jinja2 in the flatpak onionshare-cli.yaml generated file 2025-03-06 16:37:50 +11:00
licenses Use SVGs instead of PNGs for FontAwesome icons 2025-02-17 09:27:20 +11:00
security Add pen test report 2022-01-17 10:33:28 -08:00
snap Update requirements.txt files (exported from poetry) for snap to pick up Jinja2 update 2025-03-06 16:32:04 +11:00
.gitignore Initial support for Linux 64-bit, desktop/scripts/get-tor.py for macos-aarch64 2022-10-28 20:08:44 +02:00
build-source.sh Add my GPG subkey id to build-source.sh for verifying tag 2025-02-20 13:47:38 +11:00
CHANGELOG.md Update CHANGELOG 2025-02-17 16:58:15 +11:00
LICENSE.txt Rename LICENSE to LICENSE.txt 2023-10-17 12:25:05 -07:00
README.md Update README.md 2025-07-07 16:50:34 +06:00
RELEASE.md Update the RELEASE.md to reflect some of my recent experience with 2.6.3 2025-02-27 12:05:15 +11:00
setup-project.sh check for golang installation and exit if no installation found 2025-02-27 17:09:39 +05:30

README.md

🧅 OnionShare

OnionShare Logo

Run Tests

OnionShare is a free and open-source tool that lets you securely and anonymously share files, host websites, and chat with friends using the Tor network—without relying on any third parties.

✨ Features

  • 📁 Secure File Sharing – Send files of any size over the Tor network
  • 🌐 Anonymous Website Hosting – Host static sites directly from your computer
  • 📥 Receive Files Anonymously – Create dropboxes for others to send you files
  • 💬 Secure Chat Rooms – Create encrypted, ephemeral chatrooms
  • 🔐 Built-in Privacy – No metadata logs, no IP leaks, no accounts required
  • 🚫 Auto-shutdown – The onion service ends when the session is over

🛠️ Installation

Windows & macOS

Download the latest release from the official website.

macOS (via Homebrew)

brew install --cask onionshare

Linux

You can install via Flatpak or Snap. See the full guide here: Installation Instructions

🚀 Quick Start

  1. Launch OnionShare
  2. Select a mode: Share Files, Receive Files, Chat, or Host Website
  3. A .onion address is generated
  4. Share this address with your recipient
  5. When you're done, stop the session—your service disappears

📚 Documentation

Visit docs.onionshare.org for detailed documentation, including:

  • How OnionShare works under the hood
  • Security and privacy considerations
  • Advanced configuration
  • Developer and contributor guides

🔐 Security Overview

  • Tor Network: All traffic routes through the Tor network via onion services
  • No Logging: OnionShare does not log any information
  • End-to-End Encryption: Secure chats and file transfers
  • Optional Access Control: Add passwords to protect access

Read more about OnionShare's security model.

🤝 Contributing

Contributions are welcome!

Check the developer documentation to get started.

🧑‍💻 License

OnionShare is released under the GNU General Public License v3.0. See LICENSE for details.

💬 Support & Community

⚠️ Disclaimer

OnionShare enhances anonymity and privacy, but your security also depends on how you use it. Be aware of your personal threat model and always use best practices when sharing sensitive data.


Let me know if you want this `README.md` in downloadable form or if you'd like to add badges (e.g., license, version, downloads).