# Netrix: Decentralized Enterprise Collaboration Platform
> This project is forked from [Robrix](https://github.com/project-robius/robrix), a Matrix client built with Rust and [Makepad](https://github.com/makepad/makepad/).
## Vision
Netrix aims to become a **decentralized enterprise collaboration tool** built on the [Matrix](https://matrix.org/) open protocol. Our goals are:
- **Decentralized Architecture** - Enterprises can self-host servers and maintain full data sovereignty
- **End-to-End Encryption** - Ensuring security and privacy for enterprise communications
- **Cross-Platform Support** - Available on Windows, macOS, Linux, Android, iOS and more
- **Open Interoperability** - Based on Matrix protocol, compatible with other Matrix clients
- **Enterprise Features** - Gradually adding features tailored for enterprise collaboration
## Acknowledgments
This project is based on [Robrix](https://github.com/project-robius/robrix). Thanks to the [Project Robius](https://github.com/project-robius) team for their excellent work.
---
The following table shows which host systems can currently be used to build Robrix for which target platforms.
| macOS | macOS | ✅ | ✅ |
| Linux | Linux | ✅ | ✅ |
| Windows | Windows | ✅ | ✅ |
| Android | *Any* | ✅ | ✅ |
| iOS | macOS | ✅ | ✅ |
| OpenHarmony | *Any* | ✅ | 🚧 |
## Known issues
- Drag-n-drop on Linux isn't implemented by Makepad, so you cannot drag room tabs around yet. (see: https://github.com/makepad/makepad/issues/650)
- Matrix-specific links (`https://matrix.to/...`) aren't fully handled in-app yet.
- Ignoring/unignoring a user clears all timelines (see: https://github.com/matrix-org/matrix-rust-sdk/issues/1703); the timeline will be re-filled gradually via back pagination, but the viewport position is not maintained.
- Currently, accessing system geolocation on Android may not succeed due to failing to prompt the user for permission. Please enable the location permission in the App Info settings page for Robrix, and then it should work as expected.
> [!IMPORTANT]
> Robrix only works with Matrix homeservers that support native Sliding Sync, just like other modern clients (e.g., Element X).
## Building & Running Robrix on Desktop
1. First, [install Rust](https://www.rust-lang.org/tools/install).
2. If you're building on **Linux** or **WSL** on Windows, install the required dependencies. Otherwise, proceed to step 3.
* `openssl`, `clang`/`libclang`, `binfmt`, `Xcursor`/`X11`, `asound`/`pulse`.
On a Debian-like Linux distro (e.g., Ubuntu), run the following:
```sh
sudo apt-get update
sudo apt-get install libssl-dev libsqlite3-dev pkg-config binfmt-support libxcursor-dev libx11-dev libasound2-dev libpulse-dev libwayland-dev libxkbcommon-dev
```
3. Then, build and run Robrix.
```sh
cargo run --release
```
## Building & Running Robrix on Mobile: Android, iOS, iPadOS
1. Install the `cargo-makepad` build tool:
```sh
cargo install --force --git https://github.com/makepad/makepad.git --branch dev cargo-makepad
```
### Android
2. Use `cargo-makepad` to install the Android toolchain:
```sh
cargo makepad android install-toolchain
```
3. Build and run Robrix using `cargo-makepad`:
```sh
cargo makepad android run -p robrix --release
```
* You'll need to connect a physical Android device with developer options enabled, or start up an emulator using Android Studio.
* API version 33 or higher is required, which is Android 13 and up.
### iOS / iPadOS
2. Use `cargo-makepad` to install the iOS toolchain:
```sh
rustup toolchain install nightly
cargo makepad apple ios install-toolchain
```
3. Perform the following one-time setup steps:
1. If running on a real iOS device, enable your iPhone's Developer Mode:
Settings → Privacy & Security → Developer Mode → turn on Developer Mode and reboot.
2. Ensure your Apple Developer account is properly set up on your Mac.
3. Create an empty "dummy" project in Xcode:
* File → New → Project to create a new "App"
* Set the Product Name as **`robrix`**. (used in the `--org` argument later)
* Set the Organization Identifier to a value of your choice, e.g., **`rs.robius`**. (used in the `--app` argument later)
* For Project Signing & Capabilities, select the proper Apple Developer team account.
4. In Xcode, Build/Run this project once to install and run the app on the simulator (or device).
5. Once the simulator or device has the empty "dummy" app installed and running properly, then you're ready to build the actual Robrix application below.
#### Running on an iOS simulator
4. If you're using an iOS simulator, do the following:
```sh
cargo makepad apple ios \
--org=rs.robius \
--app=robrix \
run-sim -p robrix --release
```
#### Running on a real iOS device
4. Run the following command to show all provisioning profiles, signing identities, and device identifiers on your Mac.
```sh
cargo makepad apple list
```
* You must select which values you need to use for each of the 3 above items.
* If you get an error from the above command, then please ensure you performed the full iOS setup instructions above, and that you have a valid Apple Developer account with certificates installed on your Mac.
2. Run the following command, filling in the **unique starting characters** chosen above.
```sh
cargo makepad apple ios \
--profile=<unique-starting-hex-string> \
--cert=<UNIQUE_STARTING_HEX_STRING> \
--device=<UNIQUE-STARTING-HEX-STRING> \
--org=rs.robius \
--app=robrix \
run-device -p robrix –release
```
# Feature status tracker
These are generally sorted in order of priority. If you're interested in helping out with anything here, please reach out via a GitHub issue or on our Robius matrix channel.
### Basic room views and fundamental actions
- [x] View list of joined rooms
- [x] View timeline of events in a single room
- [x] Fetch and display room avatars
- [x] Fetch user profiles (displayable names)
- [x] Cache user profiles and avatars
- [x] Cache fetched media on a per-room basis
- [x] Fetch and display user profile avatars
- [x] Backwards pagination to view a room's older history
- [x] Dynamic backwards pagination based on scroll position/movement: https://github.com/project-robius/robrix/issues/109
- [x] Loading animation while waiting for pagination request: https://github.com/project-robius/robrix/issues/109
- [x] Stable vertical position of events during timeline update
- [x] Display simple plaintext messages
- [x] Display image messages (PNG, JPEG)
- [x] HTML (rich text) formatting for message bodies
- [x] Display reactions (annotations)
- [x] Handle opening links on click
- [x] Linkify plaintext hyperlinks
- [x] Show reply previews above messages: https://github.com/project-robius/robrix/issues/82
- [x] Send standalone messages
- [x] Interactive reaction button, send reactions: https://github.com/project-robius/robrix/issues/115
- [x] Show reply button, send reply: https://github.com/project-robius/robrix/issues/83
- [x] Edit existing messages
- [x] E2EE device verification, decrypt message content: https://github.com/project-robius/robrix/issues/116
- [ ] Re-spawn timeline as focused on an old event after a full timeline clear: https://github.com/project-robius/robrix/issues/103
### Auxiliary features, login, registration, settings
- [x] Persistence of app session to disk: https://github.com/project-robius/robrix/issues/112
- [x] Username/password login screen: https://github.com/project-robius/robrix/issues/113
- [x] SSO, other 3rd-party auth providers login screen: https://github.com/project-robius/robrix/issues/114
- [x] Client logout, with server-side logout and app state reset: https://github.com/project-robius/robrix/pull/432
- [x] Side panel showing detailed user profile info (click on their Avatar)
- [x] Ignore and unignore users (see known issues)
- [x] Display read receipts besides messages: https://github.com/project-robius/robrix/pull/162
- [x] Mention users within a room (or the whole `@room`): https://github.com/project-robius/robrix/issues/452
- [x] Dedicated view of direct messages (DMs): https://github.com/project-robius/robrix/issues/139
- [x] Keyword filters for the list of all rooms: https://github.com/project-robius/robrix/issues/123
- [ ] Collapsible/expandable view of contiguous "small" events: https://github.com/project-robius/robrix/issues/118
- [ ] Display multimedia (audio/video/gif) message events: https://github.com/project-robius/robrix/issues/120
- [x] User settings screen
- [x] Dedicated view of spaces: https://github.com/project-robius/robrix/pull/636
- [x] Link previews beneath messages: https://github.com/project-robius/robrix/issues/81, https://github.com/project-robius/robrix/pull/585
- [ ] Search messages within a room: https://github.com/project-robius/robrix/issues/122
- [ ] Room browser, search for public rooms
- [x] Accept/reject room invites
- [x] Join room by accepting invite
- [x] Join room by searching for room alias, room ID, or via a Matrix link
- [x] Knock on room (request to join)
- [ ] Administrative abilities: ban, kick, etc
- [ ] Room creation/settings/info screen
- [ ] Room members pane
- [x] Offline mode with persistent event cache: https://github.com/project-robius/robrix/pull/445
## Packaging Robrix for Distribution on Desktop Platforms
> [!TIP]
> We already have [pre-built releases of Robrix](https://github.com/project-robius/robrix/releases) available for download.
1. Install `cargo-packager`:
```sh
rustup update stable cargo +stable install --force --locked cargo-packager
```
For posterity, these instructions have been tested on `cargo-packager` version 0.10.1, which requires Rust v1.79.
2. Install the `robius-packaging-commands` crate with the `makepad` feature enabled:
```sh
cargo install --locked --git https://github.com/project-robius/robius-packaging-commands.git
```
3. Then run the packaging command, which must build in release mode:
```sh
cargo packager --release ```
* If you want to hide the default cmd prompt console on Windows, use the following config:
```sh
RUSTFLAGS="--cfg hide_windows_console" cargo packager --release
```
### Platform-specific considerations
Note that due to platform restrictions, you can currently only build:
* Linux packages on a Linux OS machine
* Windows installer executables on a Windows OS machine
* macOS disk images / app bundles on a macOS machine
* iOS apps on a macOS machine.
* Android, on a machine with any OS!
There are some additional considerations when packaging Robrix for macOS:
> [!IMPORTANT]
> You will see a .dmg window pop up — please leave it alone, it will auto-close once the packaging procedure has completed.
> [!TIP]
> If you receive the following error:
>
> ```
> ERROR cargo_packager::cli: Error running create-dmg script: File exists (os error 17)
> ```
>
> then open Finder and unmount any Robrix-related disk images, then try the above `cargo packager` command again.
> [!TIP]
> If you receive an error like so:
>
> ```
> Creating disk image...
> hdiutil: create failed - Operation not permitted
> could not access /Volumes/Robrix/Robrix.app - Operation not permitted
> ```
>
> then you need to grant "App Management" permissions to the app in which you ran the `cargo packager` command, e.g., Terminal, Visual Studio Code, etc.
> To do this, open `System Preferences` → `Privacy & Security` → `App Management`,
> and then click the toggle switch next to the relevant app to enable that permission.
> Then, try the above `cargo packager` command again.
After the command completes, you should see both the `Robrix.app` and the `.dmg` in the `dist/` directory.
You can immediately double-click the `Robrix.app` bundle to run it, or you can double-click the `.dmg` file to
> Note that the `.dmg` is what should be distributed for installation on other machines, not the `.app`.
If you'd like to modify the .dmg background, here is the [Google Drawings file used to generate the MacOS .dmg background image](https://docs.google.com/drawings/d/10ALUgNV7v-4bRTIE5Wb2vNyXpl2Gj3YJcl7Q2AGpvDw/edit?usp=sharing).
## Credits
* X logo: https://www.vecteezy.com/png/42148611-new-twitter-x-logo-twitter-icon-x-social-media-icon (shobumiah)