k8s-lbry README updates.

This commit is contained in:
Ryan McGuire 2019-06-14 15:34:20 -04:00 committed by Leopere
parent 3ebda8fb5d
commit 45a5049ae5
2 changed files with 25 additions and 58 deletions

View file

@ -2,12 +2,11 @@
Contributing Author: [EnigmaCurry](https://www.enigmacurry.com) Contributing Author: [EnigmaCurry](https://www.enigmacurry.com)
Last Update: May 30 2019 Last Update: June 14 2019
Deploy lbrycrd, lbrynet, chainquery, mysql, and spee.ch on your Kubernetes Deploy [lbrycrd](https://github.com/lbryio/lbrycrd), [lbrynet](https://github.com/lbryio/lbry), [chainquery](https://github.com/lbryio/chainquery), [mysql](https://www.mysql.com), and [spee.ch](https://github.com/lbryio/spee.ch) on your [Kubernetes](https://kubernetes.io/) cluster.
cluster.
[![asciicast](https://enigmacurry.github.io/lbry-docker/contrib/k8s-lbry/kick-ascii/cast/k8s-lbry.png)](https://enigmacurry.github.io/lbry-docker/contrib/k8s-lbry/kick-ascii/?cast=k8s-lbry&bg=lbry.png) [![asciicast](https://lbryio.github.io/lbry-docker/contrib/k8s-lbry/kick-ascii/cast/k8s-lbry.png)](https://lbryio.github.io/lbry-docker/contrib/k8s-lbry/kick-ascii/?cast=k8s-lbry&bg=lbry.png)
<!-- Regenerate Table of contents with markdown-toc npm library --> <!-- Regenerate Table of contents with markdown-toc npm library -->
<!-- run: npx markdown-toc -i README.md --> <!-- run: npx markdown-toc -i README.md -->
@ -114,6 +113,14 @@ The Helm configuration file contains *all* of the configuration for the system,
The lbrynet SDK wallets are individually stored unencrypted in their own The lbrynet SDK wallets are individually stored unencrypted in their own
persistent volumes. persistent volumes.
“We take security seriously. Please contact
[security@lbry.io](mailto:security@lbry.io) regarding any security issues. Our
PGP key is [here](https://keybase.io/lbry/key.asc) if you need it.” If you find
vulnerabilites, especially any that might increase the risk of someone losing
their crypto currency [Responsible
Disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure) is
appreciated.
## Installation ## Installation
This system is installed via [Helm](https://helm.sh/docs/), the package manager This system is installed via [Helm](https://helm.sh/docs/), the package manager
@ -144,6 +151,9 @@ curl -Lo run.sh https://raw.githubusercontent.com/EnigmaCurry/lbry-docker/k8s-lb
chmod a+x run.sh chmod a+x run.sh
``` ```
It's a good idea to always read any script you download from the internet,
before running it.
### Setup alias and tab completion ### Setup alias and tab completion
`run.sh` can be run directly without any setup. However, without adding it to `run.sh` can be run directly without any setup. However, without adding it to
@ -217,11 +227,12 @@ k8s-lbry kubectl get svc nginx-ingress-controller -o wide
If you find a hostname instead of an IP address, this means your load balancer If you find a hostname instead of an IP address, this means your load balancer
has multiple IP addresses. In this case, you will need to resolve the domain has multiple IP addresses. In this case, you will need to resolve the domain
name to find the IP addresses. If this affects you, [paste the hostname into name to find the IP addresses. If this affects you, run `dig` with the hostname
this tool](https://toolbox.googleapps.com/apps/dig/). Look for the `;ANSWER` as the second argument. If your system does not have `dig` installed, you can
section and you should see two or more IP addresses listed. Since lbrycrd will [paste the hostname into this tool](https://toolbox.googleapps.com/apps/dig/).
only advertise one IP address, pick just one of the IP addresses to use for the Look for the `;ANSWER` section and you should see two or more IP addresses
purposes of this tutorial. listed. Since lbrycrd will only advertise one IP address, pick just one of the
IP addresses to use for the purposes of this tutorial.
You must edit your own `values-dev.yaml`. (The setup procedure created an You must edit your own `values-dev.yaml`. (The setup procedure created an
initial configuration in the same directory as `run.sh`.) To use a different initial configuration in the same directory as `run.sh`.) To use a different
@ -727,10 +738,13 @@ turned on out of the box. Setup is easy:
* Change `echo-http-server.hostname` to a hostname you've configured the DNS * Change `echo-http-server.hostname` to a hostname you've configured the DNS
for. for.
Upgrade nginx-ingress, turning on HTTPs support: Upgrade nginx-ingress, turning on HTTPs support (copy the command **including the wrapping parentheses**):
``` ```
NGINX_ENABLE_HTTPS=true k8s-lbry upgrade-nginx-ingress (
NGINX_ENABLE_HTTPS=true
k8s-lbry upgrade-nginx-ingress
)
``` ```
And Upgrade `k8s-lbry`: And Upgrade `k8s-lbry`:

View file

@ -1,47 +0,0 @@
# kick-ascii
A mobile-first responsive layout implemention of
[asciinema-player](https://github.com/asciinema/asciinema-player). Self host
your own ASCII theatre on the web.
[![asciicast](http://enigmacurry.github.io/kick-ascii/cast/index.jpg)](http://enigmacurry.github.io/kick-ascii/?cast=index&bg=matrix.jpg)
* Fork this repository on GitHub.
* Go to your new repository's Settings -> Options -> GitHub Pages -> Source ->
**choose master branch dropdown**
* Visit `http://USERNAME.github.io/kick-ascii` (change USERNAME to your github username or organization name.)
* Link to index.cast:
* [http://enigmacurry.github.io/kick-ascii](http://enigmacurry.github.io/kick-ascii)
* Link to a specific cast:
* [http://enigmacurry.github.io/kick-ascii/?cast=matrix](http://enigmacurry.github.io/kick-ascii/?cast=matrix)
* Specify a custom background image:
* [http://enigmacurry.github.io/kick-ascii/?cast=k8s-lbry&bg=lbry.png](http://enigmacurry.github.io/kick-ascii/?cast=k8s-lbry&bg=lbry.png)
* Choose a different playback speed:
* [http://enigmacurry.github.io/kick-ascii/?cast=k8s-lbry&bg=lbry.png&speed=3](http://enigmacurry.github.io/kick-ascii/?cast=k8s-lbry&bg=lbry.png&speed=3)
* Disable pre-loading, no autoplay, no loop:
* [http://enigmacurry.github.io/kick-ascii/?cast=matrix&autoplay=false&preload=false&loop=false](http://enigmacurry.github.io/kick-ascii/?cast=matrix&autoplay=false&preload=false&loop=false)
* Make new recordings with [asciinema](https://asciinema.org/).
* Put cast files and cover images in the `cast` directory.
* Put custom background images in the `img` directory.
* Commit your changes to git, and push to GitHub.
* Alternatively, upload this entire directory to any webhost. It's just a
static website.
## I can't click on the progress bar to jump around the timeline!
This is a feature of the upstream
[asciinema-player](https://github.com/asciinema/asciinema-player), however in
several instances of my testing, it has rendered the page entirely unresponsive.
It happens often enough that I've decided to make the progress bar non-clickable
(`pointer-events: none` in [asciinema-player.css](player/asciinema-player.css)).
The arrow keys are still enabled, and they serve the same function, to rewind
and fast forward. However, I would caution you to use this feature sparingly,
and not try to advance too many frames at once.