@@ -8,31 +8,13 @@ More documentation can be found [here](https://github.com/bisq-network/bisqremot
88
99## Building the Source Code
1010
11- ### Clone the Repository
12-
13- This repository has a dependency on git submodules [ bisq] ( https://github.com/bisq-network/bisq )
14- and [ bisq-gradle] ( https://github.com/bisq-network/bisq-gradle ) .
15- There are two ways to clone it before it can be built:
16-
17- 1 . Use the --recursive option in the clone command:
18-
19- ``` shell
20- git clone --recursive https://github.com/bisq-network/bisq-relay.git
21- ```
22-
23- 2 . Do a normal clone and pull down the bisq repo dependency with two git submodule commands:
24-
25- ``` shell
26- git clone https://github.com/bisq-network/bisq-relay.git
27- cd bisq-relay
28- git submodule init
29- git submodule update
30- ```
31-
3211### Build the Project
3312
13+ Build the project using installDist, which creates a local runnable distribution under build/install/
14+ and generates the startup script used to run the service.
15+
3416``` shell
35- ./gradlew clean build
17+ ./gradlew clean installDist
3618```
3719
3820## Running the Service
@@ -76,12 +58,12 @@ The service is configured via environment variables. The following variables are
7658
7759#### APNs Configuration
7860
79- | Environment Variable | Description | Default |
80- | ---------------------| -------------| ---------|
81- | ` BISQ_RELAY_APNS_BUNDLE_ID ` | iOS app bundle identifier (required) | _ (none)_ |
82- | ` BISQ_RELAY_APNS_CERTIFICATE_FILE ` | Path to .p12 certificate file (required) | _ (none)_ |
61+ | Environment Variable | Description | Default |
62+ | --------------------------------------------- | ---------------------------------------------- | - ---------|
63+ | ` BISQ_RELAY_APNS_BUNDLE_ID ` | iOS app bundle identifier (required) | _ (none)_ |
64+ | ` BISQ_RELAY_APNS_CERTIFICATE_FILE ` | Path to .p12 certificate file (required) | _ (none)_ |
8365| ` BISQ_RELAY_APNS_CERTIFICATE_PASSWORD_FILE ` | Path to certificate password file (required) | _ (none)_ |
84- | ` BISQ_RELAY_APNS_USE_SANDBOX ` | Use APNs sandbox environment | ` true ` |
66+ | ` BISQ_RELAY_APNS_USE_SANDBOX ` | Use APNs sandbox environment | ` true ` |
8567
8668> ** Note:** ` BISQ_RELAY_APNS_USE_SANDBOX ` defaults to ` true ` for safety. Production deployments must explicitly set this to ` false ` .
8769
@@ -96,7 +78,8 @@ The service is configured via environment variables. The following variables are
9678
9779### Run the Script
9880
99- After building the project, a ` bisq-relay ` script will be generated at the root of the project.
81+ After building the project using ` installDist ` , a script will be generated at
82+ [ build/install/bisq-relay/bin/bisq-relay] ( build/install/bisq-relay/bin/bisq-relay ) .
10083
10184#### Development/Sandbox Mode
10285
@@ -105,7 +88,7 @@ For development with APNs sandbox:
10588 export BISQ_RELAY_APNS_BUNDLE_ID=" your.app.bundle.id"
10689 export BISQ_RELAY_APNS_CERTIFICATE_FILE=apnsCertificate.p12
10790 export BISQ_RELAY_APNS_CERTIFICATE_PASSWORD_FILE=apnsCertificatePassword.txt
108- ./bisq-relay
91+ ./build/install/bisq-relay/bin/ bisq-relay
10992```
11093
11194#### Production Mode
@@ -116,7 +99,7 @@ For production deployment:
11699 export BISQ_RELAY_APNS_USE_SANDBOX=false
117100 export BISQ_RELAY_APNS_CERTIFICATE_FILE=/path/to/apnsCertificate.production.p12
118101 export BISQ_RELAY_APNS_CERTIFICATE_PASSWORD_FILE=/path/to/apnsCertificatePassword.txt
119- ./bisq-relay
102+ ./build/install/bisq-relay/bin/ bisq-relay
120103```
121104
122105#### With FCM Enabled
@@ -127,15 +110,15 @@ To also enable FCM (Android) push notifications:
127110 export BISQ_RELAY_APNS_USE_SANDBOX=false
128111 export BISQ_RELAY_FCM_ENABLED=true
129112 export BISQ_RELAY_FCM_FIREBASE_CONFIGURATION_FILE=/path/to/fcmServiceAccountKey.json
130- ./bisq-relay
113+ ./build/install/bisq-relay/bin/ bisq-relay
131114```
132115
133116#### Legacy Configuration (Deprecated)
134117
135118You can still use Java system properties if needed:
136119``` sh
137120 export BISQ_RELAY_OPTS=" -Dapns.bundleId=your.app.bundle.id -Dapns.useSandbox=false"
138- ./bisq-relay
121+ ./build/install/bisq-relay/bin/ bisq-relay
139122```
140123
141124## Deploying a Local Test Environment
0 commit comments