Giter Site home page Giter Site logo

plexus's Introduction

Plexus

tests Go Report Card Go Reference

Plexus provides tools to easily manage private wireguard networks.

Overview

This repository provides the code for plexus-server and plexus-agent. Plexus-server serves the web ui and controls communications with plexus agents for peer and network updates. Plexus-agent runs as a daemon to communicate with the plexus server for peer and network updates. It also provided a cli to register and leave servers and to join/leave networks.

Quick Start

Server

  • Requirements
    • linux VPS with minimum 1CPU/1GB memory (eg. $6 DigitalOcean droplet)
    • DNS record pointing to the IP of your server
    • systemd
    • tcp ports 443 and 4222 -- for server
    • udp ports 51820 -- for agent: additional ports are needed for each network
  • Download install script
  • make script executable (chmod +x install-server.sh)
  • run script (as root)
    • script will ask for
      • FQDN of server
      • email to use with Let's Encrypt
      • name/password for web ui admin user
    • script will install and start plexus-server and plexus-agent daemons
  • log into server web ui
  • create registration key via web ui
  • create network via web ui
  • register agent(s) with server vi agent cli
  • join peer to network : can use server web ui or agent cli

Agent

  • Requirements
    • Linux host with systemd
  • Download install script
  • make script executable (chmod +x install-server.sh)
  • run script (as root)
    • script will install and start plexus-agent daemon
  • copy registration key from server
  • register with server and join network
    plexus-agent register <registraton key>
    plexus-agent join <network name>

Tech Stack

Docs

Legal

WireGuard and the WireGuard logo are registered trademarks of Jason A. Donenfeld.

Support

Please use Issues or Discussions for support requests

coffee

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.