diff --git a/api_auth_docker/README.md b/api_auth_docker/README.md index c5b86db..a5d9990 100644 --- a/api_auth_docker/README.md +++ b/api_auth_docker/README.md @@ -2,7 +2,27 @@ So all the other containers are in the Docker Swarm and we want to expose a real HTTP/S interface to clients outside of the Swarm, that makes sense. Clients have to get an API key first. -## Build +## Pull our Cyphernode image + +```shell +docker pull cyphernode/gatekeeper:cyphernode-0.05 +``` + +## Build yourself the image + +```shell +docker build -t cyphernode/gatekeeper:cyphernode-0.05 . +``` + +## Run image + +If you are using it independantly from the Docker stack (docker-compose.yml), you can run it like that: + +```shell +docker run -d --rm --name gatekeeper -p 80:80 -p 443:443 --network cyphernodenet -v "~/cyphernode-ssl/certs:/etc/ssl/certs" -v "~/cyphernode-ssl/private:/etc/ssl/private" --env-file env.properties cyphernode/gatekeeper:cyphernode-0.05 `id -u cyphernode`:`id -g cyphernode` +``` + +## Prepare ### Create your API key and put it in keys.properties diff --git a/cron_docker/README.md b/cron_docker/README.md index c5e56bb..a510d87 100644 --- a/cron_docker/README.md +++ b/cron_docker/README.md @@ -1,14 +1,28 @@ # Cyphernode CRON container +## Pull our Cyphernode image + +```shell +docker pull cyphernode/proxycron:cyphernode-0.05 +``` + +## Build yourself the image + +```shell +docker build -t cyphernode/proxycron:cyphernode-0.05 . +``` + +## Run image + +If you are using it independantly from the Docker stack (docker-compose.yml), you can run it like that: + +```shell +docker run --rm -d --network cyphernodenet --env-file env.properties cyphernode/proxycron:cyphernode-0.05 +``` + ## Configure your container by modifying `env.properties` file ```properties TX_CONF_URL=cyphernode:8888/executecallbacks OTS_URL=cyphernode:8888/ots_backoffice ``` - -## Building docker image - -```shell -docker build -t proxycronimg . -``` diff --git a/docker-compose.yml b/docker-compose.yml index 97f10fb..b46cbdc 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -53,7 +53,7 @@ services: # Pycoin env_file: - pycoin_docker/env.properties - image: pycoinimg + image: cyphernode/pycoin:cyphernode-0.05 # deploy: # placement: # constraints: [node.hostname==dev] diff --git a/otsclient_docker/README.md b/otsclient_docker/README.md index b45e20d..964a2ed 100644 --- a/otsclient_docker/README.md +++ b/otsclient_docker/README.md @@ -1,18 +1,34 @@ -# Build image +# OTS Client Cyphernode Container + +## Pull our Cyphernode image ```shell -docker build -t otsclientimg . +docker pull cyphernode/ots:cyphernode-0.05 ``` -# OTS files directory... +## Build yourself the image + +```shell +docker build -t cyphernode/ots:cyphernode-0.05 . +``` + +## OTS files directory... ```shell mkdir -p ~/otsfiles -sudo chown -R cyphernode:debian ~/otsfiles ; sudo chmod g+ws ~/otsfiles +sudo chown -R cyphernode:cyphernode ~/otsfiles ; sudo chmod g+ws ~/otsfiles sudo find ~/otsfiles -type d -exec chmod 2775 {} \; ; sudo find ~/otsfiles -type f -exec chmod g+rw {} \; ``` -# Usefull examples +## Run image + +If you are using it independantly from the Docker stack (docker-compose.yml), you can run it like that: + +```shell +docker run --rm -d -p 6666:6666 --network cyphernodenet --env-file env.properties cyphernode/ots:cyphernode-0.05 `id -u cyphernode`:`id -g cyphernode` ./startotsclient.sh +``` + +## Usefull examples ```shell curl http://localhost:6666/stamp/1ddfb769eb0b8876bc570e25580e6a53afcf973362ee1ee4b54a807da2e5eed7 diff --git a/proxy_docker/README.md b/proxy_docker/README.md index 98dea43..bf6fac3 100644 --- a/proxy_docker/README.md +++ b/proxy_docker/README.md @@ -1,6 +1,24 @@ # Cyphernode Proxy -We assume you are the user pi on a Raspberry Pi. +## Pull our Cyphernode image + +```shell +docker pull cyphernode/proxy:cyphernode-0.05 +``` + +## Build yourself the image + +```shell +docker build -t cyphernode/proxy:cyphernode-0.05 . +``` + +## Run image + +If you want to run this container independently from Cyphernode: + +```shell +docker run --rm -d -p 8888:8888 --network cyphernodenet --env-file env.properties cyphernode/proxy:cyphernode-0.05 `id -u cyphernode`:`id -g cyphernode` ./startproxy.sh +``` ## Configure your container by modifying `env.properties` file @@ -45,7 +63,7 @@ docker build -t btcproxyimg . ## Create sqlite3 database path and give rights ```shell -mkdir ~/btcproxydb ; sudo chown -R cyphernode:pi ~/btcproxydb ; sudo chmod g+ws ~/btcproxydb +mkdir ~/proxydb ; sudo chown -R cyphernode:cyphernode ~/proxydb ; sudo chmod g+ws ~/proxydb ``` ## What you MUST have in your Watching Bitcoin node's bitcoin.conf file diff --git a/pycoin_docker/README.md b/pycoin_docker/README.md index 5f00b5d..971aec3 100644 --- a/pycoin_docker/README.md +++ b/pycoin_docker/README.md @@ -1,10 +1,26 @@ -# Build image +# Pycoin container in Cyphernode + +## Pull our Cyphernode image ```shell -docker build -t pycoinimg . +docker pull cyphernode/pycoin:cyphernode-0.05 ``` -# Usefull examples +## Build yourself the image + +```shell +docker build -t cyphernode/pycoin:cyphernode-0.05 . +``` + +## Run image + +If you are using it independantly from the Docker stack (docker-compose.yml), you can run it like that: + +```shell +docker run --rm -d -p 7777:7777 --network cyphernodenet --env-file env.properties cyphernode/pycoin:cyphernode-0.05 `id -u cyphernode`:`id -g cyphernode` ./startpycoin.sh +``` + +## Usefull examples See https://github.com/shivaenigma/pycoin