Reflection

Collaboratively take meeting notes, even when there's no internet

Caution

The project is under active development and not considered stable yet. It probably won't eat your data, but no guarantees :)

Installation

You can get the Reflection preview release from Flathub Beta now.

Add the Flatpak Beta remote on your system:

flatpak remote-add --if-not-exists flathub-beta https://flathub.org/beta-repo/flathub-beta.flatpakrepo

Install the app:

flatpak install flathub-beta cx.modal.Reflection

When filing bugs it may be helpful run the app with logging enabled so you can include logs in your issue report:

RUST_LOG=p2panda_net_next=DEBUG,iroh=WARN flatpak run cx.modal.Reflection

Development

Getting Started

The GNOME Builder IDE is required to build and run the project. It can be installed with flatpak.

1. Install flatpak for your distribution.
2. Install Builder for GNOME: flatpak install flathub org.gnome.Builder
3. Clone the reflection repo: git clone git@github.com:p2panda/reflection.git && cd reflection
4. Open the Builder application and navigate to the reflection repo.
   • You may be prompted to install or update the SDK in Builder.
5. Run the project with Shift+Ctrl+Space or click the ► icon (top-middle of the Builder application).

Multiple Instances

If you need multiple instances of the app on the same computer for testing, open a "runtime terminal" in Builder and then run as many instances as you need, like so:

# Launch three independent reflection instances
reflection & dbus-run-session reflection & dbus-run-session reflection

Make sure you've compiled the reflection binary already once (step 5. in "Getting Started"), to be able to execute the program in the "runtime terminal".

Diagnostics

Set the RUST_LOG environment variable to your verbosity setting and filter to enable log-based diagnostics with tracing. Example: RUST_LOG=DEBUG or RUST_LOG=p2panda_net_next=INFO etc.

Use the "runtime terminal" in Builder and set the environment variable like that:

# Launch reflection with logging enabled, set to verbosity level "warn"
RUST_LOG=WARN reflection

# Launch two instances with logging. We can set the environment variable for
# the current runtime, all instances will have logging enabled
RUST_LOG=p2panda_net_next=DEBUG,iroh=WARN
reflection & dbus-run-session reflection

Make sure you've compiled the reflection binary already once (step 5. in "Getting Started"), to be able to execute the program in the "runtime terminal".

License

GNU General Public License v3.0

Supported By

Thanks to NLnet (via NGI0 ENTRUST) under grant agreement No 101069594, the Prototype Fund, and the Federal Ministry of Research, Technology and Space for funding this project.