Skip to content

Latest commit

 

History

History
102 lines (71 loc) · 3.47 KB

README.md

File metadata and controls

102 lines (71 loc) · 3.47 KB
Raw

Readme

This document covers the current state of the Docker built image. It enumerates the known issues, todo lists, etc...

Releases

See RELEASE.md for more details.

Basics

See the README.Docker.md for more information on basic operation using Docker.

Single Board Computers (SBC) like the Raspberry Pi and NVIDIA Jetson Nano are supported via Docker with specific guides located here.

Init

$ docker run --rm -v ~/.shinysdr:/config jeffersonjhunt/shinysdr init /config/my-config

Run

$ docker run --rm -p 8100:8100 -p 8101:8101 -v ~/.shinysdr:/config jeffersonjhunt/shinysdr start /config/my-config

Config & Control

Entrypoint script

The shinysdr-entrypoint.sh is used to simplify the interaction of Docker with ShinySDR. Docker passes in any additional arguments to the run command to the entrypoint. This allows the end user to create the default config using the ShinySDR tooling when one does not exist.

Examples

init my-config:

$ shinysdr-entrypoint.sh -d -i init /my-config

init my-config using Docker:

$ docker run --rm -v ~/.shinysdr:/config jeffersonjhunt/shinysdr init /config/my-config

start with my-config:

$ shinysdr-entrypoint.sh -d -i start /my-config

start with my-config using Docker:

$ docker run --rm -p 8100:8100 -p 8101:8101 -v ~/.shinysdr:/config --name shinysdr jeffersonjhunt/shinysdr start /config/my-config

stop:

$ shinysdr-entrypoint.sh -d -i stop

stop using Docker:

$ docker exec shinysdr shinysdr-entrypoint.sh stop

or

$ docker stop shinysdr

Build Notes

Dockerfile

Structure

The Dockerfile is broken into several RUN sections to allow for quicker builds while adding and refining modules, plugins, supporting apps and new versions of ShinySDR.

Build

See: BUILD.md for complete details on building, debugging and packaging.

Plugins/Modules

The following optional plugins/modules are being added. The table tracks the current status, source, etc...

Plugin/Module Status Version Notes
hamlib complete latest** Controlling external hardware radios
gr-air-modes complete latest* ADS-B, aircraft transponders
gr-radioteletype complete latest* RTTY and PSK31 w/ARM patches
wsjtx complete 2.1.2 WSPR weak-signal radio
multimon-ng complete latest* decodes digital transmission modes
rtl_433 complete 20.02 Miscellaneous telemetry
gr-dsd complete latest* Digital voice modes supported by DSD
SoapySDR complete 0.7.2 Vendor/platform neutral SDR library

* master as of build date ** patched version from wsjtx

this list is no doubt incomplete and other modules/plugins will be added as time permits