spacecruft
/
blockbook
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fixes

pull/50/head
Jakub Matys 2018-08-09 14:33:17 +02:00
parent ef12666f70
commit 5a0d0b2fe1
3 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -67,14 +67,6 @@ Execute script *contrib/scripts/generate-port-registry.go* that will update *doc
Now you can try generate package definitions as described above in order to check outputs.
##### Go template evaluation note
We use *text/template* package to generate package definitions and configuration files. Some options in coin definition
are also templates and are executed inside base template. Use `{{.path}}` syntax to refer values in coin definition,
where *.path* can be for example *.Blockbook.BlockChain.Parse*. Go uses CammelCase notation so references inside templates
as well. Note that dot at the beginning is mandatory. Go template syntax is fully documented
[here](https://godoc.org/text/template).
TODO:
* script that checks unique port numbers

10
docs/build.md
View File

@ -93,15 +93,17 @@ command: `make build-images NO_CACHE=true`.
### On naming conventions and versioning
All configuration keys described below are in coin definition file in *configs/coins*.
**install and data directories**
Both Blockbook and back-end have separated install and data directories. They use common preffix and are defined in
*configs/environ.json* and all templates use them.
Back-end install directory is */opt/coins/nodes/<coin>*.
Back-end data directory is */opt/coins/data/<coin>/backend*.
Blockbook install directory is */opt/coins/blockbook/<coin>*.
Blockbook data directory is */opt/coins/data/<coin>/blockbook*.
* back-end install directory is */opt/coins/nodes/<coin>*.
* back-end data directory is */opt/coins/data/<coin>/backend*.
* Blockbook install directory is */opt/coins/blockbook/<coin>*.
* Blockbook data directory is */opt/coins/data/<coin>/blockbook*.
*coin* used above is defined in *coin.alias* in coin definition file.

8
docs/config.md
View File

@ -95,3 +95,11 @@ Good examples of coin configuration are
* `package_maintainer` – Full name of package maintainer.
* `package_maintainer_email` – E-mail of package maintainer.
### Go template evaluation note
We use *text/template* package to generate package definitions and configuration files. Some options in coin definition
are also templates and are executed inside base template. Use `{{.path}}` syntax to refer values in coin definition,
where *.path* can be for example *.Blockbook.BlockChain.Parse*. Go uses CammelCase notation so references inside templates
as well. Note that dot at the beginning is mandatory. Go template syntax is fully documented
[here](https://godoc.org/text/template).