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-02-01 19:55:59 +00:00
Anonymous P2P storage 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/)
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
2018-08-14 05:02:34 +00:00
# Summary
2019-02-01 19:55:59 +00:00
Onionr is a decentralized, peer-to-peer data storage network, designed to be anonymous and resistant to (meta)data analysis and spam/disruption.
2018-08-14 05:02:34 +00:00
2019-02-01 19:55:59 +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 particular nodes (only inferred). Even if there is enough evidence to believe a particular node created a block, nodes still operate behind Tor or I2P and as such are not trivially known to be at a particular IP address.
2018-08-14 05:02:34 +00:00
2019-02-01 06:38:12 +00:00
Users are identified by ed25519 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-02-01 19:55:59 +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
2018-02-21 03:17:24 +00:00
* [X] Fully p2p/decentralized, no trackers or other single points of failure
2018-08-14 05:02:34 +00:00
* [X] End to end encryption of user data
2018-02-21 03:17:24 +00:00
* [X] Optional non-encrypted blocks, useful for blog posts or public file sharing
2018-08-14 05:02:34 +00:00
* [X] Easy API system for integration to websites
2019-01-21 06:28:51 +00:00
* [X] Metadata analysis resistance
2019-02-01 19:55:59 +00:00
* [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-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.
* Have python3.5+, python3-pip, Tor (daemon, not browser) installed (python3-dev recommended)
* Clone the git repo: `$ git clone https://gitlab.com/beardog/onionr`
* cd into install direction: `$ cd onionr/`
* Install the Python dependencies ([virtualenv strongly recommended](https://virtualenv.pypa.io/en/stable/userguide/)): `$ pip3 install -r requirements.txt`
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-02-01 19:55:59 +00:00
* Creation of a lib for use from other languages and faster proof-of-work
* Android and IOS development
2019-01-30 06:10:29 +00:00
* Windows and Mac support
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
* 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-02-01 19:55:59 +00:00
Bitcoin: [1onion55FXzm6h8KQw3zFw2igpHcV7LPq ](bitcoin:1onion55FXzm6h8KQw3zFw2igpHcV7LPq )
USD: [Ko-Fi ](https://www.ko-fi.com/beardogkf )
2018-04-01 06:40:31 +00:00
2018-01-20 07:23:09 +00:00
## Disclaimer
The Tor Project, I2P developers, and anyone else do not own, create, or endorse this project, and are not otherwise involved.
2018-04-01 06:40:31 +00:00
2019-02-01 19:55:59 +00:00
The 'open source badge' is by Maik Ellerbrock and is licensed under a Creative Commons Attribution 4.0 International License.
