Code Monkey home page Code Monkey logo

wirtbot's Introduction

WirtBot logo

WirtBot®

A real VPN for the modern digitalist


Welcome to the WirtBot repository.

Run in Docker

Check out this page

Setup WirtBot VPS

  • Install:

    • ansible
    • sshpass (necessary to login via SSH to your servers root user via password for the setup)
    • node
  • Run: npm install -g @wirtbot/installer && wirt-installer

  • Join the network with generated WireGuard® config

  • Assume control of WirtBot by importing generated initial configuration

  • Done

What is this for?

Think of it as your LAN extended over the whole internet, but only accessible to your devices.

  • Do you want replace your [GoogleDrive, AppleCloud etc.] with Nextcloud?
  • Want to safely resolve DNS?
  • Developing an App/Website on your machine and want to show it off live on your phone via the internet?
  • Have loads of IOT devices that you want to be able to communicate safely with each other?

A WirtBot got you covered.

How?

WirtBot is a system/robot that is designed after the UNIX philosophy. Many small parts that do a job and do it well. Putting special importance into correct configuration. Everything is controlled via a UI that focusses on ease of use and all is glued together using Infrastructure as code. If you set it up you can rest assured that it is done properly.

Ready to get started?

Read the setup documentation at wirtbot.com/documentation/setup and get your own cloud network with 1 command on the terminal and a few clicks in your browser!

Features

  • Based on WireGuard for security and speed
  • Find all your devices by their name! DNS is included
  • Every configuration in the network is kept up to date on changes
  • Export and Import feature to keep track of multiple networks and generate Backups
  • Absolutely no tracking + everything is uniquely tied to your browser!
  • Configuration over code. Leverage existing tooling and provide a clean interface for configuring it correctly

Contributing

WirtBot System Tests WirtBot Tests WirtBot Shared-Libraries Tests

WirtBot Docker Cloud Build Status WirtBot Website Docker Cloud Build Status

You want to help out making WirtBot better? AWESOME!

Please feel free to open up an issue here in Github to discuss what you would want to do, and what kind of help I can give you.

If you want to learn about the inner workings of the system check out the developer documentation.

I also encourage you to ask questions! My goal is to document as many of those questions as I can, to allow more people to understand what is going on in the code.

For an overview of things that need help check the issues.

LICENSE

The WirtBot and Interface are licensed with GNU Affero General Public License v3.0

The documentation and WirtBot logo are provided under Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)

Donate

Would you like to contribute a bit to the server costs? ~10$ a month.

You can easily do so to the Ethereum address: 0x39DF85776c626117B945afECF08C4DD262817522

wirtbot's People

Contributors

b-m-f avatar cianooooo avatar dependabot[bot] avatar dusterthefirst avatar grollum avatar shivansh1010 avatar zanglang avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.