Giter Club home page Giter Club logo

addon-wireguard-client's Introduction

Home Assistant Bigmoby Add-on: WireGuard Client

GitHub Release Project Stage License

Maintenance GitHub Activity

WireGuard: fast, modern, secure VPN tunnel.

About

WireGuard® is an extremely simple yet fast and modern VPN that utilizes state-of-the-art cryptography. It aims to be faster, simpler, leaner, and more useful than IPsec, while avoiding the massive headache.

It intends to be considerably more performant than OpenVPN. WireGuard is designed as a general-purpose VPN for running on embedded interfaces and supercomputers alike, fit for many different circumstances.

Initially released for the Linux kernel, it is now cross-platform (Windows, macOS, BSD, iOS, Android) and widely deployable, including via an Hass.io add-on!

WireGuard is currently under heavy development, but already it might be regarded as the most secure, easiest to use, and the simplest VPN solution in the industry.

Breaking Changes

  • New repository url

From version 0.1.0 will be dismissed the current repository and this will be the new repository url:

https://github.com/bigmoby/hassio-repository-addon
  • Docker Hub pre-build add-on

Update migration process from version 0.0.3-SNAPSHOT to version 0.0.4-SNAPSHOT fails because of new Docker Hub pre-build support. SO YOU MUST REMOVE AND INSTALL THE NEW ADD-ON VERSION MANUALLY.

Known issues

  • error setting key 'net.ipv4.conf.all.src_valid_mark'

This add-on is not compatible with a catch-all value for allowed_ips, like 0.0.0.0/0. If you encounter this error

  [#] sysctl -q net.ipv4.conf.all.src_valid_mark=1
  sysctl: error setting key 'net.ipv4.conf.all.src_valid_mark': Read-only file system

it's because you are trying to give access from every ip in the planet. Simply use single ips or ip classes that need to be connected. If you don't own a static ip address you can consider a VPN.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We have set up a separate document containing our contribution guidelines.

Thank you for being involved! 😍

Sponsor

Please, if You want support this kind of projects:

Buy Me A Coffee

Many Thanks,

Fabio Mauro

Authors & contributors

Fabio Mauro Bigmoby

Project forked from Wireguard add-on.

For a full list of all authors and contributors, check the contributor's page.

License

MIT License

Copyright (c) 2020-2024 Fabio Mauro

Copyright (c) 2019-2020 Franck Nijhof

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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.