Git Product home page Git Product logo

boop-relay's Introduction

BOOP Server

Disclaimer: This project is the result of a personal coding excercise with the goal of improving my familiarity with the Tauri application framework. This means that I knowingly ignored best practices in software, protocol and interface design, and avoided safety guardrails, if necessary, to speed up the developement process. I don't intend on actively developing this system any further. However, if you want to contribute to this project, feel free to submit pull requests or open issues, I will try to reply to them as quickly as possible.

BOOP

This repository contains the server code for the BOOP server application. All hints for using the client application are in the respective repository (see above). This document will quickly explain how to host your very own BOOP server:

TL;DR

  1. Get a TLS certificate for your domain and save them in PEM format.
  2. Ask your friends / partners / colleagues for their desired username and a Argon2id hash of their desired password and save this data to a JSON file (the JSON schema is demonstrated in clients.json). The filename doesn't matter, the schema does.
  3. Run boop-relay <path to clients file, e.g. clients.json> <socket address, e.g. localhost:1234> -k <path to cert private key> -c <path to cert file>. All of these arguments are necessary, if you omit any, the application will exit immediately.

In Depth

TODO

boop-relay's People

Contributors

iyoshok avatar

Stargazers

vivu avatar  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.