bitcoin-s/docs/applications/server.md
Chris Stewart 7e6f489fee
2019 11 28 cli native image doc (#903)
* Add documentation about how the cli can be built with a native image

* Finish rest of documentation on building command line client for bitcoin-s

* Add missing akka actor on walletServer classpath, add plugins to be able to build the walletServer as a standalone jar

* Add server.md

* Rename walletServer -> appServer

* Address code review, add missing main class in server project

* Address code review
2019-12-04 07:25:03 -06:00

35 lines
No EOL
1.1 KiB
Markdown

id: server
title: bitcoin-s application server
---
### App server
The [server](../../app/server) project is the aggregation of these three sub projects
1. [Wallet](wallet.md)
2. [Chain](chain.md)
3. [Node](node.md)
The server project provides a away to access information from these three projects via a JSON RPC.
### Building the server
You can build the server with the [sbt native packager](https://github.com/sbt/sbt-native-packager).
The native packager offers [numerous ways to package the project](https://github.com/sbt/sbt-native-packager#examples).
In this example we are going to use `stage` which will produce bash scripts we can easily execute. You can stage the server with the following command
```bash
$ sbt appServer/universal:stage
```
This will produce a script to execute bitcoin-s which you can start with
```bash
$ ./app/server/target/universal/stage/bin/bitcoin-s-server
```
For more information on configuring the server please see our [configuration](configuration.md) document
For more information on how to use our built in `cli` to interact with the server please see [cli.md](cli.md)