2019-01-30 06:10:29 +00:00
< p align = "center" >
2018-03-03 09:38:27 +00:00
2019-01-30 06:10:29 +00:00
< img src = "./docs/onionr-logo.png" >
< / p >
(***pre-alpha quality & 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
[![Open Source Love ](https://badges.frapsoft.com/os/v3/open-source.png?v=103 )](https://github.com/ellerbrock/open-source-badges/)
2018-01-15 21:13:58 +00:00
2018-03-03 09:31:57 +00:00
Anonymous P2P platform, using Tor & I2P.
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
Onionr is a decentralized, peer-to-peer data storage network, designed to be anonymous and resistant to (meta)data analysis and spam.
2019-01-30 06:10:29 +00:00
Onionr stores data in independent packages referred to as 'blocks' (not to be confused with a blockchain). 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).
2018-08-14 05:02:34 +00:00
2019-01-30 06:10:29 +00:00
Users are identified by ed25519 public keys, which can be used to sign blocks (optional) or send encrypted data.
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
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
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)
* Creation of a shared object library for use from other languages and faster proof-of-work
* Onionr mobile app development
* Windows and Mac support
* General development
* Testing
* Running stable nodes
* Security review/audit
2018-04-01 06:40:31 +00:00
Bitcoin/Bitcoin Cash: 1onion55FXzm6h8KQw3zFw2igpHcV7LPq
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-01-30 06:10:29 +00:00
The badges (besides travis-ci build) are by Maik Ellerbrock is licensed under a Creative Commons Attribution 4.0 International License.