Metadata-Version: 2.1
Name: bitdust
Version: 0.1.6.231
Summary: p2p secure distributed storage and communication engine
Home-page: https://bitdust.io
Author: Veselin Penev, BitDust
Author-email: bitdust.io@gmail.com
Maintainer: Veselin Penev, BitDust
Maintainer-email: veselin@bitdust.io
License: Copyright (C) 2008 Veselin Penev, https://bitdust.io
Download-URL: https://bitdust.io
Description: BitDust
        =======
        
        BitDust is a peer to peer online backup utility.
        
        This is a distributed network for backup data storage. Each participant of the network provides a portion of his hard drive for other users. In exchange, he is able to store his data on other peers.
        
        The redundancy in backup makes it so if someone loses your data, you can rebuild what was lost and give it to someone else to hold. And all of this happens without you having to do a thing - the software keeps your data in safe.
        
        All your data is encrypted before it leaves your computer with a private key your computer generates. No one else can read your data, even BitDust Team! Recover data is only one way - download the necessary pieces from computers of other peers and decrypt them with your private key.
        
        BitDust is written in Python using pure Twisted framework and published under GNU AGPLv3.
        
        https://bitdust.io
        
        
        
        Current status
        ==============
        
        Current project stage is about to only research opportunities of
        building a holistic eco-system that protects your privacy in the network
        by establishing p2p communications of users and maximize distribution of
        information flows in the network.
        
        At the moment exists a very limited alpha version of the BitDust software.
        We decided to publish those earlier works to verify/test/share our ideas and experiments with other people.
        
        
        
        Install BitDust software
        ========================
        
        
        1. Install software dependencies
        
        Seems like in Ubuntu (probably most other distros) you can install all dependencies in that way:
        
                sudo apt-get install git gcc python3-dev python3-virtualenv
        
        
        Optionally, you can also install [miniupnpc](http://miniupnp.tuxfamily.org/) tool if you want BitDust automatically deal with UPnPc configuration of your network router so it can also accept incomming connections from other nodes.:
        
                sudo apt-get install miniupnpc
        
        
        On MacOSX platform you can install requirements in that way:
        
                brew install git python3
        
        And use pip to get all required packages:
        
                pip install --upgrade --user
                pip install --upgrade pip --user
                pip install virtualenv --user
        
        
        2. Get BitDust to your local machine
        
        Second step is to get the BitDust sources. To have a full control over BitDust process running on your local machine you better make a fork of the Public BitDist repository on GitHub at https://github.com/bitdust-io/public and clone it on your local machine:
        
                git clone https://github.com/<your GitHub username>/<name of BitDust fork>.git bitdust
        
        
        The software will periodically run `git fetch` and `git rebase` to check for recent commits in the repo. This way we make sure that everyone is running the latest version of the program. Once you made a fork, you will have to update your Fork manually and pull commits from Public BitDust repository if you trust them.
        
        However if you just trust BitDust contributors you can simply clone the Public repository directly and software will be up to date with the "official" public code base:
        
                git clone https://github.com/bitdust-io/public.git bitdust
        
        
        3. Building virtual environment
        
        Then you need to build virtual environment with all required Python dependencies, BitDust software will run fully isolated.
        
        Single command should make it for you, all required files will be generated in `~/.bitdust/venv/` sub-folder:
        
                cd bitdust
                python3 bitdust.py install
        
        
        Last step to make BitDust software ready is to make a short alias in your OS, then you can just type `bitdust` in command line to fast access the program:
        
                sudo ln -s -f /home/<user>/.bitdust/bitdust /usr/local/bin/bitdust
        
        
        4. Run BitDust
        
        Start using the software by creating an identity for your device in BitDust network:
        
                bitdust id create <some nick name>
        
        
        I recommend you to create another copy of your Private Key in a safe place to be able to recover your data in the future. You can do it with such command:
        
                bitdust key copy <nickname>.bitdust.key
        
        
        Your settings and local files are located in that folder: ~/.bitdust
        
        Type this command to read more info about BitDust commands:
        
                bitdust help
        
        
        To run the software type:
        
                bitdust
        
        
        Start as background process:
        
                bitdust detach
        
        
        To get some more insights or just to know how to start playing with software
        you can visit [BitDust Commands](https://bitdust.io/commands.html) page.
        
        To get more info about API methods available go to [BitDust API](https://bitdust.io/api.html) page.
        
        
        5. Binary Dependencies
        
        If you are installing BitDust on Windows platforms, you may require some binary packages already compiled and packaged for Microsoft Windows platforms, you can check following locations and download needed binaries and libraries:
        
        * cygwin: [cygwin.com](https://cygwin.com/install.html)
        * git: [git-scm.com](https://git-scm.com/download/win)
        * python2.7 or python3: [python.org](http://python.org/download/releases)
        * twisted: [twistedmatrix.com](http://twistedmatrix.com)
        * pyasn1: [pyasn1.sourceforge.net](http://pyasn1.sourceforge.net)
        * miniupnpc: [miniupnp.tuxfamily.org](http://miniupnp.tuxfamily.org/)
        
        
        
        Docker Hub container image
        ==========================
        
        You can also run bitdust inside Docker. We prepared a container which have BitDust installed and easy to run. You will have to SSH into the running container after start it and manually configure bitdust as you wish and run it:
        
                docker run -d -P --name bdnode bitdust/app1
                docker port bdnode 22
                0.0.0.0:32771  <-  learn which SSH port was opened on your host
        
        
        Now you can ssh to the container, password is `bitdust`:
        
                ssh root@localhost -p 32771
                password: bitdust
        
        
        Inside the container you will have BitDust installed and ready to use, so you can run it directly:
        
                root@1ef6a46c3042:~# bitdust
        
        
        
        Feedback
        ========
        
        You can contact [BitDust contributors](https://github.com/bitdust-io) on GitHub if you have any questions or ideas.
        Welcome to the future!
        
Keywords: p2p,peer to peer,backup,restore,storage,data,recover,distributed,online,python,twisted,messaging,websocket,encryption,crypto,protection
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Framework :: Twisted
Classifier: Intended Audience :: Customer Service
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: Other/Proprietary License
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Security
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: System :: Archiving :: Backup
Classifier: Topic :: System :: Distributed Computing
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
