foster/monero-node-container
1
0
Fork 0
Code Issues Pull requests Packages 1 Activity

Update README.org information

Browse source
This commit is contained in:
Foster Hangdaan 2023-10-20 16:33:17 -04:00
parent 6443db0f7c
commit eaea613b4b
Signed by: foster
GPG key ID: E48D7F49A852F112
1 changed files with 7 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.org
View file

@ -1,21 +1,19 @@
#+title: Monero Node Container #+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 #+begin_quote
The examples in this document use the ~podman~ command. Just swap with the ~docker~ command if you are using Docker. The examples in this document use the ~podman~ command. Just swap with the ~docker~ command if you are using Docker.
#+end_quote #+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 * Usage
#+begin_quote #+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. *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
#+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.
#+end_quote #+end_quote
To run a container, use either ~podman run~ or define a service in a =compose.yaml= file. To run a container, use either ~podman run~ or define a service in a =compose.yaml= file.