Update README.md with installation instructions #30

Merged
akinwale merged 2 commits from documentation into master 2018-08-09 22:30:21 +02:00
Showing only changes of commit 60580adb0b - Show all commits

View file

@ -5,14 +5,14 @@ A simple PHP block explorer for browsing transactions and claims on the [LBRY](h
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
## 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
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
* Python claims decoder (https://github.com/cryptodevorg/lbry-decoder) * [Python claims decoder](https://github.com/cryptodevorg/lbry-decoder)
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
* 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)
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
* phpredis extension (https://github.com/phpredis/phpredis) * [phpredis extension](https://github.com/phpredis/phpredis)
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
* composer (PHP package manager) * composer (PHP package manager)
### Installation steps ### Installation steps
@ -54,31 +54,38 @@ server {
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
``` ```
* Restart your web server. * Restart your web server.
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
### 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.
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
#### 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.
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
#### 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.
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
#### 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.
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
#### 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.
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
## 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
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
There are no particular steps required to run from source.
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
## 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
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
## 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).
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
## 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.
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
## 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)

kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.
kauffj commented 2018-08-06 23:56:41 +02:00 (Migrated from github.com)
Review

link lbrycrd

link lbrycrd
kauffj commented 2018-08-06 23:57:13 +02:00 (Migrated from github.com)
Review

I think there should be newlines between paragraphs and the next header (throughout this section).

I think there should be newlines between paragraphs and the next header (throughout this section).
kauffj commented 2018-08-06 23:58:01 +02:00 (Migrated from github.com)
Review

This section can just be removed.

This section can just be removed.