Verified Commit 66023415 authored by Tom Zander's avatar Tom Zander

updates in docs etc

parent cc20f80b
Pipeline #54322973 passed with stages
in 30 minutes and 31 seconds
......@@ -37,7 +37,7 @@ Then clone the repo and use cmake to create the makefile
# More details
* http://www.flowee.org
* https://www.flowee.org
* https://gitlab.com/FloweeTheHub/thehub
# Social
......
FROM debian:stretch-slim
RUN groupadd -r flowee && useradd -r -m -d /etc/flowee -g flowee flowee && \
mkdir -pm 775 /etc/flowee/cookies && chown -R flowee:flowee /etc/flowee && \
mkdir -pm 775 /etc/flowee && chown -R flowee:flowee /etc/flowee && \
mkdir -pm 750 /data && chown -R flowee:flowee /data
ADD --chown=flowee:flowee conf /etc/flowee
ADD --chown=flowee:flowee bin /usr/bin
VOLUME ["/data", "/etc/flowee/cookies"]
USER flowee
CMD ["/usr/bin/hub"]
EXPOSE 8332 8334 18332 18333 1235
EXPOSE 8332 8334 18332 18333 1235 11235
LABEL maintainer="Tom Zander <tomz@freedommail.ch>"
......@@ -5,48 +5,44 @@ run, maintain and expand your service level is by marrying Flowee with
dockers.
Both in Flowee as well as in Docker there is a way of thinking where you
can start one unit (in this case the Hub) and it becomes easy to connect
this to other services or to make the Flowee the Hub be a service for your
application.
can start one unit (in most cases the Hub) and it becomes easy to connect
this to with services or to connect your application to them.
Starting it;
here I'll demonstrate how you can run Flowee the Hub as a single docker on
a local machine. Please refer to docker.com for more info if you want to
here I'll demonstrate how you can run Flowee the Hub as a single docker
your docker server. Please refer to docker.com for more info if you want to
do service-duplication, fail-over and other cloud-stack setups.
```
docker volume create cookies
docker volume create blockdata
docker run \
--name hubtest \
--mount source=cookies,target=/etc/flowee/cookies \
--mount source=blockdata,target=/data \
flowee/hub:master
```
What this does is the following;
You create two docker volumes. These store the data that you want to keep
between docker restarts and data you want to share with other dockers.
The `cookies` volume will contain the authentication cookies that other
dockers need to login and use the APIs of Flowee the Hub.
You create a docker volume. These store the data that you want to keep
between docker restarts and data you want to share with the main system.
The `blockdata` dir contains the block data. Please notice that this will
The `blockdata` source dir contains the block data. Please notice that this will
contain all historical data. Make sure you have some 200GB available for
it.
the "blockdata" dir will contain directories like `blocks`, which hold
the actual historical data (180GB or so) and a very important directory is
the `unspent` subdir that holds the UTXO database data (15GB or so).
For performance reasons it is highly recommended to put the `unspent` dir
on fast storage. Like an SSD. For instance by using `ln` to symlink it.
# Remote-control of Flowee the Hub
We ship the `hub-cli` application inside the docker. This means that you
can execute it in a running docker container quite simply. If your docker
isn't named 'hubtest'. Use `docker container ls` to get the ID.
can execute it in a running docker container quite simply. Replace the
example hubtest from the command below with your local docker name. You
can find that name using `docker container ls` to get the ID.
```
docker container exec hubtest hub-cli help
```
From your own docker application you should also mount the cookies volume
which is a required piece of info allowing usage of the API or the (legacy)
RPC interfaces.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment