2018-03-08 13:55:28 +01:00
Building From Source
2014-10-03 11:43:42 +02:00
====================
Replace Maven with Gradle in docs and scripts
This commit takes a pass through all documentation and scripts,
replacing any remaining `mvn` commands with their `gradle` equivalents,
replacing `target/*` paths with their `build/*` equivalents, and so on.
Note that the instruction to install Maven has been removed entirely
from documentation and scripts, as opposed to instructing users to
install Gradle, because with the Gradle wrapper (the `gradlew` script in
the root of this repository), it is unnecessary to install Gradle at
all. Users may still do this with, e.g. `brew install gradle` if they
like, but otherwise can get everything they need done with `./gradlew`
commands.
This commit also replaces lowercase 'bisq' with capitalized 'Bisq' where
appropriate in documentation.
Like the previous commit, this is a best-effort approach, and not all
scripts are perfectly up-to-date and tested. Indeed, many of the docs
and scripts we have now are essentially legacy documents and should
probably be scrapped or reworked completely.
2018-03-21 06:03:27 +01:00
This guide will walk you through the process of building Bisq from source.
2014-10-03 11:43:42 +02:00
Replace Maven with Gradle in docs and scripts
This commit takes a pass through all documentation and scripts,
replacing any remaining `mvn` commands with their `gradle` equivalents,
replacing `target/*` paths with their `build/*` equivalents, and so on.
Note that the instruction to install Maven has been removed entirely
from documentation and scripts, as opposed to instructing users to
install Gradle, because with the Gradle wrapper (the `gradlew` script in
the root of this repository), it is unnecessary to install Gradle at
all. Users may still do this with, e.g. `brew install gradle` if they
like, but otherwise can get everything they need done with `./gradlew`
commands.
This commit also replaces lowercase 'bisq' with capitalized 'Bisq' where
appropriate in documentation.
Like the previous commit, this is a best-effort approach, and not all
scripts are perfectly up-to-date and tested. Indeed, many of the docs
and scripts we have now are essentially legacy documents and should
probably be scrapped or reworked completely.
2018-03-21 06:03:27 +01:00
> _**NOTE:** For most users, building from source is not necessary. See the [releases page](https://github.com/bisq-network/bisq-desktop/releases), where you'll find installers for Windows, Linux and Mac OS X._
2014-10-03 11:43:42 +02:00
Replace Maven with Gradle in docs and scripts
This commit takes a pass through all documentation and scripts,
replacing any remaining `mvn` commands with their `gradle` equivalents,
replacing `target/*` paths with their `build/*` equivalents, and so on.
Note that the instruction to install Maven has been removed entirely
from documentation and scripts, as opposed to instructing users to
install Gradle, because with the Gradle wrapper (the `gradlew` script in
the root of this repository), it is unnecessary to install Gradle at
all. Users may still do this with, e.g. `brew install gradle` if they
like, but otherwise can get everything they need done with `./gradlew`
commands.
This commit also replaces lowercase 'bisq' with capitalized 'Bisq' where
appropriate in documentation.
Like the previous commit, this is a best-effort approach, and not all
scripts are perfectly up-to-date and tested. Indeed, many of the docs
and scripts we have now are essentially legacy documents and should
probably be scrapped or reworked completely.
2018-03-21 06:03:27 +01:00
There is an install script (2 parts) for setup (JDK, Git, Bitcoinj, Bisq) on Linux in that directory (install_on_unix.sh, install_on_unix_fin.sh).
2016-08-02 11:10:47 +02:00
2016-07-25 19:37:15 +02:00
System requirements
2014-10-03 11:43:42 +02:00
-------------
Replace Maven with Gradle in docs and scripts
This commit takes a pass through all documentation and scripts,
replacing any remaining `mvn` commands with their `gradle` equivalents,
replacing `target/*` paths with their `build/*` equivalents, and so on.
Note that the instruction to install Maven has been removed entirely
from documentation and scripts, as opposed to instructing users to
install Gradle, because with the Gradle wrapper (the `gradlew` script in
the root of this repository), it is unnecessary to install Gradle at
all. Users may still do this with, e.g. `brew install gradle` if they
like, but otherwise can get everything they need done with `./gradlew`
commands.
This commit also replaces lowercase 'bisq' with capitalized 'Bisq' where
appropriate in documentation.
Like the previous commit, this is a best-effort approach, and not all
scripts are perfectly up-to-date and tested. Indeed, many of the docs
and scripts we have now are essentially legacy documents and should
probably be scrapped or reworked completely.
2018-03-21 06:03:27 +01:00
The prerequisite for building Bisq is installing the Java Development Kit (JDK), version 8u131 or better (as well as Git).
2014-10-03 11:43:42 +02:00
Replace Maven with Gradle in docs and scripts
This commit takes a pass through all documentation and scripts,
replacing any remaining `mvn` commands with their `gradle` equivalents,
replacing `target/*` paths with their `build/*` equivalents, and so on.
Note that the instruction to install Maven has been removed entirely
from documentation and scripts, as opposed to instructing users to
install Gradle, because with the Gradle wrapper (the `gradlew` script in
the root of this repository), it is unnecessary to install Gradle at
all. Users may still do this with, e.g. `brew install gradle` if they
like, but otherwise can get everything they need done with `./gradlew`
commands.
This commit also replaces lowercase 'bisq' with capitalized 'Bisq' where
appropriate in documentation.
Like the previous commit, this is a best-effort approach, and not all
scripts are perfectly up-to-date and tested. Indeed, many of the docs
and scripts we have now are essentially legacy documents and should
probably be scrapped or reworked completely.
2018-03-21 06:03:27 +01:00
$ sudo apt-get install openjdk-8-jdk git
2017-11-04 17:42:27 +01:00
In Debian/Ubuntu with OpenJDK you'll need OpenJFX as well, i.e. you'll need the `openjfx` package besides the `openjdk-8-jdk` package.
$ sudo apt-get install openjfx
2017-02-09 22:09:05 -05:00
2016-07-25 19:37:15 +02:00
### 1. Check the version of Java you currently have installed
2014-10-03 11:43:42 +02:00
2016-07-25 19:37:15 +02:00
$ java -version
2014-10-03 11:43:42 +02:00
2017-02-07 18:46:11 -05:00
If `java` is not found, or your version is anything less than `1.8.0_121` , then follow the next steps, otherwise you can skip to step 2:
2014-10-03 11:43:42 +02:00
2016-07-25 19:37:15 +02:00
#### 1.1 Debian based systems (Ubuntu)
2016-06-25 11:29:07 +02:00
2016-10-06 03:50:32 +02:00
You can use either OpenJDK or Oracle JDK.
**To install OpenJDK use:**
2016-06-25 11:29:07 +02:00
Replace Maven with Gradle in docs and scripts
This commit takes a pass through all documentation and scripts,
replacing any remaining `mvn` commands with their `gradle` equivalents,
replacing `target/*` paths with their `build/*` equivalents, and so on.
Note that the instruction to install Maven has been removed entirely
from documentation and scripts, as opposed to instructing users to
install Gradle, because with the Gradle wrapper (the `gradlew` script in
the root of this repository), it is unnecessary to install Gradle at
all. Users may still do this with, e.g. `brew install gradle` if they
like, but otherwise can get everything they need done with `./gradlew`
commands.
This commit also replaces lowercase 'bisq' with capitalized 'Bisq' where
appropriate in documentation.
Like the previous commit, this is a best-effort approach, and not all
scripts are perfectly up-to-date and tested. Indeed, many of the docs
and scripts we have now are essentially legacy documents and should
probably be scrapped or reworked completely.
2018-03-21 06:03:27 +01:00
$ sudo apt-get install openjdk-8-jdk libopenjfx-java
2016-06-25 12:52:03 +02:00
2016-10-06 03:50:32 +02:00
Unfortunately, Ubuntu 14.04 & Linux Mint 17.3 are missing OpenJdk 8 and OpenJFX, so this might be useful:
If `openjdk-8-jdk` is not found you can add this ppa, update, then try again:
$ sudo apt-add-repository ppa:openjdk-r/ppa & & sudo apt-get install openjdk-8-jdk
If `libopenjfx-java` is not found you can build & install it yourself:
* [How to install OpenJFX on Ubuntu 14.04 or Linux Mint 17.3 ](http://askubuntu.com/questions/833193/how-do-i-install-openjfx-on-ubuntu-14-04-linux-mint-17 )
**To install the Oracle JDK use:**
2016-06-25 12:52:03 +02:00
$ sudo add-apt-repository ppa:webupd8team/java
$ sudo apt-get update
2016-08-02 11:10:47 +02:00
$ sudo apt-get -y install oracle-java8-installer
2016-07-25 19:37:15 +02:00
2016-10-06 03:50:32 +02:00
**Check if $JAVA_HOME is set:**
2016-06-25 12:52:03 +02:00
2016-07-25 19:37:15 +02:00
$ echo $JAVA_HOME
2016-06-25 12:52:03 +02:00
2016-10-06 03:50:32 +02:00
If `$JAVA_HOME` is not present, open your `.bashrc` file:
$ touch ~/.bashrc
$ gedit ~/.bashrc
2017-11-03 22:55:23 +01:00
* For OpenJDK add: `export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64`
* For Oracle JDK add: `export JAVA_HOME=/usr/lib/jvm/java-8-oracle`
2018-03-08 13:55:28 +01:00
* For your current *alternative* JDK add: `export JAVA_HOME=/usr/lib/jvm/default-java`
2017-11-03 22:55:23 +01:00
(or `/usr/lib/jvm/default` for Arch or `/usr/lib/jvm/java` for Fedora)
2016-10-06 03:50:32 +02:00
Save and close the file.
Reload the file in your shell:
$ . ~/.bashrc
$ echo $JAVA_HOME
2016-06-25 11:29:07 +02:00
2016-07-25 19:37:15 +02:00
#### 1.2 Other systems
2016-06-25 11:29:07 +02:00
2016-10-18 18:04:58 +02:00
[Download and install the latest Oracle JDK ](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html ) for your platform.
For Mac OSX, you will need to set JAVA_HOME as:
$ echo 'export JAVA_HOME=$(/usr/libexec/java_home)' >> ~/.bashrc
$ . ~/.bashrc
2014-10-03 11:43:42 +02:00
Replace Maven with Gradle in docs and scripts
This commit takes a pass through all documentation and scripts,
replacing any remaining `mvn` commands with their `gradle` equivalents,
replacing `target/*` paths with their `build/*` equivalents, and so on.
Note that the instruction to install Maven has been removed entirely
from documentation and scripts, as opposed to instructing users to
install Gradle, because with the Gradle wrapper (the `gradlew` script in
the root of this repository), it is unnecessary to install Gradle at
all. Users may still do this with, e.g. `brew install gradle` if they
like, but otherwise can get everything they need done with `./gradlew`
commands.
This commit also replaces lowercase 'bisq' with capitalized 'Bisq' where
appropriate in documentation.
Like the previous commit, this is a best-effort approach, and not all
scripts are perfectly up-to-date and tested. Indeed, many of the docs
and scripts we have now are essentially legacy documents and should
probably be scrapped or reworked completely.
2018-03-21 06:03:27 +01:00
### If using Intellij install the Lombok plugin
2017-07-25 15:47:39 +02:00
https://plugins.jetbrains.com/plugin/6317-lombok-plugin
Replace Maven with Gradle in docs and scripts
This commit takes a pass through all documentation and scripts,
replacing any remaining `mvn` commands with their `gradle` equivalents,
replacing `target/*` paths with their `build/*` equivalents, and so on.
Note that the instruction to install Maven has been removed entirely
from documentation and scripts, as opposed to instructing users to
install Gradle, because with the Gradle wrapper (the `gradlew` script in
the root of this repository), it is unnecessary to install Gradle at
all. Users may still do this with, e.g. `brew install gradle` if they
like, but otherwise can get everything they need done with `./gradlew`
commands.
This commit also replaces lowercase 'bisq' with capitalized 'Bisq' where
appropriate in documentation.
Like the previous commit, this is a best-effort approach, and not all
scripts are perfectly up-to-date and tested. Indeed, many of the docs
and scripts we have now are essentially legacy documents and should
probably be scrapped or reworked completely.
2018-03-21 06:03:27 +01:00
Build Bisq
2016-07-25 19:37:15 +02:00
-----------------
Replace Maven with Gradle in docs and scripts
This commit takes a pass through all documentation and scripts,
replacing any remaining `mvn` commands with their `gradle` equivalents,
replacing `target/*` paths with their `build/*` equivalents, and so on.
Note that the instruction to install Maven has been removed entirely
from documentation and scripts, as opposed to instructing users to
install Gradle, because with the Gradle wrapper (the `gradlew` script in
the root of this repository), it is unnecessary to install Gradle at
all. Users may still do this with, e.g. `brew install gradle` if they
like, but otherwise can get everything they need done with `./gradlew`
commands.
This commit also replaces lowercase 'bisq' with capitalized 'Bisq' where
appropriate in documentation.
Like the previous commit, this is a best-effort approach, and not all
scripts are perfectly up-to-date and tested. Indeed, many of the docs
and scripts we have now are essentially legacy documents and should
probably be scrapped or reworked completely.
2018-03-21 06:03:27 +01:00
$ git clone https://github.com/bisq-network/bisq-desktop.git
$ cd bisq-desktop
$ ./gradlew build
2016-10-06 03:50:32 +02:00
2018-03-22 02:41:25 +01:00
When the build completes, run Bisq with the following script:
2014-10-03 11:43:42 +02:00
2018-03-22 02:41:25 +01:00
$ ./build/app/bin/bisq-desktop
2016-07-25 19:37:15 +02:00
Build binaries
-----------------
2017-07-16 15:24:40 +02:00
If you want to build the binaries check out the build scripts under the package directory. Use the shaded.jar and the lib directory.
2016-07-25 19:37:15 +02:00
2017-06-27 01:29:51 +02:00
DAO full node
-----------------
2017-10-25 14:18:26 -05:00
If you want to run your own BSQ transaction verification node you have to run Bitcoin Core with RPC enabled and
2018-05-07 22:23:00 +03:00
use dedicated program arguments for the Bisq node.
Replace Maven with Gradle in docs and scripts
This commit takes a pass through all documentation and scripts,
replacing any remaining `mvn` commands with their `gradle` equivalents,
replacing `target/*` paths with their `build/*` equivalents, and so on.
Note that the instruction to install Maven has been removed entirely
from documentation and scripts, as opposed to instructing users to
install Gradle, because with the Gradle wrapper (the `gradlew` script in
the root of this repository), it is unnecessary to install Gradle at
all. Users may still do this with, e.g. `brew install gradle` if they
like, but otherwise can get everything they need done with `./gradlew`
commands.
This commit also replaces lowercase 'bisq' with capitalized 'Bisq' where
appropriate in documentation.
Like the previous commit, this is a best-effort approach, and not all
scripts are perfectly up-to-date and tested. Indeed, many of the docs
and scripts we have now are essentially legacy documents and should
probably be scrapped or reworked completely.
2018-03-21 06:03:27 +01:00
See https://github.com/bisq-network/bisq-desktop/blob/master/doc/rpc.md for more details.
2017-06-27 01:29:51 +02:00
2016-07-25 19:37:15 +02:00
Development mode
-----------------
2016-10-06 03:50:32 +02:00
Replace Maven with Gradle in docs and scripts
This commit takes a pass through all documentation and scripts,
replacing any remaining `mvn` commands with their `gradle` equivalents,
replacing `target/*` paths with their `build/*` equivalents, and so on.
Note that the instruction to install Maven has been removed entirely
from documentation and scripts, as opposed to instructing users to
install Gradle, because with the Gradle wrapper (the `gradlew` script in
the root of this repository), it is unnecessary to install Gradle at
all. Users may still do this with, e.g. `brew install gradle` if they
like, but otherwise can get everything they need done with `./gradlew`
commands.
This commit also replaces lowercase 'bisq' with capitalized 'Bisq' where
appropriate in documentation.
Like the previous commit, this is a best-effort approach, and not all
scripts are perfectly up-to-date and tested. Indeed, many of the docs
and scripts we have now are essentially legacy documents and should
probably be scrapped or reworked completely.
2018-03-21 06:03:27 +01:00
Please check out our wiki for more information about [testing ](https://github.com/bisq-network/bisq-desktop/wiki/4.3.-Testing-Bisq-with-Testnet )
and how to use [regtest ](https://github.com/bisq-network/bisq-desktop/wiki/4.2.1.-How-to-use-bisq-with-regtest-%28advanced%29 )
2014-10-03 11:43:42 +02:00
2016-10-06 03:50:32 +02:00
Here are example program arguments for using regtest with localhost environment (not using Tor):
2018-03-22 02:41:25 +01:00
$ bisq-desktop --baseCurrencyNetwork=BTC_REGTEST --useLocalhost=true --myAddress=localhost:2222 --nodePort=2222 --appName=bisq-Local-Regtest-Arbitrator
2016-10-06 03:50:32 +02:00
2018-03-22 02:41:25 +01:00
$ bisq-desktop --baseCurrencyNetwork=BTC_REGTEST --useLocalhost=true --myAddress=localhost:3333 --nodePort=3333 --appName=bisq-Local-Regtest-Alice
2016-10-06 03:50:32 +02:00
2018-03-22 02:41:25 +01:00
$ bisq-desktop --baseCurrencyNetwork=BTC_REGTEST --useLocalhost=true --myAddress=localhost:4444 --nodePort=4444 --appName=bisq-Local-Regtest-Bob
2016-10-06 03:50:32 +02:00
2016-07-25 19:37:15 +02:00
Running local seed node with Tor and RegTest
-----------------
2015-12-20 15:39:39 +01:00
2018-03-08 13:55:28 +01:00
See the documentation at https://github.com/bisq-network/bisq-seednode
2016-10-06 03:50:32 +02:00
2014-10-03 11:43:42 +02:00
Problems?
---------
Replace Maven with Gradle in docs and scripts
This commit takes a pass through all documentation and scripts,
replacing any remaining `mvn` commands with their `gradle` equivalents,
replacing `target/*` paths with their `build/*` equivalents, and so on.
Note that the instruction to install Maven has been removed entirely
from documentation and scripts, as opposed to instructing users to
install Gradle, because with the Gradle wrapper (the `gradlew` script in
the root of this repository), it is unnecessary to install Gradle at
all. Users may still do this with, e.g. `brew install gradle` if they
like, but otherwise can get everything they need done with `./gradlew`
commands.
This commit also replaces lowercase 'bisq' with capitalized 'Bisq' where
appropriate in documentation.
Like the previous commit, this is a best-effort approach, and not all
scripts are perfectly up-to-date and tested. Indeed, many of the docs
and scripts we have now are essentially legacy documents and should
probably be scrapped or reworked completely.
2018-03-21 06:03:27 +01:00
If the instructions above don't work for you, please [raise an issue ](https://github.com/bisq-network/bisq-desktop/issues/new?labels=%5Bbuild%5D ). Thanks!