Compare commits
No commits in common. "master" and "BryanLunduke-patch-1" have entirely different histories.
master
...
BryanLundu
17 changed files with 235 additions and 429 deletions
|
|
@ -57,7 +57,7 @@ This project is MIT licensed. For the full license, see [LICENSE](LICENSE).
|
|||
## Security
|
||||
We take security seriously. Please contact [security@lbry.com](mailto:security@lbry.com) regarding any security issues.
|
||||
|
||||
[Our PGP key is here](https://lbry.com/faq/pgp-key) if you need it.
|
||||
[Our PGP key is here](https://keybase.io/lbry/key.asc) if you need it.
|
||||
|
||||
## Contact
|
||||
The primary contact for this project is [Thomas Zarebczan](https://github.com/tzarebczan) (tom+github@lbry.com).
|
||||
|
|
|
|||
|
|
@ -32,11 +32,6 @@ export default currentUrl => {
|
|||
title: "View LBRY resources",
|
||||
url: "/resources"
|
||||
},
|
||||
{
|
||||
name: "Tutorials",
|
||||
title: "LBRY Tutorials",
|
||||
url: "/tutorials"
|
||||
},
|
||||
{
|
||||
name: "Community",
|
||||
title: "Interact with LBRY",
|
||||
|
|
|
|||
|
|
@ -35,4 +35,9 @@ export default () => linkGrid([{
|
|||
destination: "/build",
|
||||
label: "Build An App",
|
||||
title: "Builder's Guide"
|
||||
}, {
|
||||
description: "Jumpstart your LBRY development with 100 LBC, on us",
|
||||
destination: "/developer-program",
|
||||
label: "Get Credits",
|
||||
title: "Developer Program"
|
||||
}]);
|
||||
|
|
|
|||
|
|
@ -180,23 +180,6 @@ function generateEvent(event) {
|
|||
title="View this pull request on GitHub"
|
||||
>${escapeSpecialCharacters(event.payload.pull_request.title)}</a></em> in
|
||||
`;
|
||||
|
||||
case "PullRequestReviewEvent":
|
||||
return `
|
||||
<strong><a
|
||||
href="${generateUrl("actor", event)}"
|
||||
rel="noopener noreferrer"
|
||||
target="_blank"
|
||||
title="Visit ${event.actor.login}'s profile on GitHub"
|
||||
>${event.actor.display_login}</a></strong> reviewed pull request
|
||||
|
||||
<em><a
|
||||
href="${generateUrl("pull_request", event)}"
|
||||
rel="noopener noreferrer"
|
||||
target="_blank"
|
||||
title="View this review on GitHub"
|
||||
>${escapeSpecialCharacters(event.payload.pull_request.title)}</a></em> in
|
||||
`;
|
||||
|
||||
case "PullRequestReviewCommentEvent":
|
||||
return `
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ const resolve = function(urls) {
|
|||
return new Promise(function(resolve, reject) {
|
||||
const options = {
|
||||
method: "POST",
|
||||
url: "https://api.na-backend.odysee.com/api/v1/proxy",
|
||||
url: "https://api.lbry.tv/api/v1/proxy",
|
||||
headers:
|
||||
{
|
||||
"Content-Type": "application/json"
|
||||
|
|
@ -49,7 +49,7 @@ const getTrending = function() {
|
|||
return new Promise(function(resolve, reject) {
|
||||
const options = {
|
||||
method: "POST",
|
||||
url: "https://api.na-backend.odysee.com/api/v1/proxy",
|
||||
url: "https://api.lbry.tv/api/v1/proxy",
|
||||
headers:
|
||||
{
|
||||
"Content-Type": "application/json"
|
||||
|
|
@ -77,7 +77,7 @@ const getTrending = function() {
|
|||
"technology"],
|
||||
channel_ids: [],
|
||||
not_channel_ids: [],
|
||||
not_tags: ["porn", "porno", "nsfw", "mature", "xxx", "sex", "creampie", "blowjob", "handjob", "vagina", "boobs", "big boobs", "big dick", "pussy", "cumshot", "anal", "hard fucking", "ass", "fuck", "hentai"],
|
||||
not_tags: ["porn", "nsfw", "mature", "xxx"],
|
||||
order_by: ["trending_group", "trending_mixed"]
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -30,9 +30,9 @@ If you want to contribute to LBRY, there's definitely something for you! The fir
|
|||
--- | --- | --- | ---
|
||||
| [lbry-desktop](https://github.com/lbryio/lbry-desktop) (and lbry.tv) | JavaScript (ReactJS, Electron) | A desktop browser for the LBRY network for Windows, macOS, and Linux as well as a web interface on lbry.tv. [[lbry-desktop]] is built with [[lbry-sdk]]. | [Video](/resources/video-lbrydesktop)
|
||||
| [lbry-android](https://github.com/lbryio/lbry-android) | Java | A graphical browser for the LBRY network for Android. [[lbry-android]] uses [[lbry-sdk]] to interact with the network. | [Video](/resources/video-lbryandroid)
|
||||
| [odysee-api](https://github.com/lbryio/odysee-api) | Go | An API server for https://odysee.com that reimplements some of the SDK APIs. | |
|
||||
| [odysee-ios](https://github.com/lbryio/odysee-ios) | Swift | The Odysee IOS app. | |
|
||||
| [lbry-redux](https://github.com/lbryio/lbry-redux) | JavaScript (Redux) | A common codebase for shared Redux logic between [[lbry-desktop]] and [[lbry-android]]. | |
|
||||
| [lbrytv](https://github.com/lbryio/lbrytv) | Go | An API server for https://lbry.tv and https://odysee.com that reimplements some of the SDK APIs. | |
|
||||
|
||||
### Websites
|
||||
| Domain | Language (Toolset) | What Is It
|
||||
|
|
@ -44,7 +44,7 @@ If you want to contribute to LBRY, there's definitely something for you! The fir
|
|||
| Domain | Language (Toolset) | What Is It
|
||||
--- | --- | ---
|
||||
| [chainquery](https://github.com/lbryio/chainquery) | Go | A utility for parsing, extracting, and updating the LBRY blockchain into structured SQL data. Used by several internal tools and useful for 3rd-party application development.
|
||||
| [lighthouse](https://github.com/lbryio/lighthouse) | Go, ElasticSearch | A search service for the LBRY blockchain.
|
||||
| [lighthouse](https://github.com/lbryio/lighthouse) | JavaScript, ElasticSearch | A search service for the LBRY blockchain.
|
||||
| [wunderbot](https://github.com/lbryio/lbry-wunderbot) | JavaScript (Node) | A chatbot used by the LBRY discord.
|
||||
| [block-explorer](https://github.com/lbryio/block-explorer) | PHP (vanilla) | A blockchain explorer for the LBRY blockchain.
|
||||
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ description: Find the LBRY specification, API documentation, our Contributor's g
|
|||
- [API Wrappers](/resources/api-wrappers)
|
||||
- [LBRY SDK Configuration Settings](/resources/daemon-settings)
|
||||
- [Claim Signing](/resources/claim-signing)
|
||||
- [Regtest Setup](/resources/regtest-setup)
|
||||
- [LBRY Android App Build Steps](/resources/android-build)
|
||||
- [Lighthouse (search) API](https://github.com/lbryio/lighthouse)
|
||||
- [Run Your Own Wallet Server](/resources/wallet-server)
|
||||
- [Run Your Own lbry.tv](/resources/web-instance)
|
||||
|
|
|
|||
|
|
@ -54,7 +54,7 @@ Configuration options are organized by their respective areas: Files, Wallet, Ne
|
|||
| known_dht_nodes | list | ['lbrynet1.lbry.com:4444'] | ['myDHT.lbry.com:4444'] | Bootstrap nodes for network connectivity |
|
||||
| max_connections_per_download | integer | 5 | 10 | Threads used to download blobs |
|
||||
| seek_head_blob_first | boolean | true | false | Search for first data blob after downloading sd blob |
|
||||
| tcp_port | integer | 4444 | 3334 | Port the SDK will listen on |
|
||||
| tcp_port | integer | 3333 | 3334 | Port the SDK will listen on |
|
||||
| concurrent_reflector_uploads| integer | 5 | 10 | Connections to use while uploading data to reflector |
|
||||
| reflect_streams | boolean | true | false | Send published data to reflector servers |
|
||||
| reflector_servers | list | ['reflector.lbry.com'] | ['myreflector.lbry.com'] | Server data will be reflected to |
|
||||
|
|
|
|||
|
|
@ -1,39 +0,0 @@
|
|||
---
|
||||
title: Hosting a DHT bootstrap node
|
||||
description: How to setup a bootstrap DHT node
|
||||
---
|
||||
|
||||
This guide will help you setup and maintain a LBRY DHT [bootstrap node](https://en.wikipedia.org/wiki/Bootstrapping_node). Those nodes are important so people can join the network on first startup.
|
||||
|
||||
After finishing and checking that it works, if you want to add your node to the SDK bootstrap list just open a PR adding yourself to the [conf file](https://github.com/lbryio/lbry-sdk/blob/master/lbry/conf.py#L694) or an issue on the [SDK repo](https://github.com/lbryio/lbry-sdk/).
|
||||
|
||||
## Requirements
|
||||
- Being reachable over UDP on the internet at some port
|
||||
- 1GB of memory
|
||||
- Docker or Python 3.7 (check [pyenv](https://github.com/pyenv/pyenv) if your Linux distribution doesn't offer that version)
|
||||
|
||||
## Running directly from Docker
|
||||
This is the easiest way to run and maintain your node. Just run:
|
||||
```bash
|
||||
docker run -d -p 4444:4444 lbry/dht-bootstrap:latest
|
||||
```
|
||||
|
||||
## Installing LBRY SDK from source
|
||||
The most up to date guide for doing it will always be in the [INSTALL.md file](https://github.com/lbryio/lbry-sdk/blob/master/INSTALL.md). Please refer to it if you run into trouble. Otherwise, this should be enough most of the time (assuming requirements are all there):
|
||||
```bash
|
||||
git clone https://github.com/lbryio/lbry-sdk.git
|
||||
make install
|
||||
```
|
||||
|
||||
### Running a node from source
|
||||
After installing, just:
|
||||
```bash
|
||||
python scripts/dht_node.py
|
||||
```
|
||||
|
||||
### Checking if it is working
|
||||
From another machine with the SDK installed, run:
|
||||
```bash
|
||||
python scripts/dht_node.py --bootstrap_node your-server-domain-here.com:4444
|
||||
```
|
||||
After 10-20 seconds, you should see more than 0 peers on the log messages. If that is not the case, check firewall on the bootstrap node and see if it is reachable.
|
||||
|
|
@ -1,65 +0,0 @@
|
|||
---
|
||||
title: LBRY P2P: Settings and troubleshooting
|
||||
description: Guide on properly setting up P2P nodes and how to diagnose/fix common issues.
|
||||
---
|
||||
|
||||
# LBRY P2P: Settings and troubleshooting
|
||||
|
||||
A very important step in supporting the network resilience is hosting content in a decentralized way. This already happens when you stream content using the desktop version of LBRY APP, but sometimes we want to make sure this is working or dedicate larger amounts of resources for this task.
|
||||
|
||||
This document aims to explain P2P configuration and troubleshooting from small to large nodes. If you don't know how to change SDK settings, check [this other document first](https://lbry.tech/resources/daemon-settings).
|
||||
|
||||
## Reachability
|
||||
The first priority when seeding content is making sure there is a way for other nodes to reach you across the internet.
|
||||
|
||||
### Figuring out your ports
|
||||
In order to troubleshoot reachability, we start by checking your configuration for the UDP and TCP ports. By default, they will both be set to 4444. Those can be found on the configuration under the keys `udp_port` and `tcp_port`. Please set them both to the same value as this helps connectivity trough [hole punching](https://en.wikipedia.org/wiki/Hole_punching_(networking)) and ease of management.
|
||||
|
||||
### Checking for reachability
|
||||
There are some websites providing generic ways to check ports, like:
|
||||
- https://www.portcheckers.com/
|
||||
- https://portchecker.co/check
|
||||
|
||||
However, checking the port does not check if LBRY P2P protocol is working behind it. For a better check, we can use a tool hosted by Madiator, a community member.
|
||||
- To test for UDP (DHT): http://test.madiator.com:60666/dht/<your `udp_port`>
|
||||
- To test for TCP (P2P): http://test.madiator.com:60666/p2p/<your `tcp_port`>
|
||||
|
||||
As a last resource to test a remote machine DHT service, from a local SDK try:
|
||||
```bash
|
||||
lbrynet peer ping <DHT node id> <IP> <port>
|
||||
```
|
||||
|
||||
To find out what the `DHT node id` is, on the target machine run `lbrynet status` and look for `node_id` .
|
||||
|
||||
### I am unreachable. What now?
|
||||
|
||||
VPN users: check with your provider if they feature port forwarding. There are guides specific to each one, like [this one from Mullvad](https://mullvad.net/en/help/port-forwarding-and-mullvad/).
|
||||
|
||||
Domestic routers: there are websites like [this one](https://portforward.com/how-to-port-forward/) providing information on popular router models. Unfortunately, this document would be huge if we added port forwarding instructions for every router/firewall.
|
||||
|
||||
Servers: check if your firewall is blocking the SDK ports. For ufw on Linux, this is `sudo ufw allow <port>`.
|
||||
|
||||
If you still have trouble figuring that out, don't be shy, [ask the LBRY community on Discord!](https://chat.lbry.com/)
|
||||
|
||||
## Content blobs storage settings
|
||||
|
||||
Files in LBRY are composed by `content blobs`, which can be seen as chunks of binary encrypted data belonging to some content. By default, the SDK enables saving blobs to disk, which then can be served over P2P. To check if that is enabled, look for the `save_blobs` setting.
|
||||
|
||||
**The following settings are isolated. The space limit set for one does not apply to the other.**
|
||||
|
||||
### Setting up storage space control
|
||||
|
||||
By default, content blobs are kept as long as the files are still in your file list. If you wish to allocate a space limit for content blobs and let the SDK decide what to delete, set `blob_storage_limit` to a value in megabytes.
|
||||
|
||||
This won't delete your downloads from the file list. Instead, it deletes content blobs associated with older files as space for newer blobs is requested.
|
||||
|
||||
|
||||
### Setting up space for automatic contribution
|
||||
|
||||
This section is aimed at fully automatic contribution in background. Normal usage of the SDK with P2P enabled already helps the network, but requires interaction.
|
||||
|
||||
LBRY SDK can be configured to help the P2P network by automatically downloading and hosting content. This is ideal for contributing spare disk space and network bandwidth without further interaction.
|
||||
|
||||
Enabling: change `network_storage_limit` to the size (in megabytes) that will be used for automatic seeding.
|
||||
|
||||
Disabling: setting the space to 0 disables it. The space used will eventually be released automatically. For cleaning immediately, issue a `lbrynet blob clean` from command line.
|
||||
208
documents/resources/regtest-setup.md
Normal file
208
documents/resources/regtest-setup.md
Normal file
|
|
@ -0,0 +1,208 @@
|
|||
---
|
||||
title: Regtest Setup
|
||||
description: Regtest is a parallel testing network for the LBRY blockchain. Learn how to use it in this resource article.
|
||||
---
|
||||
|
||||
## Why Use Regtest
|
||||
|
||||
A regtest server provides for a way to instantly generate blocks so that transactions can be instantaneous, which ultimately means no waiting for confirmations from the blockchain. Also, it’s not a problem if you accidentally corrupt your wallet, since no real funds are lost! Delete the files and setup a new one.
|
||||
|
||||
## Setup
|
||||
|
||||
To begin setting up the network, there are a few things you need.
|
||||
|
||||
You'll need a Linux or a Mac distribution to run all this. A virtual machine is fine.
|
||||
Note: These instructions specifically were tested on Ubuntu version 16.04.
|
||||
|
||||
### Virtual Environment
|
||||
|
||||
First up it's a good idea to create a Python virtual environment. This requires you to have a functional python2.7 setup, with the Python package manager `pip` installed. To create a new virtual environment in a folder `lbry-env`, run this:
|
||||
`virtualenv -p /usr/bin/python2.7 lbry-env`
|
||||
To enter the environment, run:
|
||||
`source lbry-env/bin/activate`.
|
||||
|
||||
### lbrycrd
|
||||
|
||||
You need to download a build of `lbrycrd` from [here](https://github.com/lbryio/lbrycrd/releases/), no installation required. To configure `lbrycrd` you need to create a file at `~/.lbrycrd/lbrycrd.conf`,
|
||||
containing the following:
|
||||
```ini
|
||||
rpcuser=test
|
||||
rpcpassword=test
|
||||
rpcport=18332
|
||||
regtest=1
|
||||
server=1
|
||||
txindex=1
|
||||
daemon=1
|
||||
listen=0
|
||||
discover=0
|
||||
```
|
||||
|
||||
### lbryum-server
|
||||
|
||||
To install lbryum-server, you first need to install the package `leveldb`. After that, download the source from [here](https://github.com/lbryio/lbryum-server/releases), and run the following _not_ inside the environment:
|
||||
```bash
|
||||
cd lbryum-server
|
||||
sudo pip2 install -r requirements.txt
|
||||
```
|
||||
|
||||
If you're not running debian/\*buntu or a derivative of those, you need to edit the `configure` file a bit. In line 11, remove the `apt-get` line and manually install the required packages. In line 51, change `adduser` to `useradd` and on the same line, change `--disabled-password` to `-p !`.
|
||||
|
||||
```bash
|
||||
sudo ./configure
|
||||
sudo python2 setup.py install
|
||||
```
|
||||
The `sudo ./configure` command creates a new user in the system by the name "lbryum", which is the user through which we'll be running the server. lbryum-server also needs W/R access to `/var/lbryum-server`.
|
||||
To do that run:
|
||||
```bash
|
||||
sudo chown -R lbryum /var/lbryum-server
|
||||
```
|
||||
When installed, append/use the following config options to the `/etc/lbryum.conf` file:
|
||||
```ini
|
||||
[lbrycrdd]
|
||||
lbrycrdd_host = localhost
|
||||
lbrycrdd_port = 18332
|
||||
# user and password from lbrycrd.conf
|
||||
lbrycrdd_user = test
|
||||
lbrycrdd_password = test
|
||||
|
||||
[network]
|
||||
type=lbrycrd_regtest
|
||||
```
|
||||
|
||||
### lbryum
|
||||
|
||||
To install lbryum, first download the source from [here](https://github.com/lbryio/lbryum/releases). To install it, run the following inside the virtual environment:
|
||||
```bash
|
||||
cd lbryum
|
||||
pip2 install -r requirements.txt
|
||||
pip2 install -e .
|
||||
```
|
||||
|
||||
After installation completes, you must set the config option for lbryum using:
|
||||
```bash
|
||||
lbryum setconfig default_servers '{ "localhost": { "t": "50001" }}'
|
||||
lbryum setconfig chain 'lbrycrd_regtest'
|
||||
```
|
||||
|
||||
Alternatively, you can create a file `touch ~/.lbryum/config` and paste the following config:
|
||||
```json
|
||||
{
|
||||
"chain": "lbrycrd_regtest",
|
||||
"default_servers": {
|
||||
"localhost": {
|
||||
"t": "50001"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### lbry
|
||||
|
||||
Download source from [here](https://github.com/lbryio/lbry-sdk/releases), and run the following inside the environment:
|
||||
```bash
|
||||
cd lbry
|
||||
pip2 install -r requirements.txt
|
||||
pip2 install -e .
|
||||
mkdir ~/.lbrynet
|
||||
touch ~/.lbrynet/daemon_settings.yml
|
||||
```
|
||||
|
||||
Append the following in the newly created `~/.lbrynet/daemon_settings.yml` file:
|
||||
```yml
|
||||
blockchain_name: lbrycrd_regtest
|
||||
lbryum_servers:
|
||||
- localhost:50001
|
||||
reflect_uploads: false
|
||||
share_usage_data: false
|
||||
use_upnp: false
|
||||
```
|
||||
|
||||
### Last step
|
||||
Go to the `lbryum` folder once again and run:
|
||||
```bash
|
||||
pip2 install -e .
|
||||
```
|
||||
This is to ensure that `lbrynet-daemon` uses the correct wallet.
|
||||
|
||||
## Firing up the regtest server
|
||||
|
||||
### Wallet backup
|
||||
|
||||
To start off, if you've already used LBRY on your machine, you need to backup the wallet by copying the folders `~/.lbrynet` and `~/.lbryum` and then deleting them to start from fresh. Run
|
||||
`mkdir ~/.lbryum`
|
||||
|
||||
Now it should be all set-up. Just execute the commands in the following order, and the regtest server should be good to go.
|
||||
|
||||
### 1) lbrycrd
|
||||
|
||||
To run the `lbrycrd` daemon, run the following in the `lbrycrd` folder:
|
||||
`./lbrycrdd`
|
||||
|
||||
To generate blocks, run `./lbrycrd-cli generate <num_of_blocks>`
|
||||
You'll need to generate some blocks to get the network going. Start off by generating at least 100.
|
||||
`./lbrycrd-cli generate 173`
|
||||
|
||||
If you'd prefer a more verbose output from lbrycrdd, run lbrycrd using:
|
||||
`./lbrycrdd -printtoconsole`
|
||||
|
||||
### 2) lbryum-server
|
||||
|
||||
To run the server, run:
|
||||
```bash
|
||||
sudo runuser -l lbryum -c 'lbryum-server --conf=/etc/lbryum.conf'
|
||||
```
|
||||
Note: conf flag can be left out if the config is in the default directory(default: `/etc/lbryum.conf`)
|
||||
|
||||
### 3) lbryum
|
||||
|
||||
To run the lbryum, run:
|
||||
```bash
|
||||
lbryum daemon start
|
||||
```
|
||||
|
||||
Generate some more blocks, get a wallet address by running:
|
||||
`lbryum getunusedaddress`
|
||||
and then send some credits to your wallet by doing
|
||||
`./lbrycrd-cli sendtoaddress <address> <num_of_credits>`
|
||||
|
||||
### 4) lbry
|
||||
|
||||
You can now run `lbrynet-daemon`, and it should connect to the `lbryum`. Now you can use the regtest stack as you would normally use lbryum.
|
||||
|
||||
## Shutdown
|
||||
|
||||
To stop the network, run `lbrynet-cli daemon_stop`, `lbryum daemon stop`, and kill the `lbryum-server` process and stop lbrycrd by `lbrycrdd-cli stop`. If you want to use your wallet and the official servers again, backup the new regtest wallet, and replace it with your own.
|
||||
|
||||
## Note 1
|
||||
You need to generate a few blocks every time you make a new transaction in the form of send, receive, claim, update, publish, support, tip, etc. for it to show up in the daemon and lbryum, etc.
|
||||
|
||||
## Note 2
|
||||
If something goes wrong and you get a "Block not found" error, remember to delete `/var/lbryum-server` before trying again.
|
||||
|
||||
## Cheatsheet
|
||||
|
||||
#### Required processes in the correct order
|
||||
```bash
|
||||
lbrycrdd
|
||||
|
||||
sudo runuser -l lbryum -c 'lbryum-server --conf=/etc/lbryum.conf'
|
||||
|
||||
lbryum daemon start
|
||||
|
||||
lbrynet-daemon
|
||||
```
|
||||
|
||||
#### Generate blocks
|
||||
```bash
|
||||
lbrycrd-cli generate 5
|
||||
```
|
||||
|
||||
#### Get a wallet address
|
||||
```bash
|
||||
lbryum getunsusedaddress
|
||||
```
|
||||
|
||||
#### Send credits from lbrycrd to your wallet
|
||||
```bash
|
||||
lbrycrd-cli sendtoaddress <address> <num_of_credits>
|
||||
```
|
||||
|
|
@ -65,7 +65,7 @@ This document exists to introduce a project to a new visitor. It may also serve
|
|||
|
||||
### Security
|
||||
|
||||
* "We take security seriously. Please contact [security@lbry.com](mailto:security@lbry.com) regarding any security issues. Our PGP key is [here](https://lbry.com/faq/pgp-key) if you need it."
|
||||
* "We take security seriously. Please contact [security@lbry.com](mailto:security@lbry.com) regarding any security issues. Our PGP key is [here](https://keybase.io/lbry/key.asc) if you need it."
|
||||
|
||||
### Contact
|
||||
|
||||
|
|
|
|||
|
|
@ -1,59 +0,0 @@
|
|||
# How to spend your time locked transaction
|
||||
|
||||
This guide will walk you through the process of claiming a time locked transaction from a USB key. This involves accessing the transaction details on the key, making sure you have the latest version of `lbrynet` and finally using the transaction details to call `account_deposit` to claim your LBC.
|
||||
|
||||
## Check `lbrynet` version
|
||||
|
||||
If you already have `lbrynet` installed then you can check your version like this:
|
||||
|
||||
```
|
||||
lbrynet version
|
||||
```
|
||||
|
||||
If above command fails, you may need to start `lbrynet` first (and then try above again):
|
||||
|
||||
```
|
||||
lbrynet start
|
||||
```
|
||||
|
||||
If you do not have `lbrynet` installed or your version is less than `v0.108.0` then you can get latest version here:
|
||||
|
||||
[https://github.com/lbryio/lbry-sdk/releases](https://github.com/lbryio/lbry-sdk/releases)
|
||||
|
||||
|
||||
## Gather Information
|
||||
|
||||
### Transaction ID and Transaction Output Number
|
||||
|
||||
1. On the USB key, find a file named `address.txt` and copy the address in this file.
|
||||
1. Go to [LBRY Explorer](https://explorer.lbry.com/) and enter the address you copied.
|
||||
1. You should see one transaction containing this address, click on this transaction.
|
||||
1. You will need two pieces of information on this page, the `transaction id` and the `nout`.
|
||||
1. The `transaction id` can be found at the top of the page and directly below the text `LBRY Transaction`.
|
||||
1. The `nout` is the position of the output containing your address, starting with 0. Starting from the top of the list of outputs, count the outputs until you get to your address, then subtract 1 from this count, that is your `nout`.
|
||||
|
||||
### Private Key and Redeem Script
|
||||
|
||||
1. On the USB key, find a file named `key.zip` and unzip this file using the password emailed to you previously.
|
||||
1. You should now have a file named `key.txt` which is base64 encoded and contains your `private key` and `redeem script`.
|
||||
1. To decode the contents of the file you can use a website such as [base64decode.org](https://www.base64decode.org/) (not a secure option) or if you have Python installed you can do this on the command line:
|
||||
```
|
||||
python -m base64 -d /path/to/key.txt
|
||||
```
|
||||
1. After decoding you will see a key/value mapping of various items, including `privateKey` and `redeemScript`. Take note of these values.
|
||||
|
||||
## Redeem
|
||||
|
||||
Now that you have gathered the necessary information it is easy to redeem your LBC. Time locked transaction can be redeemed using the `lbrynet account deposit` command (fill in the values you gathered previously):
|
||||
|
||||
```
|
||||
lbrynet account deposit <transaction id> <nout> <redeemScript> <privateKey>
|
||||
```
|
||||
|
||||
If you get an error that says `AssertionError: Cannot find private key for signing output.`, try a different number for `<nout>` (for example, increase or decrease it by 1).
|
||||
|
||||
Enjoy your LBC!
|
||||
|
||||
## Get in touch
|
||||
|
||||
Whether you got to the end without a hiccup or you got stuck along the way, we want to hear from you. [Join our Discord](https://discord.gg/y3W9JuS) to get help, stay updated, and talk to other wallet server operators.
|
||||
|
|
@ -7,7 +7,7 @@ This guide will walk you through the process of setting up a LBRY wallet server.
|
|||
|
||||
## Start With A Fresh Server
|
||||
|
||||
We recommend a quad-core server with at least 16GB RAM, 200GB disk, and a fresh Ubuntu 18.04 install. Memory usage is flexible. 32 GB works best, but 16 GB is enough for a few clients.
|
||||
We recommend a dual-core server with at least 16GB RAM, 100GB disk, and a fresh Ubuntu 18.04 install. Memory usage is flexible. 32 GB works best, but 16 GB is enough for a few clients.
|
||||
|
||||
Make sure your firewall has ports 9246 and 50001 open. 9246 is the port lbrycrd uses to communicate to other nodes. 50001 is the wallet server RPC port.
|
||||
|
||||
|
|
@ -24,6 +24,7 @@ daemon=1
|
|||
rpcuser=lbry
|
||||
rpcpassword=lbry
|
||||
dustrelayfee=0.00000001
|
||||
rpcworkqueue=128
|
||||
```
|
||||
|
||||
Feel free to change the `rpcuser` or `rpcpassword`. If you do, you'll have to update the `DAEMON_URL` variable later on (in the docker-compose.yml file) to match the user/password you chose.
|
||||
|
|
@ -40,19 +41,11 @@ Description="LBRYcrd daemon"
|
|||
After=network.target
|
||||
|
||||
[Service]
|
||||
ExecStart=/home/<your_user>/lbrycrdd -datadir="/home/<your_user>/.lbrycrd" -pid="/run/lbrycrdd/lbrycrdd.pid"
|
||||
# Creates /run/lbrycrdd
|
||||
RuntimeDirectory=lbrycrdd
|
||||
Type=Forking
|
||||
PIDFile=/run/lbrycrdd/lbrycrdd.pid
|
||||
ExecStart=/home/<your_user>/lbrycrdd -datadir="/home/<your_user>/.lbrycrd"
|
||||
User=<your_user>
|
||||
Group=<your_user_group>
|
||||
Restart=on-failure
|
||||
|
||||
# hardening
|
||||
PrivateTmp=true
|
||||
ProtectSystem=full
|
||||
NoNewPrivileges=true
|
||||
PrivateDevices=true
|
||||
MemoryDenyWriteExecute=true
|
||||
KillMode=process
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
|
|
@ -62,8 +55,6 @@ Then run `sudo systemctl daemon-reload`.
|
|||
|
||||
Now you can start and stop lbrycrd with `sudo service lbrycrdd start` and `sudo service lbrycrdd stop`.
|
||||
|
||||
You can watch the lbrycrd log with `tail -f ~/.lbrycrd/debug.log`
|
||||
|
||||
## Set Up Docker
|
||||
|
||||
### Install Docker & Docker Compose
|
||||
|
|
@ -76,58 +67,21 @@ sudo systemctl enable docker && sudo systemctl start docker && \
|
|||
sudo curl -L "https://github.com/docker/compose/releases/download/1.24.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose && \
|
||||
sudo chmod +x /usr/local/bin/docker-compose
|
||||
sudo usermod -aG docker $USER
|
||||
|
||||
```
|
||||
|
||||
### Download our example docker-compose.yml
|
||||
### Download our docker-compose.yml
|
||||
|
||||
You can see it [here](https://github.com/lbryio/lbry-sdk/blob/master/docker/docker-compose-wallet-server.yml).
|
||||
```
|
||||
curl -L "https://raw.githubusercontent.com/lbryio/lbry-sdk/master/docker/docker-compose-wallet-server.yml" -o docker-compose.yml
|
||||
```
|
||||
|
||||
Make sure the user and password in the `DAEMON_URL` variable (the `lbry@lbry` part) in this docker-compose.yml matches the user/password in your `~/.lbrycrd/lbrycrd.conf` file.
|
||||
|
||||
### Download snapshots for elasticsearch and the wallet server (optional)
|
||||
|
||||
You can skip the initial sync by starting from a snapshot. The following will download a snapshot of the elasticsearch volume and move it into the default location for docker volumes on ubuntu, on other systems you may need to adjust the path used here. Note: snapshot heights must be the same. The tars can be deleted after setting the volumes up.
|
||||
|
||||
```bash
|
||||
SNAPSHOT_HEIGHT="1049658"
|
||||
ES_VOLUME_PATH="/var/lib/docker/volumes/${USER}_es01"
|
||||
ES_SNAPSHOT_TAR_NAME="es_snapshot_${SNAPSHOT_HEIGHT}.tar"
|
||||
ES_SNAPSHOT_URL="https://snapshots.lbry.com/hub/${ES_SNAPSHOT_TAR_NAME}"
|
||||
|
||||
wget $ES_SNAPSHOT_URL
|
||||
echo "decompressing elasticsearch snapshot"
|
||||
tar -xf $ES_SNAPSHOT_TAR_NAME
|
||||
sudo chown -R $USER:root "snapshot_es_${SNAPSHOT_HEIGHT}"
|
||||
sudo chmod -R 775 "snapshot_es_${SNAPSHOT_HEIGHT}"
|
||||
sudo mkdir -p $ES_VOLUME_PATH
|
||||
sudo rm -rf "${ES_VOLUME_PATH}/_data"
|
||||
sudo mv "snapshot_es_${SNAPSHOT_HEIGHT}" "${ES_VOLUME_PATH}/_data"
|
||||
```
|
||||
|
||||
The following will download the wallet server docker volume and move it into place as well.
|
||||
|
||||
```bash
|
||||
echo "fetching wallet server snapshot"
|
||||
SNAPSHOT_HEIGHT="1049658"
|
||||
HUB_VOLUME_PATH="/var/lib/docker/volumes/${USER}_wallet_server"
|
||||
SNAPSHOT_TAR_NAME="wallet_server_snapshot_${SNAPSHOT_HEIGHT}.tar"
|
||||
SNAPSHOT_URL="https://snapshots.lbry.com/hub/${SNAPSHOT_TAR_NAME}"
|
||||
|
||||
wget $SNAPSHOT_URL
|
||||
tar -xf $SNAPSHOT_TAR_NAME
|
||||
sudo mkdir -p $HUB_VOLUME_PATH
|
||||
sudo rm -rf "${HUB_VOLUME_PATH}/_data"
|
||||
sudo chown -R 999:999 "snapshot_${SNAPSHOT_HEIGHT}"
|
||||
sudo mv "snapshot_${SNAPSHOT_HEIGHT}" "${HUB_VOLUME_PATH}/_data"
|
||||
```
|
||||
Make sure the user and password in the `DAEMON_URL` variable (the `lbry@lbry` part) in this docker-compose.yml matches thes user/password in your `~/.lbrycrd/lbrycrd.conf` file.
|
||||
|
||||
## Turn It On
|
||||
|
||||
### Start the servers
|
||||
|
||||
```
|
||||
docker-compose up --detach
|
||||
```
|
||||
|
|
@ -157,7 +111,7 @@ echo '{"id":1,"method":"server.version"}' | timeout 1 curl telnet://localhost:50
|
|||
You should see a response like `{"jsonrpc": "2.0", "result": ["0.46.1", "0.0"], "id": 1}`. If you do, congratulations! You've set up your own wallet server.
|
||||
|
||||
|
||||
To check Elastic search, there are two commands you can use:
|
||||
To check Elastic search, there are two commands you can use:
|
||||
|
||||
```
|
||||
curl localhost:9200 # get Elastic status
|
||||
|
|
@ -188,7 +142,7 @@ From time to time, we'll release an update that requires recreating one of the d
|
|||
The process is similar to an update, but causes the server to be down for much longer.
|
||||
|
||||
#### Main database
|
||||
Holds the raw blockchain data and takes several days to resync from scratch, so be sure to have a snapshot or try that last.
|
||||
Holds the raw blockchain data and takes many hours (can take a day or two) to resync from scratch, so be sure to have a snapshot or try that last.
|
||||
|
||||
```
|
||||
docker pull lbry/wallet-server:latest-release
|
||||
|
|
@ -198,7 +152,8 @@ WALLET_SERVER_SNAPSHOT_URL= docker-compose up --detach
|
|||
```
|
||||
|
||||
#### Elasticsearch
|
||||
ES does the indexing of claims from the main database. It should take around 6 hours to resync on a fast machine.
|
||||
ES does the indexing of claims from the main database. It should take around 30 minutes to resync on a fast machine.
|
||||
|
||||
|
||||
```
|
||||
docker pull lbry/wallet-server:latest-release
|
||||
|
|
|
|||
|
|
@ -1,79 +0,0 @@
|
|||
---
|
||||
title: Hosting your own LBRY Web Instance
|
||||
description: Setting up an app instance as a webpage.
|
||||
---
|
||||
|
||||
Run your own instance of https://lbry.tv using Docker images.
|
||||
|
||||
|
||||
## Run the SDK
|
||||
|
||||
The LBRY SDK provides RPC and streaming endpoints to interact with the LBRY network. Web users will connect to it directly, so it must be web-accessible. You may have to open ports on your firewall.
|
||||
|
||||
```
|
||||
docker run -d -p 5279:5279 -p 5280:5280 vshyba/websdk
|
||||
```
|
||||
|
||||
This image will not save files to disk. It has the `save_blobs` and `save_files` config options set to `false`. If you want to save files, see [Building your own SDK image](#building-your-own-sdk-image) below.
|
||||
|
||||
|
||||
## Run the web app
|
||||
|
||||
Clone and install the app as described in the [lbry-desktop repo README](https://github.com/lbryio/lbry-desktop).
|
||||
If you want to customize it further, follow the extra steps in `Customize the web app` section. Otherwise:
|
||||
|
||||
```
|
||||
git clone https://github.com/lbryio/lbry-desktop.git
|
||||
yarn
|
||||
cp .env.defaults .env
|
||||
```
|
||||
|
||||
Configure .env with the following settings. They must match the SDK ports in the previous section.
|
||||
```
|
||||
WEB_SERVER_PORT=8080
|
||||
SDK_API_PATH=http://localhost:5279
|
||||
LBRY_WEB_API=http://localhost:5279
|
||||
LBRY_WEB_STREAMING_API=http://localhost:5280
|
||||
LBRY_API_URL=http://disabled-api/
|
||||
LBRY_WEB_BUFFER_API=https://disabled
|
||||
```
|
||||
|
||||
Compile and run
|
||||
```
|
||||
NODE_ENV=production yarn compile:web
|
||||
nodejs web/index.js
|
||||
```
|
||||
|
||||
|
||||
## Building your own SDK image
|
||||
|
||||
If you want to customize the SDK settings, you can
|
||||
|
||||
Clone the SDK repo:
|
||||
```
|
||||
git clone https://github.com/lbryio/lbry-sdk.git
|
||||
```
|
||||
|
||||
Create a `docker/webconf.yaml` file and modify as you need. This is a good start:
|
||||
```
|
||||
allowed_origin: "*"
|
||||
max_key_fee: "0.0 USD"
|
||||
save_files: false
|
||||
save_blobs: false
|
||||
streaming_server: "0.0.0.0:5280"
|
||||
api: "0.0.0.0:5279"
|
||||
data_dir: /tmp
|
||||
download_dir: /tmp
|
||||
wallet_dir: /tmp
|
||||
```
|
||||
|
||||
Note that it is required to have `streaming_server` and `api` set to user-accessible IPs. If you want this to be accessible on the open web, that means setting them to `0.0.0.0`.
|
||||
|
||||
|
||||
To build the image, run:
|
||||
```
|
||||
docker build -f docker/Dockerfile.web -t <your dockerhub username>/<project name, like 'websdk'> .
|
||||
docker push <dockerhub username/project name>
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,73 +0,0 @@
|
|||
## Hello Satoshi - The LBRY "Hello World" Tutorial
|
||||
|
||||
Let's get started with a simple "Hellow World" tutorial... LBRY style!
|
||||
|
||||
This tutorial will guide you through creating a basic [Electron](https://electronjs.org) application that calls to the LBRY network and renders an image returned by the network.
|
||||
|
||||
Electron is nice because it allows you to easily create web apps that don't rely on any centralized web servers, but you can absolutely use any tooling or language you would like.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
This tutoral only has a few simple requirements:
|
||||
|
||||
- [npm](https://www.npmjs.com). Learn how to install it [here](https://www.npmjs.com/get-npm).
|
||||
- [git](https://git-scm.com/).
|
||||
|
||||
Once you have those installed (see the links above for downloads and How-To's), you are ready to begin!
|
||||
|
||||
#### Step 1. Download and build the starter project
|
||||
|
||||
Grab "[electron-starter](https://github.com/lbryio/electron-starter)". This project serves as a base upon which you can build LBRY applications. (Similar to "create-react-app" for React development.)
|
||||
|
||||
If you have git and npm installed, run the following lines one at a time:
|
||||
|
||||
```
|
||||
git clone https://github.com/lbryio/electron-starter
|
||||
cd electron-starter
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
#### Step 2. Make sure everything works
|
||||
|
||||
Before we make any changes, it's a good idea to verify that everything is working correctly.
|
||||
|
||||
Try typing a word into the text input and click the button to [resolve](https://lbry.tech/api/sdk#resolve) it.
|
||||
|
||||
This performs a [[claim]] lookup, which retrieves metadata the title, thumbnail, and file type from the LBRY blockchain.
|
||||
|
||||
Try resolving `lbry://doitlive`.
|
||||
|
||||
If you received no errors, move on to Step 3! Otherwise, head back to Step 1 to make sure you have all the requirements installed correctly.
|
||||
|
||||
#### Step 3. Make a small change to the code
|
||||
|
||||
Now that we have the metadata, let's [get](https://lbry.tech/api/sdk#get) the actual file!
|
||||
|
||||
The code to do this is already there, just un-comment these lines in the app's [renderer/index.js](https://github.com/lbryio/electron-starter/blob/master/src/renderer/index.js) file.
|
||||
|
||||
```js
|
||||
claimData.innerText = "Loading...";
|
||||
|
||||
Lbry.get({ uri: `lbry://${value}` })
|
||||
.then(result => {
|
||||
const filePath = result.download_path;
|
||||
const image = document.createElement("img");
|
||||
|
||||
image.src = filePath;
|
||||
imageWrapper.appendChild(image);
|
||||
|
||||
claimData.innerText = JSON.stringify(result, null, 2);
|
||||
})
|
||||
.catch(error => {
|
||||
claimData.innerText = JSON.stringify(error, null, 2);
|
||||
});
|
||||
```
|
||||
|
||||
This is the code that actually downloads a file.
|
||||
|
||||
There are more robust ways to handle the download progress, but this will work fine for images. After you added that code back, try `get`ing `lbry://doitlive`.
|
||||
|
||||
### Success! You Did It!
|
||||
|
||||
While our Hello Satoshi app isn't much to look at, it shows how simple it is to connect to the LBRY network and download files!
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
---
|
||||
title: Tutorials
|
||||
description: Learn how to setup, use, deploy, and develop with LBRY.
|
||||
---
|
||||
# LBRY Programming Tutorials
|
||||
|
||||
## Tutorial #1 - "Hello Satoshi!"
|
||||
Learn how to [create and modify a simple LBRY electron application](/tutorial-hellosatoshi) we'll call "[Hello Satoshi](/tutorial-hellosatoshi)".
|
||||
|
||||
---
|
||||
|
||||
# Setup your Development Environment
|
||||
|
||||
## Desktop Application
|
||||
[Video tutorial](/resources/video-lbrydesktop) to setup the [Desktop app](https://github.com/lbryio/lbry-desktop) development environment.
|
||||
|
||||
## Android Application
|
||||
[Video tutorial](/resources/video-lbryandroid) to setup the [Android app](https://github.com/lbryio/lbry-android) development environment.
|
||||
|
||||
## LBRY SDK
|
||||
[Video tutorial](/resources/video-lbrysdk) to setup the [LBRY SDK](https://github.com/lbryio/lbry-sdk) development environment.
|
||||
|
||||
## LBRY Blockchain
|
||||
[Video tutorial](/resources/video-lbrycrd) to setup the [LBRY Blockchain](https://github.com/lbryio/lbrycrd) development environment.
|
||||
|
||||
Loading…
Add table
Reference in a new issue