BitShares delegate tools
Project description
There are 2 tools currently provided:
command line util allowing to quickly build and run the bitshares client
web app allowing to monitor a running instance of the client and send an email or push notification on failure
If you like these tools, please vote for my delegate to support further development, and feel free to visit my page for other delegate proposals at digitalgaia.io. Thanks!
Command-line client
just run the bts script with the command you want to execute:
$ bts -h
usage: bts [-h] [-r]
{clean_homedir,clean,build,build_gui,run,run_gui,list,monitor}
[environment] [hash]
following commands are available:
- clean_homedir : clean home directory. WARNING: this will delete your wallet!
- clean : clean build directory
- build : update and build bts client
- build_gui : update and build bts gui client
- run : run latest compiled bts client, or the one with the given hash or tag
- run_gui : run latest compiled bts gui client
- list : list installed bitshares client binaries
- monitor : run the monitoring web app
Example:
$ bts build # build the latest bts client by default
$ bts run
$ bts run debug # run the client inside gdb
$ bts build dns v0.0.4 # build a specific version
$ bts run seed-dns # run environments are defined in the config.yaml file
$ bts build_gui
$ bts run_gui
positional arguments:
{clean_homedir,clean,build,build_gui,run,run_gui,list}
the command to run
environment the build/run environment (bts, dns, ...)
hash the hash or tag of the desired commit
optional arguments:
-h, --help show this help message and exit
-r, --norpc run binary with RPC server deactivated
You should also look into ~/.bts_tools/config.yaml to tune it to your liking.
Monitoring web app
To run the debug/development monitoring web app, just do the following:
$ bts monitor
and it will launch on localhost:5000.
For production deployments, it is recommended to put it behind a WSGI server, in which case the entry point is bts_tools.wsgi:application.
Do not forget to edit the ~/.bts_tools/config.yaml file to configure it to suit your needs.
Screenshots
Monitoring the status of your running bts client binary
Monitoring multiple instances at the same time, to have an overview while running backup nodes and re-compiling your main node.
Things to know (best practices and “issues”) READ IT !!!
to properly build the bitshares client in MacOSX:
you can (and should) build the binary with only homebrew libraries (boost, etc.). Previous versions had trouble compiling and could require you to hand-compile some dependencies, but newer homebrew libs should compile properly
readline needs to be installed by brew and you need to run brew link --force readline to take precedence over the outdated version of the system
when running the web client in uWSGI, make sure to:
set enable-threads = true, otherwise you won’t get the monitoring thread properly launched
set lazy-apps = true, otherwise the stats object will not get properly shared between the master process and the workers, and you won’t get any monitoring data
set workers = 1, otherwise you will get multiple instances of the worker thread active at the same time
