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

Conversation

armchairancap
Copy link

Thanks for taking the time to suggest an addition to awesome-selfhosted!

To ensure your Pull Request is dealt with swiftly, please check the following (check the boxes [x]):

  • Submit one item per pull request. This eases reviewing and speeds up inclusion.
  • You have searched the repository for any relevant issues or PRs, including closed ones.
  • Any software you are adding is not already listed at any of awesome-sysadmin, staticgen.com, staticsitegenerators.net, dbdb.io.
  • The file you are adding is formatted as described in addition.md.
  • Demo links should only be used for interactive demos, i.e. not video demonstrations.
  • Comments and unused optional fields have been removed.
  • The file you are adding uses kebab-case file naming, for example my-awesome-software.yml.
  • Values for platform are the main server-side requirements for the software. Don't include frameworks or specific dialects.
  • Any software project you are adding to the list is actively maintained.
  • Any software project you are adding was first released more than 4 months ago.
  • Any software project you are adding has working installation instructions.
  • You understand that your Pull Request will be merged ~1 week after approval, to allow for further comments if needed.

Adds haven.xx.network.

Note: there's another Haven app already, so
- the description contains a disambiguation
- the file is prefixed with `xx-network-` because of file name conflict
- the branch is name prefixed as well
@nodiscc nodiscc added addition Adding new software to the list reviewers wanted Awaiting reviews labels Nov 5, 2024
Remove redundant `depends_3rdparty` line to accept the maintainer's suggestion

Co-authored-by: kokomo123 <[email protected]>
Copy link
Collaborator

@Ki-er Ki-er left a comment

Choose a reason for hiding this comment

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

Couple of changes

software/xx-network-haven.yml Outdated Show resolved Hide resolved
software/xx-network-haven.yml Outdated Show resolved Hide resolved
Copy link
Collaborator

@kokomo123 kokomo123 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for your contribution!

@armchairancap
Copy link
Author

Can another person review this, or can this be merged, perhaps?

If anyone thinks something still has to be improved, please let me know.

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

@nodiscc nodiscc self-requested a review January 24, 2025 06:11
Copy link
Member

@nodiscc nodiscc left a comment

Choose a reason for hiding this comment

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

See review above

@armchairancap
Copy link
Author

See review above

Makes sense.
If I add "What is Haven" to the intro page - https://armchairancap.github.io/docs/intro - and update the doco link to point to that URL (from there people can pick User Guide or Admin Guide), would that be better?

@nodiscc
Copy link
Member

nodiscc commented Jan 31, 2025

Whatever you prefer, the website_url link should point to a page that explains what the software is/does, and how to install it (or include a link to the installation docs). It can be the same URL as the source_code_url, in which case you just have to include this information in your README.md. Here is a good template.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addition Adding new software to the list reviewers wanted Awaiting reviews
Development

Successfully merging this pull request may close these issues.

4 participants