Add NENG/CHTA on SSL/WSS, dockerfile doc

INSTALL.md

@@ -0,0 +1,93 @@
+# How to Set up Electrumx Server with Docker Method
+
+Installation with docker method in linux server is the recommended method. This installation method requires your linux server either on x64 or arm64 hardware to have
+docker enabled. Below installation guide is based off runing electrumx server using Nengcoin and Cheetahcoin as example. The docker setup is quite general and would
+work for other coins supported by electrumx.
+
+Below electrumx server setup for 2 coins (nengcoin and cheetahcoin) are tested for ubuntu20.04 or ubuntu22.04 on x86_64 or arm64 hardware.
+
+
+## Run NENG or CHTA Full Node
+
+In the same linux server, you will need to run nengcoin and/or cheetahcoin full node.  Download latest version of NENG or CHTA core wallet, set up proper
+rpc username/password and rpc port in the "nengcoin.conf" and/or "cheetahcoin.conf" in their proper wallet folder, make sure the conf file has one line below to insure your full node contain all transactions:
+
+```
+txindex=1
+```
+
+Run full node and sync the full node to latest block height.
+
+Copy down the rpcuser/rpcpassword/rpcport information, they will be used in below electrumx server configuration.
+
+## Prepare electrumx folders
+
+We run electrumx folder at "/opt/electrumx" in host for mouting db and ssl folder from host to container. You can pick another path as your choice and
+change your container launch scripts volume mount point accordingly. 
+
+Ran below:
+```
+sudo mkdir -p /opt/electrumx/db-NENG
+sudo mkdir -p /opt/electrumx/db-CHTA
+sudo mkdir -p /opt/electrumx/ssl
+```
+The above commands created proper folders that will be used in docker run jobs
+
+## Obtain SSL certificate through Certbot/NGINX
+
+SSL or WSS URL connection method is recommended for current Komodo Wallet/Cheetahdex Wallet version and will be required for future versions while self created certificate files do not work for Komodo Wallet/Cheetahdex Wallet.  Here we obtain free letsencrypt certificate through certbot/NGINX.
+The below setup steps are largely based off komodo guide on this issue:  https://komodoplatform.com/en/docs/komodo/setup-electrumx-server/
+
+- Dependency - firewall/ port / certbot / nginx
+
+First of all, make sure to open up port 80 if your server is behind firewall because certbot ssl validation requires port 80 through nginx. You may also open up more ports 
+on 10001, 10002, 10003 used by Nengcoin TCP/SSL/WSS and ports 10007/10008/10009 used by Cheetahcoin TCP/SSL/WSS electrumx services.
+
+Perform installation of certbot uses snap and installation of nginx uses apt-get in ubuntu 20.04 or ubuntu 22.04:
+```
+  sudo apt install snapd
+  sudo apt install nginx-core
+```
+
+
+Ran below to obtain SSL certificate needed for electrum ssl/wss connection. 
+```
+sudo snap install core; sudo snap refresh core
+sudo apt-get remove certbot
+sudo snap install --classic certbot
+sudo ln -s /snap/bin/certbot /usr/bin/certbot
+sudo certbot --nginx
+```
+
+certbot/nginx above command will prompt you for desired subdomain or domain for certificates and will install live copy when process succeed. 
+```commandline
+cp /etc/letsencrypt/live/electrum2.mooo.com/fullchain.pem  /opt/electrumx/ssl/
+cp /etc/letsencrypt/live/electrum2.mooo.com/privkey.pem   /opt/electrumx/ssl/
+```
+
+The free letsencrypt certificate is valid for 3 months and you can renew once it expires.
+
+
+## Install docker
+
+In ubuntu or debian, you can run below to install docker in your linux machine:
+
+```
+ sudo apt-get update
+ sudo apt-get install -y docker.io
+```
+
+Check out online guide if your linux is openSUSE, fedora or arch based.
+
+
+## Install coin docker images, run docker job
+
+For Nengcoin,  checkout 'contrib/nengcoin' of this repos README guide, follow the guide step by step to install docker image, run a docker-run job, and trouble shoot
+job log information or other maintanence tasks if needed.
+
+For Cheetahcoin, checkout 'contrib/cheetahcoin' of this repos README guide, follow the guide step by step to install docker image, run a docker-run job, and trouble shoot
+job log information or other maintanence tasks if needed.
+
+Your can run 2 coins with docker jobs together in the same linux server. 
+
+The electrumx server should be running now allow Komodo Wallet/Cheetahdex Wallet, electrum-NENG or electrum-CHTA to connect to your server.

