2019-01-30 06:10:29 +00:00
< p align = "center" >
2018-03-03 09:38:27 +00:00
2019-02-01 19:55:59 +00:00
< img src = "./docs/onionr-logo.png" width = '250' >
2019-01-30 06:10:29 +00:00
< / p >
2019-02-01 06:38:12 +00:00
< p align = "center" >
2019-05-07 17:56:20 +00:00
Anonymous P2P communication network 🕵️
2019-02-01 06:38:12 +00:00
< / p >
2019-02-01 19:55:59 +00:00
(***pre-alpha & experimental, not well tested or easy to use yet***)
2018-09-07 04:57:10 +00:00
2018-04-01 06:40:31 +00:00
[](https://github.com/ellerbrock/open-source-badges/)
2019-02-15 03:28:41 +00:00
< img src = 'https://gitlab.com/beardog/Onionr/badges/master/build.svg' >
2018-04-01 06:40:31 +00:00
2018-08-14 05:02:34 +00:00
< hr >
2018-01-05 09:16:21 +00:00
2019-01-30 06:10:29 +00:00
**The main repository for this software is at https://gitlab.com/beardog/Onionr/**
2018-01-05 09:16:21 +00:00
2019-04-11 22:01:18 +00:00
# About
2018-08-14 05:02:34 +00:00
2019-05-07 17:56:20 +00:00
Onionr is a decentralized, peer-to-peer communication and storage network, designed to be anonymous and resistant to (meta)data analysis and spam/disruption.
2018-08-14 05:02:34 +00:00
2019-04-11 22:01:18 +00:00
Onionr stores data in independent packages referred to as 'blocks'. The blocks are synced to all other nodes in the network. Blocks and user IDs cannot be easily proven to have been created by a particular user. Even if there is enough evidence to believe that a specific user created a block, nodes still operate behind Tor or I2P and as such cannot be trivially unmasked.
2018-08-14 05:02:34 +00:00
2019-05-11 18:32:56 +00:00
Users are identified by ed25519/curve25519 public keys, which can be used to sign blocks or send encrypted data.
2019-01-30 06:10:29 +00:00
Onionr can be used for mail, as a social network, instant messenger, file sharing software, or for encrypted group discussion.
2018-02-21 03:17:24 +00:00
2019-04-09 17:30:54 +00:00
The whitepaper (subject to change prior to first alpha release) is available [here ](docs/whitepaper.md ).
2019-05-07 17:56:20 +00:00
2018-05-19 05:56:26 +00:00
2019-01-30 06:10:29 +00:00
## Main Features
2018-08-14 05:02:34 +00:00
2019-03-05 06:06:49 +00:00
* [X] 🌐 Fully p2p/decentralized, no trackers or other single points of failure
* [X] 🔒 End to end encryption of user data
* [X] 📢 Optional non-encrypted blocks, useful for blog posts or public file sharing
2019-04-11 22:01:18 +00:00
* [X] 💻 Easy API for integration to websites
2019-03-05 06:06:49 +00:00
* [X] 🕵️ Metadata analysis resistance and anonymity
* [X] 📡 Transport agnosticism (no internet required)
2018-08-14 05:02:34 +00:00
2019-01-30 06:10:29 +00:00
**Onionr API and functionality is subject to non-backwards compatible change during pre-alpha development**
2018-02-21 03:17:24 +00:00
2019-03-05 06:06:49 +00:00
# Screenshots
< img alt = 'Node statistics page screenshot' src = 'docs/onionr-1.png' width = 600 >
Node statistics
< img alt = 'Friend/contact manager screenshot' src = 'docs/onionr-2.png' width = 600 >
Friend/contact manager
< img alt = 'Encrypted, metadata-masking mail application screenshot' src = 'docs/onionr-3.png' width = 600 >
2019-05-07 17:56:20 +00:00
Encrypted, metadata-masking mail application. One of the first distributed mail systems to have basic forward secrecy.
2019-03-05 06:06:49 +00:00
2019-04-12 17:14:16 +00:00
# Documentation
More docs coming soon.
* [Block specification ](docs/specs/block-spec.md )
* [HTTP API ](docs/http-api.md )
2019-01-30 06:10:29 +00:00
# Install and Run on Linux
2018-01-05 09:16:21 +00:00
2019-01-30 06:10:29 +00:00
The following applies to Ubuntu Bionic. Other distros may have different package or command names.
2019-03-09 01:57:44 +00:00
* Have python3.6+, python3-pip, Tor (daemon, not browser) installed (python3-dev recommended)
2019-01-30 06:10:29 +00:00
* Clone the git repo: `$ git clone https://gitlab.com/beardog/onionr`
* cd into install direction: `$ cd onionr/`
2019-03-09 06:37:57 +00:00
* Install the Python dependencies ([virtualenv strongly recommended](https://virtualenv.pypa.io/en/stable/userguide/)): `$ pip3 install --require-hashes -r requirements.txt`
(--require-hashes is intended to prevent exploitation via compromise of Pypi/CA certificates)
2018-01-20 07:23:09 +00:00
2018-08-14 05:02:34 +00:00
## Help out
2018-02-07 09:04:58 +00:00
2019-01-30 06:10:29 +00:00
Everyone is welcome to help out. Help is wanted for the following:
* Development (Get in touch first)
2019-03-05 06:06:49 +00:00
* Creation of a shared lib for use from other languages and faster proof-of-work
2019-02-01 19:55:59 +00:00
* Android and IOS development
2019-03-05 06:06:49 +00:00
* Windows and Mac support (already partially supported, testers needed)
2019-02-01 19:55:59 +00:00
* General bug fixes and development of new features
2019-01-30 06:10:29 +00:00
* Testing
2019-03-05 06:06:49 +00:00
* UI/UX design
2019-01-30 06:10:29 +00:00
* Running stable nodes
* Security review/audit
2019-02-03 18:19:50 +00:00
* Automatic I2P setup
2018-04-01 06:40:31 +00:00
2019-03-05 06:06:49 +00:00
Contribute money:
Donating at least $5 gets you cool Onionr stickers. Get in touch if you want them.
Bitcoin: [1onion55FXzm6h8KQw3zFw2igpHcV7LPq ](bitcoin:1onion55FXzm6h8KQw3zFw2igpHcV7LPq ) (Contact us for privacy coins like Monero)
USD (Card/Paypal): [Ko-Fi ](https://www.ko-fi.com/beardogkf )
2019-03-05 15:57:07 +00:00
Note: probably not tax deductible
2019-03-05 06:06:49 +00:00
## Contact
beardog [ at ] mailbox.org
2018-04-01 06:40:31 +00:00
2018-01-20 07:23:09 +00:00
## Disclaimer
2019-03-09 06:37:57 +00:00
The Tor Project and I2P developers do not own, create, or endorse this project, and are not otherwise involved.
Tor is a trademark for the Tor Project. We do not own it.
2018-04-01 06:40:31 +00:00
2019-03-13 21:10:11 +00:00
The 'open source badge' is by Maik Ellerbrock and is licensed under a Creative Commons Attribution 4.0 International License.
## Logo
The Onionr logo was created by [Anhar Ismail ](https://github.com/anharismail ) under the [Creative Commons Attribution 4.0 International License ](https://creativecommons.org/licenses/by/4.0/ ).
2019-05-07 17:56:20 +00:00
If you modify and redistribute our code ("forking"), please use a different logo and project name to avoid confusion. Please do not use our logo in a way that makes it seem like we endorse you without permission.
