LBRYCommunity/block-explorer
1
0
Fork 0
Code Issues 31 Pull requests 4 Projects Releases Packages Wiki Activity

doc updates per review

Browse source
This commit is contained in:
Akinwale Ariwodola 2018-08-09 21:28:14 +01:00
parent 3363bd1cb9
commit 60580adb0b
1 changed files with 13 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -5,14 +5,14 @@ A simple PHP block explorer for browsing transactions and claims on the [LBRY](h
## Installation ## Installation
There are some prerequisites that need to be installed before the explorer can be accessed. There are some prerequisites that need to be installed before the explorer can be accessed.
* Web server - Apache, caddy or nginx * Web server - Apache, caddy or nginx
* lbrycrd with txindex turned on * [lbrycrd](https://github.com/lbryio/lbrycrd) with txindex turned on
* Python claims decoder (https://github.com/cryptodevorg/lbry-decoder) * [Python claims decoder](https://github.com/cryptodevorg/lbry-decoder)
* MariaDB 10.2 or higher * MariaDB 10.2 or higher
* Redis Server (optional, only required for the CakePHP redis cache engine, or to run `forevermempool`) * Redis Server (optional, only required for the CakePHP redis cache engine, or to run `forevermempool`)
* PHP 7.2 or higher * PHP 7.2 or higher
* php-fpm * php-fpm
* igbinary extension (https://github.com/igbinary/igbinary) * [igbinary extension](https://github.com/igbinary/igbinary)
* phpredis extension (https://github.com/phpredis/phpredis) * [phpredis extension](https://github.com/phpredis/phpredis)
* composer (PHP package manager) * composer (PHP package manager)
### Installation steps ### Installation steps
@ -54,31 +54,38 @@ server {
``` ```
* Restart your web server. * Restart your web server.
### Cron jobs ### Cron jobs
There are a few scripts which can be set up as cron jobs or scheduled tasks. There are a few scripts which can be set up as cron jobs or scheduled tasks.
#### blocks.sh #### blocks.sh
Detect new LBRY blocks. Can also be configured to be triggered using the lbrycrd `blocknotify` flag. This cron will create new blocks obtained from lbrycrd starting from the highest block number in the database, and then create the corresponding block transactions. If there are pending transactions created by the forevermempool script, they will be automatically associated with the respective blocks. Detect new LBRY blocks. Can also be configured to be triggered using the lbrycrd `blocknotify` flag. This cron will create new blocks obtained from lbrycrd starting from the highest block number in the database, and then create the corresponding block transactions. If there are pending transactions created by the forevermempool script, they will be automatically associated with the respective blocks.
#### claimindex.sh #### claimindex.sh
Create claims found on the LBRY blockchain in the database. This requires the Python decoder to be running in the background. Create claims found on the LBRY blockchain in the database. This requires the Python decoder to be running in the background.
#### pricehistory.sh #### pricehistory.sh
Get the current LBC price in USD and store the value in the `PriceHistory` table. This also caches the most recent price in Redis. Get the current LBC price in USD and store the value in the `PriceHistory` table. This also caches the most recent price in Redis.
#### forever.sh #### forever.sh
Run the `forevermempool` script, and restart if necessary. The `forevermempool` script checks the LBRY blockchain mempool every second and creates transactions found in the database. The script makes use of Redis for caching the pending transation IDs. Run the `forevermempool` script, and restart if necessary. The `forevermempool` script checks the LBRY blockchain mempool every second and creates transactions found in the database. The script makes use of Redis for caching the pending transation IDs.
## Usage ## Usage
Launch the URL for the configured web server root in a browser. Launch the URL for the configured web server root in a browser.
## Running from Source
There are no particular steps required to run from source.
## Contributing ## Contributing
Contributions to this project are welcome, encouraged, and compensated. For more details, see https://lbry.io/faq/contributing Contributions to this project are welcome, encouraged, and compensated. For more details, see https://lbry.io/faq/contributing
## License ## License
This project is MIT licensed. For the full license, see [LICENSE](LICENSE). This project is MIT licensed. For the full license, see [LICENSE](LICENSE).
## Security ## Security
We take security seriously. Please contact security@lbry.io regarding any security issues. Our PGP key is [here](https://keybase.io/lbry/key.asc) if you need it. We take security seriously. Please contact security@lbry.io regarding any security issues. Our PGP key is [here](https://keybase.io/lbry/key.asc) if you need it.
## Contact ## Contact
The primary contact for this project is [@akinwale](https://github.com/akinwale) (akinwale@lbry.io) The primary contact for this project is [@akinwale](https://github.com/akinwale) (akinwale@lbry.io)