Files
thehub/rest-service/data/setup.html
T
TomZ 67f0535607 Squashed commit of the following:
commit f1c09cbbdf228cefbfbd339567ba337083e93e52
Author: TomZ <tomz@freedommail.ch>
Date:   Wed Sep 2 13:56:38 2020 +0200

    Fix sorting in address/utxo call

commit c61b03b05de04c9d53c6fdf413dd1b6d33dc17f6
Author: TomZ <tomz@freedommail.ch>
Date:   Wed Sep 2 13:03:43 2020 +0200

    Also catch missing services for more complex searches

    We did catch it on 'start()' which may not actually use a service that
    was missing and only in a followup would the missing service be used.
    So also catch the exception for missing service on the other event
    handling methods.

    This means that we now show a nice "setup needed" message to client when
    a call is done that is not supported because of missing backing service.

commit fbcfe60c7d21b309e9c827dd927de0e196d7f5b6
Author: TomZ <tomz@freedommail.ch>
Date:   Tue Sep 1 16:03:19 2020 +0200

    Also use the complex UTXO lookup to do callbacks.

commit d948225ae7786aa6b62ff9355c2d768a85569642
Author: TomZ <tomz@freedommail.ch>
Date:   Tue Sep 1 15:47:48 2020 +0200

    Add address/utxo call.

commit cbc4695d4abae1404afe03f34b10427e48f819ae
Author: TomZ <tomz@freedommail.ch>
Date:   Tue Sep 1 14:34:31 2020 +0200

    Add address/details API call

    This mostly implements the API call to list an address.

commit 1d215032af09551e2b3eda314c072a200e5fb37a
Author: TomZ <tomz@freedommail.ch>
Date:   Tue Sep 1 14:30:26 2020 +0200

    Fix warnings

    This fixes warnings from the compiler and the linter.

commit b61e7dd42222537b456a79e14439a0d36007e8d7
Author: TomZ <tomz@freedommail.ch>
Date:   Tue Sep 1 14:27:27 2020 +0200

    Blockchain::Search: Clean a little and fix bugs

    This follows the API docs on the utxoLookup() callback and we indeed
    return back the blockheight/etc parameters even if the utxo is already
    spent (represented by unspent=false).

commit 7ec3ebf937d7f2fb6a7a18f21d2e8b645db6fe3e
Author: TomZ <tomz@freedommail.ch>
Date:   Mon Aug 31 12:24:18 2020 +0200

    Fixes and move to v2 url

commit 32b8018af805ce068da7d3e149add66a90c92264
Author: TomZ <tomz@freedommail.ch>
Date:   Mon Aug 31 11:29:35 2020 +0200

    Build the rest service

commit c386adff9d28a0f844916019602ea0032bbc360a
Author: TomZ <tomz@freedommail.ch>
Date:   Sun Aug 30 19:24:29 2020 +0200

    Cleanup old code and make vin work

commit 5b88457863892ff8391e42a7eff61cd243851b41
Author: TomZ <tomz@freedommail.ch>
Date:   Sun Aug 30 18:42:41 2020 +0200

    Output addresses.

commit 46c2ce680409c38f1a67730e23cde942db2ecc46
Author: TomZ <tomz@freedommail.ch>
Date:   Sun Aug 30 17:51:03 2020 +0200

    Make tx-refs easier for the Blockchain::Search

commit b0591b5a6b57e2eb7022db7b7a351c694220e5ad
Author: TomZ <tomz@freedommail.ch>
Date:   Fri Aug 28 18:28:48 2020 +0200

    Make printing of tx work better

commit d337ac91ad4ab9eeb768695c639dcbbbcc463837
Author: TomZ <tomz@freedommail.ch>
Date:   Fri Aug 28 15:46:04 2020 +0200

    Make rest service show a nice help for setup.

commit 5997ff1fa06bd1a6b51ead93eef094a5561fdb53
Author: TomZ <tomz@freedommail.ch>
Date:   Wed Aug 26 17:43:09 2020 +0200

    Parse the json automatically.

commit 5ed7d6e53761828e2e385e085f44d530449b0b3b
Author: TomZ <tomz@freedommail.ch>
Date:   Wed Aug 26 13:07:04 2020 +0200

    Start project rest-service.
2020-09-02 14:58:09 +02:00

88 lines
2.8 KiB
HTML

<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="utf-8">
<title>Flowee REST-service</title>
<meta property="og:description" content="REST service backed by Flowee"/>
</head>
<body>
<p>Your request could not be fulfilled due to a missing backing service.
This most likely means you are trying to setup your REST service and
you need a hand with configuration.</br>
The issue is listed here:</p>
<p><pre><b>%ERROR%</b></pre></p>
<b>Setup help</b>
<p>Config file location is following the XDG data specification, the easiest way to find out where your REST service finds its config files is starting the rest service and notifing an output like:</p>
<pre>
13:04:57 rest-service] No logs config found
.169 [9200] tried /home/user/.config/flowee/rest-service/logs.conf
.169 [9200] tried /etc/xdg/flowee/rest-service/logs.conf
</pre>
<p>These two log directories are searched when started as user 'user', your output may differ if you start the service differently.</p>
<p>Pick one of the default locations and create in that directory both a <b>logs.conf</b> as well as a <b>rest-service.conf</b> using the following templates:</p>
<p><b>logs.conf example</b></p>
<pre>
# Rest-service logging config.
# More docs at https://flowee.org/docs/hub/log-config/
# Enable this to (also) log to console. Useful if you want your logs to go to the journal.
channel console
# # linenumber / methodname / filename only work for developer-builds.
# option linenumber false
# option methodname true
# option filename true
# # timestamp-format. No argments means no timestamp, adding 'date' implies 'time'.
# option timestamp date time millisecond
#
# just mentioning 'channel file' will enable logging to file (to xdg data dir).
# channel file
# # all options available for console are available for file too.
#
# option timestamp time millisecond
# # The file to log to
# # if not specfied we go to the XDG dir (~/.local/share/flowee/rest-service/restservice.log)
# option path [path]
##### Log sections from Log::Sections and verbosity
# Lookup is 1) direct match. 2) group (n mod 1000) 3) default to 'warning'
# numbers come from file Logging.h, enum Log::Sections
9200 info
# silent only shows fatal
# quiet only shows critical and fatal
# info shows warning, info, critical and fatal
# debug shows everything.
</pre>
<p><b>rest-service.conf</b></p>
<pre>
[services]
# hostname and optional port of the indexer.
# A series of indexers can be given using a semicolon or whitespace as a separator
# examples:
#indexer=hostname
#indexer=localhost:1234 flowee.org
# same for hub.
#hub=hostname
[json]
# JSON rendering is by default set to be 'compact', this avoids all the
# spaces and saves bandwidth while enabled.
#compact=false
</pre>
</body>
</html>