bookbuddies

A project by the LBRY Foundation to allow you to seed relevant LBRY content, so the network becomes more decentralised!

Running

Download the correct binary for your system from here, and run it.

[!IMPORTANT] If you see an 'Illegal Instruction' error, this likely means your CPU does not support modern instructions. If this happens, you should use a slower but compatible baseline build from the Releases page.

Should I choose GUI or CLI?

The GUI (graphical user interface) version functions like a standard desktop app, with visual elements to click on with the mouse.

The CLI (command-line interface) version runs in the terminal.

The GUI is best if you're running bookbuddies on your personal computer, since it can run in the background easily. If you want to run it on a server instead, and you are familiar with applications in the console, the CLI may be a better choice.

Setup

You'll only need to do this if you're planning to build or contribute. If you want to run bookbuddies easily, you can download it from the latest release.

[!IMPORTANT] Make sure you have Git and Bun installed first.

1. Clone the repository.

   git clone https://github.com/lbryfoundation/bookbuddies.git

2. Switch to the newly made bookbuddies folder.

   cd bookbuddies

3. Install all dependencies.

   bun i

Building

Run the build command for the binary you want to make.

bun build:cli
bun build:gui

This will compile for the platform you are on. If you want to compile for a different platform, you can add a supported target.

Windows ARM devices are currently unsupported.

Contributing

Contributions, including non-code ones, are welcome! See more in the contributing file.

Security

If you spot a vulnerability, you can disclose it safely in accordance with the security file.