hueso/vls-container
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: remove v1 compatibility

Browse Source 
- update ci for submount feature
- update versions
Signed-off-by: Lakshya Singh <lakshay.singh1108@gmail.com>
This commit is contained in:
Lakshya Singh 2024-08-27 00:52:01 +05:30
parent 8ca100078a
commit 43eaa9c8d3
No known key found for this signature in database
GPG Key ID: 6491470634BAE613
2 changed files with 7 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitlab-ci.yml
View File

@ -3,9 +3,9 @@ stages:
- test
default:
image: docker:24.0.7
image: docker:26.0.1
services:
- docker:24.0.7-dind
- docker:26.0.1-dind
before_script:
- docker version
- docker compose version

29
README.md
View File

@ -9,26 +9,7 @@ Docker Engine is available on a variety of Linux distros, macOS, and Windows 10
- [Ubuntu](https://docs.docker.com/engine/install/ubuntu/)
- [Fedora](https://docs.docker.com/engine/install/fedora/)
### Distro Packages
Debian/Ubuntu:
```
sudo apt install docker.io docker-doc docker-compose containerd runc
sudo systemctl enable --now docker
```
Fedora/RHEL:
```
sudo dnf install docker docker-compose containerd runc
sudo systemctl enable --now docker
```
### Docker v1/v2 Compatibility
- Currently available `docker-compose` packages in different linux distributions (debian, ubuntu, fedora, etc) are not up to date, they are still at version `1` which has been deprecated by `docker` with release of version `2`.
- `docker-compose` version `2` is available through official docker repositories not the distribution ones.
- Docker Compose files in this repository work with version 2 and are also __backward compatible__ with version 1.
- If you are using the distribution installation the `docker compose` command used below has to be changed to `docker-compose` instead.
**Note**: The compose files present within this repository make use of docker compose v2 the minimum supported version is `v2.26.0`.
## VLS standalone Setup
@ -84,7 +65,7 @@ export TXOO_PUBLIC_KEY=$TXOO_PUBLIC_KEY
docker compose up
```
**_Note_**: Make sure to set `BITCOIND_RPC_URL` and `CLN_RMEOTE_HSMD_URL` as either environment variables or in the `docker-compose.yml` file before running the above command.
**_Note_**: Make sure to set `BITCOIND_RPC_URL` and `CLN_REMOTE_HSMD_URL` as either environment variables or in the `docker-compose.yml` file before running the above command.
If you wish to run it as a standalone container without using `docker compose` you can use the following command:
@ -237,8 +218,8 @@ docker compose --profile vls down
The currently set default versions for services is as follows in the [.env](.env) file:
- **Bitcoin Core**: v26.0
- **Core Lightning**: v24.02.2
- **TXOO**: v0.6.4
- **VLS**: v0.11.0
- **TXOO**: v0.8.1
- **VLS**: v0.12.0
You just can switch to a particular version/commit for a service by updating the git hash and then rebuilding the service:
```bash
@ -262,7 +243,7 @@ Note: For `bitcoind` its also important to update the `BITCOIN_SHA256SUMS_HASH`.
- [x] Profile configuration to run `vls`
- [x] Healthcheck for `txoo`
- [x] Healthcheck for `vls`
- [ ] Lightning Storage Server Dockerfile and Compose Service
- [x] Lightning Storage Server Dockerfile and Compose Service
- [ ] Postgres Service for Lightning Storage Server
## References