Cryptocheck Files

CRYPTOCHECK SERVER NODE
=======================

Cryptocheck server node performs periodic balance checks and stores history data on the server. It can be used alone or together with Cryptocheck desktop application which connects to the server and downloads and displays all the data collected by the server. All the history data are collected continuously by the server when your computer with the Cryptocheck desktop application is turned off.


Requirements: 
-------------

Operating systems: Linux, Windows

Web servers: Apache (compatible, tested), ISS (probably compatible, tested partially), nginx (unknown compatibility, not tested; let me know if you tried)

Python version: ≥ 3.6

Python packages: os, sys, traceback, urllib.request, json, threading, ssl, datetime, time, decimal, colorama, zipfile

PHP verion: ≥ 5.5.31

Linux shell commands: head (Linux servers only)

Windows shell commands: start, tasklist (Windows servers only)


Installation:
-------------

1. Make sure your server meets all the requirements listed above.

2. Download the latest Cryptocheck server node ZIP file from http://cryptocheck.sourceforge.io

3. Extract the ZIP file to a desired directory on the server and make this directory accessible over ethernet. For a security reasons it is recommended to use https protocol.

4. Make sure that *.json, *.py and *.txt files will NOT be accessible from web browser (with Apache web servers you can use the provided .htaccess file).

5. If you want to keep your history data collected previously with Cryptocheck desktop application, copy history.json file contained in the history.zip from the desktop application directory to the server node directory.

6. Set permissions for your web server user/group (e.g. 'www-data') for the server node directory and all contained files. Read, write and execute operations should be permitted. If not set properly, the server node might fail to save settings and/or execute Python scripts.

Example setting under Linux:

Cryptocheck files are placed in directory '/my/path/to/web_server_data/cryptocheck_directory'

cd /my/path/to/web_server_data
chown -R <my_username>:<web_server_user_group> <cryptocheck_directory>
chmod -R 770 <cryptocheck_directory>

Replace the fields <my_username>, <web_server_username> and <cryptocheck_directory> with your values.

7. Access the server node from your internet browser (e.g. https://www.my-server.com/cryptocheck).

8. Follow the instructions displayed in the browser to finish the server node setup.


If you wish to start the continual balance checking service on system startup (e.g. after reboot), add '/my/path/to/python3/python3.5 /my/path/to/cryptocheck_server_node/service.py' command to your startup services (cron etc.). Replace /my/path/to/python3/python3.5 with your value.


Update:
-------

Recommended: Use the built-in updater - in browser navigate to your Cryptocheck server node => Settings => Maintenance => Update.


Not recommended: Alternatively you can update manually by following these steps:

1. Download the latest Cryptocheck server node ZIP file from http://cryptocheck.sourceforge.io

2. Stop the continual check service (if running) via Service => Stop

3. Extract the ZIP file to the existing server node directory on the server (overwrite existing files).

4. Navigate to Status page (neccessary to update some configurations)

5. Restart the continual check service if desired via Service => Start


Troubleshooting:
----------------

● Can't start the continual check service. When I click on 'Start' in Service section, the status doesn't change to 'running'.
=> Probably you are missing some Python packages. In Service section, Log subsection, check if any missing package is reported in the text log. To install missing Python packages, SSH to your server and run 'pip3 install <package_name>' or '/my/path/to/python3/pip3 <package_name>'.