LBRYCommunity/spee.ch
1
0
Fork 0
Code Issues 95 Pull requests 2 Projects Releases 4 Packages Wiki Activity

clarity changes to docs

Browse source
This commit is contained in:
jessop 2018-12-08 23:11:10 -05:00
parent c299d369b0
commit 596a4b70a3
2 changed files with 17 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -20,7 +20,7 @@ For a closed, custom-hosted and branded example, check out https://lbry.theantim
#### Get some information ready: #### Get some information ready:
* mysqlusername * mysqlusername
* mysqlpassword * mysqlpassword
* domainname or 'http://localhost' * domainname or 'http://localhost:3000'
* speechport = 3000 * speechport = 3000
#### Install and Set Up Dependencies #### Install and Set Up Dependencies
@ -31,10 +31,10 @@ For a closed, custom-hosted and branded example, check out https://lbry.theantim
* 3333 * 3333
* 4444 * 4444
* [NodeJS](https://nodejs.org) * [NodeJS](https://nodejs.org)
* [MySQL](https://dev.mysql.com/doc/refman/8.0/en/installing.html) * [MySQL version 5.7 or higher](https://dev.mysql.com/doc/refman/8.0/en/installing.html)
* mysqlusername or root * mysqlusername or root
* mysqlpassword * mysqlpassword
* You may need * Requires mysql_native_password plugin
``` ```
mysql> `ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'yourpassword';` mysql> `ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'yourpassword';`
``` ```

30
docs/ubuntuinstall.md
View file

@ -6,23 +6,23 @@
* Ability to use SSH (putty + public key for windows users) * Ability to use SSH (putty + public key for windows users)
* Ubuntu 16.04 or 18.04 VPS with root access * Ubuntu 16.04 or 18.04 VPS with root access
* Your login info ready * Your login info ready
* Exposed ports: 22, 80, 443, 3333, 4444
* Domain name with @ and www pointed at your VPS IP * Domain name with @ and www pointed at your VPS IP
* alternatively, specify http://localhost * _alternatively, specify http://localhost:3000 as domain during speech configuration_
* Ability to send 5+ LBRY credits to an address * Ability to send 5+ LBRY credits to an address
* Noncommercial use * Noncommercial use
* _(configuration examples for nginx and certbot are included as an alternative)_ * _alternative configuration examples for nginx and certbot are [here](https://github.com/lbryio/spee.ch/tree/master/docs/setup/conf/nginx)_
## You'll be installing: ## You'll be installing:
* MySQL DB * MySQL DB version 5.7 or higher
* Default Port 3306 * Default Port 3306
* mysql_native_password plugin
* NodeJS v8+ * NodeJS v8+
* Https proxy server * Caddy - https reverse proxy server
* Caddy for personal use * automatically obtains tls certificate
* Exposed ports: 22, 80, 443, 3333, 4444 * Redirects 80 (http) to 443 (https) to Speech on 3000
* Reverse proxies 80 redirected to 443 to App on 3000
* Spee.ch started on port 3000
* Lbrynet DAEMON started on ports 3333 and 4444 * Lbrynet DAEMON started on ports 3333 and 4444
* Spee.ch started on port 3000
# 1. Setup OS and install dependencies # 1. Setup OS and install dependencies
## OS ## OS
@ -184,15 +184,13 @@ tmux allows you to run multiple things in different sessions. Useful for manuall
## Detatch tmux session ## Detatch tmux session
`Control + b`, then `d` `Control + b`, then `d`
<<<<<<< Updated upstream
* `tmux` if you want to get back into tmux * `tmux` if you want to get back into tmux
* `Control+b`, then `)` while in tmux session to cycle back to your lbrynet session to see output * `Control+b`, then `)` while in tmux session to cycle back to your lbrynet session to see output
=======
`tmux` `tmux`
_note: `Control+b`, then `)` while in tmux session to cycle back to your lbrynet session to see output_ _note: `Control+b`, then `)` while in tmux session to cycle back to your lbrynet session to see output_
>>>>>>> Stashed changes
## Display wallet address to which to send 5+ LBC. ## Display wallet address to which to send 5+ LBC.
@ -227,19 +225,17 @@ tmux allows you to run multiple things in different sessions. Useful for manuall
`npm run configure` `npm run configure`
<<<<<<< Updated upstream
=======
(once your wallet balance has cleared) (once your wallet balance has cleared)
`npm run configure` `npm run configure`
>>>>>>> Stashed changes
* Database: lbry * Database: lbry
* Username: root * Username: root
* Password: your_mysql_password * Password: your_mysql_password
* Port: 3000 * Port: 3000
* Site Title: Your Site Name * Site Title: Your Site Name
* Enter your site's domain name: https://example.com or http://localhost * Enter your site's domain name: https://example.com or http://localhost:3000
* Enter a directory where uploads should be stored: (/home/lbry/Uploads) * Enter a directory where uploads should be stored: (/home/lbry/Uploads)
`npm run start` `npm run start`
@ -255,7 +251,7 @@ tmux allows you to run multiple things in different sessions. Useful for manuall
npm install -g pm2 npm install -g pm2
``` ```
### 7 Maintenance Proceedures ### 7 Maintenance Procedures
#### Change daemon #### Change daemon
* backup wallet (private keys!) to a safe place * backup wallet (private keys!) to a safe place