mirror of
https://github.com/onionshare/onionshare.git
synced 2025-07-21 05:52:15 -04:00
Update README.md
This commit is contained in:
parent
2959172b6c
commit
650178d029
1 changed files with 96 additions and 12 deletions
108
README.md
108
README.md
|
@ -1,23 +1,107 @@
|
|||

|
||||
# 🧅 OnionShare
|
||||
|
||||

|
||||
|
||||
[](https://github.com/onionshare/onionshare/actions/workflows/tests.yml)
|
||||
|
||||
# OnionShare
|
||||
**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.
|
||||
|
||||
OnionShare is an open source tool that lets you securely and anonymously share files, host websites, and chat with friends using the Tor network.
|
||||
---
|
||||
|
||||
## Installing OnionShare
|
||||
## ✨ Features
|
||||
|
||||
You can download OnionShare for Windows and macOS from the [OnionShare website](https://onionshare.org).
|
||||
- 📁 **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
|
||||
|
||||
For macOS you can also use [Homebrew](https://brew.sh/):
|
||||
---
|
||||
|
||||
```
|
||||
## 🛠️ Installation
|
||||
|
||||
### Windows & macOS
|
||||
Download the latest release from the [official website](https://onionshare.org).
|
||||
|
||||
### macOS (via Homebrew)
|
||||
```bash
|
||||
brew install --cask onionshare
|
||||
````
|
||||
|
||||
### Linux
|
||||
|
||||
You can install via Flatpak or Snap.
|
||||
See the full guide here: [Installation Instructions](https://docs.onionshare.org/2.6/en/install.html#linux)
|
||||
|
||||
---
|
||||
|
||||
## 🚀 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](https://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](https://docs.onionshare.org/en/latest/security.html).
|
||||
|
||||
---
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
Contributions are welcome!
|
||||
|
||||
* 💬 Join [Discussions](https://github.com/onionshare/onionshare/discussions)
|
||||
* 🐛 Report [Issues](https://github.com/onionshare/onionshare/issues)
|
||||
* 📂 Fork and submit Pull Requests
|
||||
|
||||
Check the [developer documentation](https://docs.onionshare.org/en/latest/development.html) to get started.
|
||||
|
||||
---
|
||||
|
||||
## 🧑💻 License
|
||||
|
||||
OnionShare is released under the **GNU General Public License v3.0**.
|
||||
See [`LICENSE`](LICENSE) for details.
|
||||
|
||||
---
|
||||
|
||||
## 💬 Support & Community
|
||||
|
||||
* Website: [onionshare.org](https://onionshare.org)
|
||||
* Docs: [docs.onionshare.org](https://docs.onionshare.org)
|
||||
* GitHub: [github.com/onionshare](https://github.com/onionshare)
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ 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.
|
||||
|
||||
---
|
||||
|
||||
```
|
||||
|
||||
See [these instructions](https://docs.onionshare.org/2.6/en/install.html#linux) to install OnionShare in Linux as a Flatpak or Snap package.
|
||||
|
||||
## Documentation
|
||||
|
||||
To learn how OnionShare works, what its security properties are, how to use it, and how to contribute to the project, check out https://docs.onionshare.org.
|
||||
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).
|
||||
```
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue