Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add xx network Haven #938

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions software/xx-network-haven.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: "Haven"
website_url: "https://xx.network"
source_code_url: "https://git.xx.network/elixxir/speakeasy-web/"
description: "Anonymous, distributed, mixnet-based text messaging chat app. Uses xx network's cMixx technology by Dr. David Chaum. Not to be confused with Haven the blogging system."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not understand what this does or how it works. The description should state this as plainly as possible.

https://xx.network
The First High-Speed Quantum Resistant Decentralized Mixnet with Blockchain.
Protect metadata for dApps, chains, and businesses with advanced quantum-resistant security.
Precomputation with cMixx delivers real-time calculations hundreds of times faster than other mixnets.

Yeah, this does not help...

https://git.xx.network/elixxir/speakeasy-web#getting-started
run the development server:

Are there installation instructions for production use?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I happen to have a User Guide and an Admin Guide.

UG:
https://armchairancap.github.io/docs/haven-user-guide/get-started

How it works for the user is just 2-3 steps - generate a cryptographic identity, back it up, and join a chat channel as per this animated GIF:
https://armchairancap.github.io/docs/haven-user-guide/get-started#for-the-impatient

AG:
https://armchairancap.github.io/docs/haven-admin-guide/get-started

Deployment can is just a docker run command, that's all. There's no data to backup, because it's stored on a decentralized network with 21d expiration time (similar to Signal if you set expiration to 21d).
There's a dedicated guide for containerized environments including home environments and exposing service on Tor, as well as reverse-proxying it with Caddy, Traefik:
https://github.com/armchairancap/xx-haven-container
But in essence it's just one docker run command and you can use it on localhost:3000 (traffic is encrypted on the client and sent out to decentralized storage nodes, the server just offers the app).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

  • The documentation/README then should link to this guide, Im not sure the npm run dev or dfx start docs there are relevant
  • I'm not sure the website_url link is relevant to the software at all, sure it is still related but different software
  • The description must be improved/clarified to indicate what this software actually does

licenses:
- BSD-2-Clause
platforms:
- Nodejs
tags:
- Communication - Custom Communication Systems
demo_url: "https://haven.xx.network"
Loading