e8f6fa30d9
Closes #49 |
||
---|---|---|
.github | ||
chainquery | ||
contrib | ||
environment | ||
lbrycrd | ||
lbrynet | ||
persist | ||
.gitignore | ||
CONTRIBUTING.md | ||
LICENSE | ||
network-up.sh | ||
README.md |
lbry-Docker
Tags
Document tags and link to their Dockerfiles here.
Scope
This repository is in flux as it travels towards version 1.0; however its goal is to make development for and adoption of any of the LBRY appliances trivial. You should be able to clone pull fork your way to a better LBRY without having to do much more than some light reading of a README to get started.
Documentation is WIP
Currently, this repository is a WIP and is under heavy construction, use at your own risk make sure you keep regular backups of your wallets. Your mileage may vary as to how far this will work for you be sure to file good and concise issues if you plan to and be mindful of we're allergic to regressions when filing PRs.
Goals
This repository aims for Docker Best Practices minimalism, ephemerality, and statelessness. It will use well commented Shell scripts
, Dockerfiles, and Docker-Compose which is a template that is a baseline for many other container management services such as RancherOS and Kubernetes.
Beautiful Screenshot/Gif
Since there is nothing to see here just yet, I'll entertain you with the current state of affairs with this repository.
Installation
This is currently WIP and Not Recommended for Production See Running from source for the current instructions on how to use this.
Currently supported platforms
X86_64 CPU architecture Lbrynet, Lbrycrd, Chainqery are currently supported.
Some arm architectures
More will be added on request and over time
Usage
For now, I don't recommend using this container cluster however you're welcomed to contribute if you feel up to the task.
Running from source
Running this stuff from source should be possible if you have both Docker and docker-compose both installed. If these are both installed, you can proceed to run the following from within your development directory.
git clone https://github.com/lbryio/lbry-docker.git
Once you have a local copy of the recent source, you will want to consider what containers/applications you require in your environment. At the moment since at the writing of this documentation, this comes with an assertion of YMMV so if something isn't working feel free to make suggestions in the form of a PR for how we should do this better. The beauty of Open Source is learning better ways to do things as well as contributing to the world, so I'm always going to be welcoming to contributions.
From Source for Contributions
Running from source for contributing and Merge/Pull requests. My goal is to make contributing to this possible using Docker and also GitLab CI/CD time.
Contributing
Keep in mind I am preferential to receiving patches over rule-following as we can always nudge you in the right direction to get things more compatible with the project ethos if it's not. Never be afraid to file a PR no one should be offended. Having said this following the next two guides will greatly improve the speed at which we can integrate your improvements.
- Repository Standards
- Contribute
- Have an LBC wallet ready as we want you to have some for the help! Hell, why not post it in your Commit or Merge Request for all I care but take your tips!
Getting Support
Creating an Issue
Please be sure to fill out the issue template as best as possible. This will help us answer your questions faster and fix things quicker if we have quality reports.
License
This project is Licensed under the MIT License
Security
“We take security seriously. Please contact security@lbry.io regarding any security issues. Our PGP key is here if you need it.” LBRY is built primarily on top of proven technologies however if you find something that might increase the risk of someone losing their crypto currency Responsible Disclosure is always appreciated, however, that said, we're all open-source here.
Contact
- The primary contact for this project is @leopere feel free to reach out to leopere [ at ] nixc [ dot ] us
Additional Info and Links
- Install Docker
- Install docker-compose
- Email to security@lbry.io
- security@lbry.io's GPG Key
- Responsible Disclosure
- Issue Template
- Use Issue Search
- Repository Standards
- Global Contributing Standards
- CONTRIBUTING.md
- Project Status
- Running from source
- Docker Best Practices
- RancherOS
- Kubernetes
- Version 1.0 project board