Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Bisq

Bisq is a JavaFX desktop application. This package runs it inside a browser-accessible Linux desktop (KasmVNC webtop), so the **Bisq Desktop** interface opens the full Bisq UI in your browser rather than a web app.

## Documentation

- [Bisq Wiki](https://bisq.wiki/) — the upstream documentation for trading, wallet management, and the Bisq protocol.

## What you get on StartOS

- A **Bisq Desktop** interface that streams the Bisq JavaFX application to your browser over KasmVNC.
- A single backed-up `main` volume that holds your Bisq wallet, trades, offers, and KasmVNC settings.
- The Bisq network profile is regenerated on every start so that Tor is handled at the StartOS network layer and peer discovery is left to Bisq's defaults.

## Getting set up

1. Install **Bitcoin Core** first if you have not already — Bisq requires a Bitcoin full node and will not start without it.
2. After install, StartOS posts a critical task **Set your admin password**. Run it and copy the generated `bisq` username and password to a password manager — you'll need them to log into the desktop.
3. Start the service and open the **Bisq Desktop** interface. Enter the `bisq` username and the password from step 2 at the KasmVNC login prompt.
4. Bisq's own first-run wizard appears in the desktop. Walk through it to create or restore a wallet. The first connection to the P2P trading network can take several minutes.

## Using Bisq

### Bisq Desktop

The **Bisq Desktop** interface is the full Bisq application rendered in your browser. Everything you would do on a native Bisq install — make and take offers, manage your wallet, participate in disputes, vote in the DAO — happens here. KasmVNC handles keyboard, mouse, and clipboard between your browser and the Bisq desktop.

### Actions

- **Set Admin Password** — generate a new random password for the KasmVNC login and display the credentials. Run this if you lose the password or want to rotate it.

## Limitations

- **x86_64 only.** Bisq does not ship official ARM builds.
- **The Bisq network profile is regenerated on every start.** Manual edits to `bisq.properties` inside the container do not persist; Tor-for-BTC is intentionally disabled because StartOS manages Tor at the network layer.
76 changes: 46 additions & 30 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"check": "tsc --noEmit"
},
"dependencies": {
"@start9labs/start-sdk": "1.3.3"
"@start9labs/start-sdk": "1.5.0"
},
"devDependencies": {
"@types/node": "^22.19.0",
Expand Down
1 change: 0 additions & 1 deletion startos/manifest/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ export const manifest = setupManifest({
upstreamRepo: 'https://github.com/bisq-network/bisq',
marketingUrl: 'https://bisq.network/',
donationUrl: 'https://bisq.network/contribute/',
docsUrls: ['https://bisq.wiki/'],
description: { short, long },
volumes: ['main'],
images: {
Expand Down
Loading