mirror of
https://github.com/bitcoin-s/bitcoin-s.git
synced 2024-11-19 09:52:09 +01:00
2021 02 19 dockerhub docs (#2693)
* Document docker images on website * Add docker hub information to README
This commit is contained in:
parent
392eb316f6
commit
b7030bb66a
12
README.md
12
README.md
@ -9,7 +9,7 @@ For a complete guide on how to get started with Bitcoin-S, see our website at
|
|||||||
|
|
||||||
### Getting started
|
### Getting started
|
||||||
|
|
||||||
https://bitcoin-s.org/docs/getting-setup
|
https://bitcoin-s.org/docs/getting-started
|
||||||
|
|
||||||
### Adding bitcoin-s to your library
|
### Adding bitcoin-s to your library
|
||||||
|
|
||||||
@ -45,3 +45,13 @@ libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-testkit" % "0.5.0"
|
|||||||
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-zmq" % "0.5.0"
|
libraryDependencies += "org.bitcoin-s" %% "bitcoin-s-zmq" % "0.5.0"
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Docker images
|
||||||
|
|
||||||
|
We publish docker images to docker hub on every PR merge and tag on github.
|
||||||
|
You can obtain the images for both the app server and oracle server on these
|
||||||
|
docker hub repos
|
||||||
|
|
||||||
|
[bitcoin-s docker hub repo](https://hub.docker.com/r/bitcoinscala/bitcoin-s-server/tags?page=1&ordering=last_updated)
|
||||||
|
|
||||||
|
[oracle-server docker hub repo](https://hub.docker.com/r/bitcoinscala/bitcoin-s-oracle-server/tags?page=1&ordering=last_updated)
|
||||||
|
@ -4,7 +4,7 @@ title: Application Server
|
|||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
### App server
|
## App server
|
||||||
|
|
||||||
The server project is the aggregation of these three sub projects
|
The server project is the aggregation of these three sub projects
|
||||||
|
|
||||||
@ -14,9 +14,9 @@ The server project is the aggregation of these three sub projects
|
|||||||
|
|
||||||
The server project provides a away to access information from these three projects via a JSON RPC.
|
The server project provides a away to access information from these three projects via a JSON RPC.
|
||||||
|
|
||||||
### Building the server
|
## Building the server
|
||||||
|
|
||||||
#### Java binary
|
### Java binary
|
||||||
You can build the server with the [sbt native packager](https://github.com/sbt/sbt-native-packager).
|
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).
|
The native packager offers [numerous ways to package the project](https://github.com/sbt/sbt-native-packager#examples).
|
||||||
|
|
||||||
@ -32,10 +32,17 @@ This will produce a script to execute bitcoin-s which you can start with
|
|||||||
./app/server/target/universal/stage/bin/bitcoin-s-server
|
./app/server/target/universal/stage/bin/bitcoin-s-server
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Docker
|
### Docker
|
||||||
|
|
||||||
The oracle server also has docker support. You can build a docker image with the following commands
|
The oracle server also has docker support. You can build a docker image with the following commands
|
||||||
|
|
||||||
|
#### Using an existing docker image
|
||||||
|
|
||||||
|
We publish docker images on every PR that is merged to bitcoin-s.
|
||||||
|
|
||||||
|
You can find the docker repo for the app server [here](https://hub.docker.com/r/bitcoinscala/bitcoin-s-server/tags?page=1&ordering=last_updated)
|
||||||
|
|
||||||
|
#### Building a docker image
|
||||||
```
|
```
|
||||||
sbt "appServer/docker:stage"
|
sbt "appServer/docker:stage"
|
||||||
```
|
```
|
||||||
@ -68,7 +75,7 @@ Here is an example with `bitcoin-s-cli`
|
|||||||
|
|
||||||
For more information on build configuration options with `sbt` please see the [sbt native packager docs](https://sbt-native-packager.readthedocs.io/en/latest/formats/docker.html#tasks)
|
For more information on build configuration options with `sbt` please see the [sbt native packager docs](https://sbt-native-packager.readthedocs.io/en/latest/formats/docker.html#tasks)
|
||||||
|
|
||||||
### Configuration
|
## Configuration
|
||||||
|
|
||||||
If you would like to pass in a custom datadir for your server, you can do
|
If you would like to pass in a custom datadir for your server, you can do
|
||||||
|
|
||||||
|
@ -19,35 +19,12 @@ have feedback on how to make your lives easier, please reach out on [slack](http
|
|||||||
|
|
||||||
Then go to [this document](getting-setup.md).
|
Then go to [this document](getting-setup.md).
|
||||||
|
|
||||||
## REPL
|
## Getting prebuilt artifacts
|
||||||
|
|
||||||
You can try out Bitcoin-S in a REPL in a matter of seconds. Run the provided
|
|
||||||
["try bitcoin-s"](https://github.com/bitcoin-s/bitcoin-s-core/blob/master/try-bitcoin-s.sh)
|
|
||||||
script, which has no dependencies other than an installed *Java 8*. The script
|
|
||||||
downloads and installs [Coursier](https://get-coursier.io/) and uses it to
|
|
||||||
fetch the [Ammonite](https://ammonite.io) REPL and the latest version of
|
|
||||||
Bitcoin-S. It then drops you into immediately into a REPL session.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ curl -s https://raw.githubusercontent.com/bitcoin-s/bitcoin-s/master/try-bitcoin-s.sh | bash
|
|
||||||
Loading...
|
|
||||||
Welcome the Bitcoin-S REPL, powered by Ammonite
|
|
||||||
Check out our documentation and examples at
|
|
||||||
https://bitcoin-s.org/docs/getting-started
|
|
||||||
@ val priv = ECPrivateKey()
|
|
||||||
@ val pub = priv.publicKey
|
|
||||||
@ val spk = P2WPKHWitnessSPKV0(pub)
|
|
||||||
@ val address = Bech32Address(spk, MainNet)
|
|
||||||
@ address.value # Tada! You've just made a Bech32 address
|
|
||||||
res4: String = "bc1q7ynsz7tamtnvlmts4snrl7e98jc9d8gqwsjsr5"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Getting prebuilt JARs
|
|
||||||
|
|
||||||
If you want to add Bitcoin-S to your project, follow the
|
If you want to add Bitcoin-S to your project, follow the
|
||||||
instructions for your build tool
|
instructions for your build tool
|
||||||
|
|
||||||
### sbt
|
### Jars
|
||||||
|
|
||||||
Add this to your `build.sbt`:
|
Add this to your `build.sbt`:
|
||||||
|
|
||||||
@ -102,9 +79,15 @@ The repo for snapshots, which are published after everytime something is merged
|
|||||||
|
|
||||||
https://oss.sonatype.org/content/repositories/snapshots/org/bitcoin-s/
|
https://oss.sonatype.org/content/repositories/snapshots/org/bitcoin-s/
|
||||||
|
|
||||||
### Mill
|
### Docker
|
||||||
|
|
||||||
TODO
|
We publish docker images to docker hub on every PR merge and tag on github.
|
||||||
|
You can obtain the images for both the app server and oracle server on these
|
||||||
|
docker hub repos
|
||||||
|
|
||||||
|
[bitcoin-s docker hub repo](https://hub.docker.com/r/bitcoinscala/bitcoin-s-server/tags?page=1&ordering=last_updated)
|
||||||
|
|
||||||
|
[oracle-server docker hub repo](https://hub.docker.com/r/bitcoinscala/bitcoin-s-oracle-server/tags?page=1&ordering=last_updated)
|
||||||
|
|
||||||
## Building JARs yourself
|
## Building JARs yourself
|
||||||
|
|
||||||
|
@ -66,7 +66,14 @@ sbt oracleServer/run
|
|||||||
|
|
||||||
### Docker
|
### Docker
|
||||||
|
|
||||||
The oracle server also has docker support. You can build a docker image with the following commands
|
#### Using an existing docker image
|
||||||
|
|
||||||
|
We publish docker images on every PR that is merged to bitcoin-s.
|
||||||
|
|
||||||
|
You can find the docker repo for the oracle server [here](https://hub.docker.com/r/bitcoinscala/bitcoin-s-oracle-server/tags?page=1&ordering=last_updated)
|
||||||
|
|
||||||
|
#### Building our own docker image
|
||||||
|
You can build a docker image with the following commands
|
||||||
|
|
||||||
```
|
```
|
||||||
sbt "oracleServer/docker:stage"
|
sbt "oracleServer/docker:stage"
|
||||||
@ -102,7 +109,6 @@ c9c9fe2772330b0d61a2efbfacabf5cab1137710a69f0e12f1eb3dbb74f7ea54
|
|||||||
|
|
||||||
For more information on build configuration options with `sbt` please see the [sbt native packager docs](https://sbt-native-packager.readthedocs.io/en/latest/formats/docker.html#tasks)
|
For more information on build configuration options with `sbt` please see the [sbt native packager docs](https://sbt-native-packager.readthedocs.io/en/latest/formats/docker.html#tasks)
|
||||||
|
|
||||||
|
|
||||||
## Step 4: Configuration
|
## Step 4: Configuration
|
||||||
|
|
||||||
### Java binary configuration
|
### Java binary configuration
|
||||||
|
Loading…
Reference in New Issue
Block a user