diff --git a/source/getting-started/running_image.rst b/source/getting-started/running_image.rst index cef8fda..4c04b86 100644 --- a/source/getting-started/running_image.rst +++ b/source/getting-started/running_image.rst @@ -95,4 +95,23 @@ To run a specific command when starting a new container, you can use ``-e`` argu .. code-block:: bash - rfswift run -i penthertz/rfswift:sdr_full -e sdrpp \ No newline at end of file + rfswift run -i penthertz/rfswift:sdr_full -e sdrpp + + + +Getting the sound +'''''''''''''''''' + +Some applications may require ``pulseaudio`` to be running. +To avoid any specific configuration for each plateform (Windows, macOS, Linux), we recommended to use ``pulseaudio`` in TCP with a defined port. + +After we can use the ``PULSE_SERVER`` environment variable to tell to our program we are launching such as ``gqrx`` for example: + + +.. code-block:: bash + + PULSE_SERVER=tcp::34567 gqrx + +.. tip:: + + This step is manual but will be automated in next version of the ``rfswift`` tool. \ No newline at end of file diff --git a/source/index.rst b/source/index.rst index 9f6cd63..60a90b8 100644 --- a/source/index.rst +++ b/source/index.rst @@ -49,8 +49,8 @@ The RF Swift project RF Swift includes different components to make RF hobbists, students/learners, professionnals, RF hackers, bug hunters' life easy. -* :doc:`Go wrapper `: instruments containers and hosts to simplify the use of tools that may require internet connectivity, display, sounds, USB accesses. This `rfswift` is the main program you will interact with to run clean containers, execute inside running or paused containers, and do many magic actions that will make things work without headache. -* :doc:`Docker images `: some pre-built Docker container images are available in RF Swift's repository. In case you wan to bake your own environment, preserve some spaces, and have a special set-up, you will also find some Docker files you can edit to fit your expectations. +* Go wrapper: instruments containers and hosts to simplify the use of tools that may require internet connectivity, display, sounds, USB accesses. This `rfswift` is the main program you will interact with to run clean containers, execute inside running or paused containers, and do many magic actions that will make things work without headache. +* Docker images: some pre-built Docker container images are available in RF Swift's repository. In case you wan to bake your own environment, preserve some spaces, and have a special set-up, you will also find some Docker files you can edit to fit your expectations. How to begin?