contrib/cheetahcoin/Dockerfile

@@ -0,0 +1,39 @@
+FROM ubuntu:22.04
+
+WORKDIR /
+
+RUN apt-get update && \
+        apt-get -y install python3-setuptools python3-multidict python3.10 python3.10-dev libleveldb-dev python3-setuptools python3-multidict gcc g++ libsnappy-dev zlib1g-dev libbz2-dev libgflags-dev build-essential python3-pip git
+
+RUN python3.10 -m pip install --upgrade pip
+RUN python3.10 -m pip install aiohttp pylru Cython uvloop quark_hash
+RUN python3.10 -m pip install plyvel
+RUN git clone https://github.com/ShorelineCrypto/electrumx-1 /opt/electrumx
+
+ENV COIN=Cheetahcoin
+ENV DB_DIRECTORY=/db
+ENV DAEMON_URL="http://RPCUSER:RPCPASSWORD@IP:RPCPORT/"
+ENV SERVICES="tcp://:10007,rpc://0.0.0.0:8007,ssl://:10008,wss://:10009"
+ENV EVENT_LOOP_POLICY=uvloop
+ENV PEER_DISCOVERY=self
+ENV INITIAL_CONCURRENT=50
+ENV COST_SOFT_LIMIT=10000
+ENV COST_HARD_LIMIT=100000
+ENV BANDWIDTH_UNIT_COST=10000
+ENV SSL_CERTFILE=/ssl/fullchain.pem
+ENV SSL_KEYFILE=/ssl/privkey.pem
+ENV ALLOW_ROOT=true
+ENV MAX_SEND=10000000
+ENV CACHE_MB=2000
+
+VOLUME /db
+VOLUME /ssl
+
+RUN mkdir -p "$DB_DIRECTORY" && ulimit -n 1048576
+RUN mkdir -p /ssl
+
+WORKDIR  /opt/electrumx
+
+RUN python3.10 setup.py install
+CMD ["/usr/bin/python3.10", "/opt/electrumx/electrumx_server"]
+

contrib/cheetahcoin/README.md

@@ -0,0 +1,104 @@
+## Install electrumx docker image for Cheetahcoin on x86_64 (amd64) or arm64 (aarch64) GNU/linux: 
+
+Pull down a working docker image from docker hub:
+
+x64
+```
+  docker pull shorelinecrypto/electrumx-chta:amd64
+  docker tag shorelinecrypto/electrumx-chta:amd64 electrumx-chta:latest
+```
+arm64
+```
+  docker pull shorelinecrypto/electrumx-chta:arm64
+  docker tag shorelinecrypto/electrumx-chta:arm64 electrumx-chta:latest
+```
+Alternatively, build docker image from source:
+
+```
+  docker build -t electrumx-chta .
+```
+
+### Run electrumx Cheetahcoin server with docker
+
+Replace with your CHTA full node rpcuser/rpcpassword and your server hostname with below command, assuming the CHTA full node runs at rpcport=8546 :
+
+```
+  docker run -d --net=host -v /opt/electrumx/db-CHTA/:/db -v /opt/electrumx/ssl:/ssl -e DAEMON_URL="http://youruser:yourpass@127.0.0.1:8546" -e REPORT_SERVICES=tcp://yourhost:10007,ssl://yourhost:10008,wss://yourhost:10009 electrumx-chta
+```
+
+### Trouble shoot or check docker container status
+
+Your docker run electrumx server job should be running, run below to obtain image / container ID
+
+```
+  docker ps
+  docker container ls -la
+  docker images -a
+```
+
+In order to trouble shoot issues or check log information of electrumx job, run blow to get real time log information 
+
+```
+  docker logs CONTAINER_ID
+```
+
+## Shut down electrum Cheetahcoin docker server
+ for a proper clean shutdown, send TERM signal to the running container eg.: 
+
+```
+  docker kill --signal="TERM" CONTAINER_ID
+
+```
+
+## clean up and remove residual containers
+
+Stopped containers take up disk and memory resources, you may want to clean up and remove those dead containers to free up resources
+
+```
+  docker rm CONTAINER_ID
+```
+
+## electrumx server crash maintenance
+
+Electrumx server tend to crash from time to time after running smoothly for several weeks.  Using docker logs CONTAINER_ID method can find 
+crash error like this assuming your CONTAINER_ID is 'c39a7d4a07d7': 
+```
+  docker ps -a
+  docker logs c39a7d4a07d7
+
+--- skipped logs informations ---
+  struct.error: 'H' format requires 0 <= number <= 65535
+```
+
+The ROOT CAUSE of the crash is due to database overflow and can be fixed with below steps  :
+
+#### (1) delete the exited docker container
+```
+   docker ps -a
+   docker rm c39a7d4a07d7
+```
+
+#### (2) setup "test" container to do maintenance job
+```
+    docker run -it --name test  -v /opt/electrumx/db-CHTA/:/db   electrumx-chta  /bin/bash
+```
+
+This above command will enter docker container with root account.
+#### (3) do maintenance in "test" container
+
+Run below commands inside container root account in electrumx folder  /opt/electrumx
+
+```
+   python3.10 electrumx_compact_history
+   exit
+```
+
+The above python3.10 command should take a few minutes to complete and then exit container
+
+
+#### (4) Delete the containers and re-start electrumx-chta container job
+```
+   docker rm test
+```
+   go back to command step above under "Run electrumx Cheetahcoin server with docker"
+

