Fix container access guide for podman and generalize (#539)

This commit is contained in:
kn0wmad
2023-11-10 17:10:24 +00:00
committed by GitHub
parent 0f5a6b336b
commit 59473a46f7
4 changed files with 33 additions and 27 deletions

View File

@@ -1,26 +0,0 @@
.. _bitcoin-cli:
===========
Bitcoin CLI
===========
Instructions for accessing the bitcoind service in order to issue commands directly.
.. warning:: This is an advanced feature and should be used with caution. Start9 is not responsible for any damage you might cause through SSH access.
#. First, you will need SSH access. Please see the :ref:`setup instructions <ssh>` for details.
#. Access your server and then you can interact with the bitcoind docker container using the following syntax:
.. code-block:: bash
sudo docker exec -ti bitcoind.embassy bitcoin-cli COMMAND
.. tip:: For example ``sudo docker exec -ti bitcoind.embassy bitcoin-cli getnetworkinfo``
A list of possible commands can be found `here <https://developer.bitcoin.org/reference/rpc/>`__.
You can also drop into a shell using::
sudo docker exec -ti bitcoind.embassy bash
and then enter ``bitcoin-cli`` commands. When you are finished, simply type ``exit``...

View File

@@ -10,5 +10,4 @@ These guides will help you to setup external tools to connect or interact with B
:maxdepth: 1
bitcoin-integrations
bitcoin-cli
blockchain-copy

View File

@@ -0,0 +1,32 @@
.. _container-access:
============================
Accessing Service Containers
============================
Instructions for accessing a service container directly, in order to perform advanced operations.
.. warning:: HERE BE DRAGONS!! This is an advanced feature and should be used with caution. If you continue, you are responsible for any damage you might cause. For general use, there is no need to enter a container, and you probably only want to do this if under the direction of a Start9 Support Technician.
#. First, you will need SSH access. Please see the :ref:`setup instructions <ssh>` for details.
#. Access your server via SSH and then you can interact with a service container using the following syntax:
.. code-block:: bash
sudo podman exec -it SERVICE-NAME COMMAND
Replace ``SERVICE-NAME`` and ``COMMAND`` with your service and desired commands. For example ``sudo podman exec -it bitcoind.embassy bitcoin-cli getnetworkinfo``
To find the currently available services, use the following command:
.. code-block:: bash
sudo podman ps --all
You can also drop into a shell using
.. code-block:: bash
sudo podman exec -it SERVICE-NAME bash
and then enter your service commands. When you are finished, simply type ``exit``.

View File

@@ -21,5 +21,6 @@ User Manual
updating
sessions
ssh
container-access
wifi
alt-registries