Skip to content

Commit 80f4a8d

Browse files
committed
Update readme
1 parent cd4c265 commit 80f4a8d

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
11
# Zero-Knowledge Treasury on Top of [ERGO](https://ergoplatform.org/en/)
22
Server-side app for ZK Treasury implemented on top of ERGO's Distributed Signatures.
3+
## Configuration
4+
If you'd like to disable public team creation, then set the teamCreation config in the config file to false.
5+
You can find a sample config file [here](conf/application.conf).
6+
37
## Running the code
48
### Development mode
59
To run the code in development run `sbt "run 9000"` in the main directory to start the server. Load the UI in http://localhost:9000.
610
replace 9000 with your desired port.
7-
### TODO run in production and binaries
11+
### Jar file
12+
You can download the client's jar file [here](https://github.com/anon-real/DistributedSigsServer/releases). To run the client app:
13+
```bash
14+
java -jar ZKTreasury-client-{version}.jar
15+
# similarly if you want to provide config file:
16+
java -jar -Dconfig.file="path/to/your/config/file" ZKTreasury-client-{version}.jar
17+
18+
```
19+
If you want to run the client on different port also add `-Dhttp.port=8000` and replace 8000 with your desired port.
20+
821
## Docker Quick Start
922
TODO
23+

0 commit comments

Comments
 (0)