contrib/cheetahcoin/electrumx_maintain.sh

@@ -0,0 +1,33 @@
+#! /bin/bash
+
+if (test $# != 1) 
+then
+ echo "electrum_maintain.sh  <electrumx-neng|electrumx-chta>" 
+ exit
+fi
+
+
+image_name=$1
+
+
+##obtain exited images
+
+container_id=`docker ps --filter "status=exited"  | grep ${image_name} | cut -f1 -d' '`
+
+if ( test -z ${container_id} )
+then
+  echo "electrumx server running" >  /dev/null
+elif [[ $image_name == "electrumx-neng" ]]
+then
+  docker rm $container_id
+  docker run --rm  -v /opt/electrumx/db-NENG/:/db   ${image_name} python3.10 electrumx_compact_history
+  bash /root/docker_run_${image_name}.sh
+elif [[ $image_name == "electrumx-chta" ]]
+then
+  docker rm $container_id
+  docker run --rm  -v /opt/electrumx/db-CHTA/:/db   ${image_name} python3.10 electrumx_compact_history
+  bash /root/docker_run_${image_name}.sh
+else
+  echo "wrong argument"
+fi
+

contrib/nengcoin/Dockerfile

@@ -0,0 +1,39 @@
+FROM ubuntu:22.04
+
+WORKDIR /
+
+RUN apt-get update && \
+        apt-get -y install python3-setuptools python3-multidict python3.10 python3.10-dev libleveldb-dev python3-setuptools python3-multidict gcc g++ libsnappy-dev zlib1g-dev libbz2-dev libgflags-dev build-essential python3-pip git
+
+RUN python3.10 -m pip install --upgrade pip
+RUN python3.10 -m pip install aiohttp pylru Cython uvloop quark_hash
+RUN python3.10 -m pip install plyvel
+RUN git clone https://github.com/ShorelineCrypto/electrumx-1 /opt/electrumx
+
+ENV COIN=Nengcoin
+ENV DB_DIRECTORY=/db
+ENV DAEMON_URL="http://RPCUSER:RPCPASSWORD@IP:RPCPORT/"
+ENV SERVICES="tcp://:10001,rpc://0.0.0.0:8001,ssl://:10002,wss://:10003"
+ENV EVENT_LOOP_POLICY=uvloop
+ENV PEER_DISCOVERY=self
+ENV INITIAL_CONCURRENT=50
+ENV COST_SOFT_LIMIT=10000
+ENV COST_HARD_LIMIT=100000
+ENV BANDWIDTH_UNIT_COST=10000
+ENV SSL_CERTFILE=/ssl/fullchain.pem
+ENV SSL_KEYFILE=/ssl/privkey.pem
+ENV ALLOW_ROOT=true
+ENV MAX_SEND=10000000
+ENV CACHE_MB=2000
+
+VOLUME /db
+VOLUME /ssl
+
+RUN mkdir -p "$DB_DIRECTORY" && ulimit -n 1048576
+RUN mkdir -p /ssl
+
+WORKDIR  /opt/electrumx
+
+RUN python3.10 setup.py install
+CMD ["/usr/bin/python3.10", "/opt/electrumx/electrumx_server"]
+