threefoldtech / info_grid

Apache License 2.0
1 stars 2 forks source link

document mycelium client OSX and Windows #618

Open xmonader opened 1 month ago

xmonader commented 1 month ago

check with @maximevanhees the goal is to document creating a vm with mycelium and using that mycelium client to be enable to connect to that machine

Mik-TF commented 1 month ago

There seems to be many ways to proceed. Here's a proposition:

Is this sufficient? Do we want two guides: micro and full VMs?

So

xmonader commented 1 month ago

There's a desktop application developed/in the process of being developed by @maximevanhees . That's what needs to be integrated in the manuals (not duplicating content for sure)

Mik-TF commented 1 month ago

OK good! Then Maxime can communicate when its ready to be shared/added to the manual, and if there are repos in particular with any docs to work with.

Mik-TF commented 1 month ago

Notes

For now, Mycelium is sufficiently covered only for Linux: https://manual.grid.tf/documentation/system_administrators/mycelium/mycelium_toc.html

Once we have the client for OSX and Windows, we can update the Mycelium section (shared in the link above) with OSX and Windows.

Mik-TF commented 1 month ago

@maximevanhees

What is the status+ETA of the OSX + Windows client +docs? Just to get a pulse of the situation and plan forward. Thanks!

maximevanhees commented 1 month ago

@Mik-TF @xmonader

At this moment there is a branch (mycelium-ui) that uses Dioxus, a Rust GUI library, to create a "frontend" for Mycelium where user can lookup and search routes and view which peers they are connected to. At this moment the codebase is only tested on Linux. I'll test how it behaves on MacOS and Windows today, but normally this shouldn't be an issue as Dioxus says it is designed to be cross-platform by default. Note that this UI doesn't include the Mycelium binary itself, and thus users are still required to manually start Mycelium beforehand.

On another note: I've already created a Windows installer for Mycelium (using WiX) but it does not automatically start up as a background service yet. The goal here is to provide a more user-friendly experience for less technical users that want to run Mycelium. On Windows, we could package the binary and the GUI together (which would both get installed at once with the installer) providing a working out-of-the-box experience.

@despiegk also asked me to take a look at Flet.dev, a Python wrapper around Flutter (with some extra features) which aims to simplify the process of building a simple frontend for (exisiting) applications. I'm in the process of porting the Dioxus application to a Flet app, but I doubt how reliable it will be to deploy a Python codebase cross-platform (Linux, MacOS, Windows and mobile). At this moment there are still a couple of issues getting it to work properly.

iwanbk commented 1 month ago

also asked me to take a look at Flet.dev, a Python wrapper around Flutter (with some extra features) which aims to simplify the process of building a simple frontend for (exisiting) applications

@maximevanhees why we need to wrap Flutter with python?

maximevanhees commented 1 month ago

@iwanbk I was just briefly mentioning what a Flet app is, nothing more 😊