From eaea613b4bbeae946615b87f49388b6a245514fd Mon Sep 17 00:00:00 2001 From: Foster Hangdaan Date: Fri, 20 Oct 2023 16:33:17 -0400 Subject: [PATCH] Update README.org information --- README.org | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.org b/README.org index 0a7afcb..60ee476 100644 --- a/README.org +++ b/README.org @@ -1,21 +1,19 @@ #+title: Monero Node Container -* About - -This project builds images of [[https://github.com/monero-project/monero][Monero CLI]] for use as Podman or Docker containers. - #+begin_quote The examples in this document use the ~podman~ command. Just swap with the ~docker~ command if you are using Docker. #+end_quote +* About + +This project aims to simplify the process hosting a Monero node. Use either [[https://podman.io/][Podman]] or [[https://www.docker.com/][Docker]] to deploy the containerized [[https://github.com/monero-project/monero][Monero CLI]] images. + +See the [[https://code.fosterhangdaan.com/foster/-/packages/container/monero-node-container][container registry]] for the latest image and [[https://code.fosterhangdaan.com/foster/-/packages/container/monero-node-container/versions][available versions]]. + * Usage #+begin_quote -*IMPORTANT:* It is recommended that you pin the image using the major version tags (ie. =0.17=, =0.18=). This way, a manual change is required before updating the service to the next major version. You can use this time to make backups in case something goes wrong. -#+end_quote - -#+begin_quote -The =latest= tag always points to the latest version. So it has a higher chance of introducing a breaking change by accident. Only use =latest= if you like living on the edge. +*IMPORTANT:* Since the =latest= tag has a high chance of introducing a breaking change, it is recommended that you pin the image using the major version tags (ie. =0.17=, =0.18=). This way, a manual change is required to update to the next major version. Use this opportunity to make backups in case something goes wrong. #+end_quote To run a container, use either ~podman run~ or define a service in a =compose.yaml= file.