checkoutcrypto/site repository overview

#CheckoutCrypto's Drupal, Apache, Site

##Install There are two methods of install

1. Git
2. Docker

##Git install

###Prerequisite repositories:

• worker: https://github.com/CheckoutCrypto/worker.git⁠
• api: https://github.com/CheckoutCrypto/crypto-api⁠
• site: https://github.com/CheckoutCrypto/site.git⁠
• demo: https://github.com/CheckoutCrypto/checkoutcrypto-drupal.git⁠

###Git Procedure git clone site module, copy contents(modules, themes and .git folder) to a fresh drupal site root path at /var/www/yoursite/sites/all

cd /var/www/yoursite/sites/all && git submodule init && git submodule update

Login to your drupal site as administraitor, visit the admin->modules menu, enable all checkoutcrypto modules except:

####Enable

• Account, Admin, Balance, Coins, Groups, OTP, Wallets, Trading, Transactions, Worker

####Ignore / View and develop

• Hosting(under development), Send payment by email(under development), cgPopup (a ctools modal example module, created by me for developers), service payments.

#####Modifications for your API URL

You need to modify the ccAccount module's API connection⁠ (it's done automatically in docker build, not git).

$base_url = '';

to your own API host's IP address.

1. You need to add all coins to the ccdev_coins table. Add their rpc info to offline worker cache menu, afterwords(worker option 2).
2. You need to add a "default" type group to the ccdev_groups table.
3. You need to select a user for use as a "hot wallet", you need to get that userid from the users table, copy it to the api configuration (api/config/ccapiconfig.php, within api repository).

Thorough, site documentation, found in ./modules/CheckoutCrypto/docs/ccDocs.pdf

##Docker install ###Required Docker Containers

• CheckoutCrypto API⁠
• CheckoutCrypto Worker Dart ⁠ Qt⁠

###Required DB Containers Run MySQL daemon container with mysql-server (exposed port 3306)

docker run --name mysql -e MYSQL_ROOT_PASSWORD=somepass -d mysql

Run PHPMyAdmin daemon container with mysql connection(exposed port 81)

docker run -d --link mysql:mysql -e MYSQL_USERNAME=root --name phpmyadmin -p 81:80 corbinu/docker-phpmyadmin

###CheckoutCrypto API Container

Run CheckoutCrypto API Usage Server (exposed port 82)

docker run -d -it -p 82:80 --name api --link mysql:mysql checkoutcrypto/crypto-api

###CheckoutCrypto Site Container

• Option 1 Run CheckoutCrypto site container with mysql + api containers(above) linked. (exposed port 83):

sudo docker run -d -it --name site --link mysql:mysql --link api:api -p 83:80 checkoutcrypto/site

Then simply access it from the container's public IP with port 80. Change :83:80 e.g. hostport:containerport

• Option 2 Development

git clone https://github.com/CheckoutCrypto/site
cd ./site
docker build -t mytestsite .

Finally you can run the docker, linked to the site build with:

docker run -d -it --link mysql:mysql --link api:api -p 83:80 --name site mytestsite

####View/Install CheckoutCrypto Site

visit: http://localhost:81/site/install.php⁠ (or whatever container port you chose above) in the browser of an exposed, host, machine, to instantly install the site database tables. All mysql var are preinstalled, assuming you linked it correctly with --link mysql

###Optional Access

Single run, login to a current container, with bash

docker run -it checkoutcrypto/site /bin/bash

Access a currently running checkoutcrypto/site container

docker exec -it site /bin/bash

Site files located at /var/www/html/site - includes all necessary modules, submodules and repositories.

###Drupal installation Follow at Step 4 of Drupal Install Guide⁠, as settings.php is prefilled by site docker image. All you need to do is visit http://localhost:83/site/install.php⁠ (or whichever port you selected), continue with the admin and site setup.

##CheckoutCrypto + Modules The last steps(other than SSL and apache mod rewrite) are to: enable the correct modules(Most of CheckoutCrypto, Ctools, Jquery_update, etc), theme(bootstrap), adjust the module blocks.

##Post-installation

1. enable all modules, fix configurations e.g. smtp, site config, theme settings, blocks, etc.

2)enable Mod_rewrite:

sudo a2enmod rewrite
sudo service apache2 restart

1. go to admin -> configuration -> clean urls, hit the check for enable cleanurls;

2. You need to add all coins to the ccdev_coins table. Add their rpc info to offline worker cache menu, afterwords(worker option 2).

3. You need to add a "default" type group to the ccdev_groups table.

4. You need to select a user for use as a "hot wallet", you need to get that userid from the users table, copy it to the api configuration (api/config/ccapiconfig.php, within api repository).

Thorough, site documentation, found in ./modules/CheckoutCrypto/docs/ccDocs.pdf⁠

##API Docker See CheckoutCrypto API repository⁠

###API Git

1. cd /var/www/ && git clone https://github.com/CheckoutCrypto/crypto-api.git⁠ && sudo chown ccuser:ccuser ./api -R
2. cd ./api && git submodule init && git submodule update
3. cd /var/www/api/config/ && gedit ./dbconfig.php add your drupal database and username/password
4. gedit ./ccapiconfig.php set the worker port, address, apikey, hotwallet.

##Worker See CheckoutCrypto Worker Dart ⁠ Qt⁠

###Worker Git

1. git clone from repo
2. cd ./worker && qmake && make
3. run with ./workServer
4. create/copy service to /etc/init.d/worker
5. sudo /usr/sbin/update-rc.d worker defaults (to set it to start on restart)

##Client Platforms See Drupal ⁠ Wordpress ⁠ OpenCart ⁠ CheckoutCrypto repositories

##Bitcoin Daemon See CheckoutCrypto's Bitcoin docker⁠ instructions for one method.

###Instructions for any given daemon

1. git clone daemon's repo
2. install all dependencies
3. cd ./anycoin/src ./configure && make
4. configure nano ~/.anycoin/anycoin.conf ensure rpcuser and pass are unique and save add rpcallowip=10.0.0.1 or w.e your ip
5. add daemon service linked to daemon binary in /etc/init.d
6. make service start on restart sudo /usr/sbin/update-rc.d anycoin defaults
7. start coin and ensure rpc connection to local network

###Additional notes: Get all the validation codes, for the ccdev_coins table, by inserting any address here⁠

###API Documentation See CheckoutCrypto's Docs⁠ docker hub

##Contributing See CONTRIBUTING⁠

⁠Creators

Grant Hutchinson

##License Licensed under the Apache 2.0 License⁠, with one small reservation.