WirtBot
Easily and securely extend your network into the cloud!
Welcome to the WirtBot repository.
Setup
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
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 wirt.network/docs/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
You want to help out making WirtBot better? AWESOME! For example the CI is not yet perfect as you can see with the badges.
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. 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.
Other things that need help:
- Translate it into a language that you know
- Pairing on documentation. If I explain it to you, its easier to figure how my code makes no sense
Please check out the developers-docs directory for more details on the application.
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