Adds documentation for building the drop app client and some troubshooting steps for gnome/wayland users

This commit is contained in:
Francois Ribemont
2025-05-25 04:36:15 +01:00
parent 8bbe7d2c42
commit 3e33d45aed
2 changed files with 45 additions and 5 deletions
+38 -4
View File
@@ -1,8 +1,10 @@
# Building Drop server for other platforms
# Building Drop OSS
## Building Drop server for other platforms
Unfortunately, we don't have the time or resources to build and debug our software for platforms other than x86-64 or arm64. However, we offer this guide as a way to get it running, at your own risk.
## Prerequisites
### Prerequisites
To compile:
@@ -16,7 +18,7 @@ To run:
- Docker
## Building `droplet`
### Building `droplet`
`droplet` is a high-performance utility package for the Drop server. It's a `napi.rs` module, meaning it's written in Rust and then compiled to an NPM module.
@@ -44,7 +46,7 @@ Because we're building this locally, setup the yarn link so we can use this pack
yarn link
```
## Building `drop`
### Building `drop`
`drop` is the self hosted server. It's a Nuxt 3 project, but depends on the `droplet` package so isn't easily transportable.
@@ -77,3 +79,35 @@ To package it into a Docker container, remove the build commands in the provided
```shell
docker build . -t drop
```
## Building drop-app (desktop companion app)
To build drop-app, run:
```shell
git clone https://github.com/Drop-OSS/drop-app.git
cd drop-app
git checkout main
yarn
yarn tauri dev
```
If the command is successful, you can find the generated assets in: `src-tauri/target/release/bundle`. You can find the AppImage in the `appimage` folder.
If the `yarn tauri dev` command fails, you can try adding `--verbose` to get the error details.
If you get this type of error:
```
ERROR: Strip call failed: /tmp/appimage_extracted_5a27dadc81a3abf452534fdbee9c58ee/usr/bin/strip: Drop Desktop Client.AppDir/usr/lib/libSvtAv1Enc.so.3: unknown type [0x13] section `.relr.dyn'
/tmp/appimage_extracted_5a27dadc81a3abf452534fdbee9c58ee/usr/bin/strip: Unable to recognise the format of the input file `Drop Desktop Client.AppDir/usr/lib/libSvtAv1Enc.so.3'
```
Then you can run the following:
```shell
sudo ln -s /usr/lib/libavif.so.16 /usr/lib/libavif.so.15
NO_STRIP=true yarn tauri build
```
This is a known issue in [tauri](https://discord.com/channels/1291622805124812871/1375895784024969396/1376015429088313354).