Kaladaran/briar
0
0
Fork 0
mirror of https://code.briarproject.org/briar/briar.git synced 2026-02-17 21:29:54 +01:00
Code Issues Projects Releases Wiki Activity

Merge branch '2370-fix-readme-for-headless-jar' into 'master'

Browse Source 
Update instructions on how to build and run briar-headless

Closes #2370

See merge request briar/briar!1726
This commit is contained in:
akwizgran
2022-11-04 13:01:53 +00:00
parent 441b28fede ab6c925a9c
commit 9bbfea525a
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
briar-headless/README.md
View File

@@ -9,24 +9,25 @@ or to develop your own user interface for it.
The REST API peer comes as a `jar` file The REST API peer comes as a `jar` file
and needs a Java Runtime Environment (JRE) that supports at least Java 8. and needs a Java Runtime Environment (JRE) that supports at least Java 8.
It currently works only on GNU/Linux operating systems. It currently works only on GNU/Linux operating systems and on Windows.
To build the `jar` file, you need to specify the combination of architecture and platform: To build the `jar` file, you need to specify the combination of architecture and platform:
$ ./gradlew --configure-on-demand briar-headless:x86LinuxJar $ ./gradlew --configure-on-demand briar-headless:x86LinuxJar
$ ./gradlew --configure-on-demand briar-headless:aarch64LinuxJar $ ./gradlew --configure-on-demand briar-headless:aarch64LinuxJar
$ ./gradlew --configure-on-demand briar-headless:armhfLinuxJar $ ./gradlew --configure-on-demand briar-headless:armhfLinuxJar
$ ./gradlew --configure-on-demand briar-headless:windowsJar
You can start the peer (and its API server) like this: You can start the peer (and its API server) like this:
$ java -jar briar-headless/build/libs/briar-headless.jar $ java -jar briar-headless/build/libs/briar-headless-<platform>-<architecture>.jar
It is possible to put parameters at the end. It is possible to put parameters at the end.
Try `--help` for a list of options. Try `--help` for a list of options.
On the first start, it will ask you to create a user account: On the first start, it will ask you to create a user account:
$ java -jar briar-headless.jar $ java -jar briar-headless-linux-x86_64.jar
No account found. Let's create one! No account found. Let's create one!
Nickname: testuser Nickname: testuser