This document covers the current state of the Docker built image. It enumerates the known issues, todo lists, etc...
See RELEASE.md for more details.
- v1.0.0 Docker Image
See the README.Docker.md for more information on basic operation using Docker.
docker run --rm -v ~/.shinysdr:/config jeffersonjhunt/shinysdr init /config/my-config
docker run --rm -p 8100:8100 -p 8101:8101 -v ~/.shinysdr:/config jeffersonjhunt/shinysdr start /config/my-config
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.
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
The Dockerfile
is broken into server RUN sections to allow for quicker builds while adding and refining modules, plugins, supporting apps and new versions of ShinySDR.
This tool uses wget to retrieve files and needs to be switched out for curl (personal preference) to remove the dependency from the Dockerfile.
TODO: Integrate fetch-js-deps or equivalent effects into setup.py
There are old and missing Python modules that require the following modules be added before starting ShinySDR:
- pip install --upgrade service_identity
- pip install --upgrade pyasn1-modules
The following optional plugins/modules are being added. The table tracks the current status, source, etc...
Plugin/Module | Status | Notes |
---|---|---|
python-libhamlib2 | complete | Controlling external hardware radios |
gr-air-modes | complete | ADS-B, aircraft transponders |
gr-radioteletype | todo | RTTY and PSK31 |
wsjtx | partial | WSPR weak-signal radio |
multimon-ng | todo | decodes digital transmission modes |
rtl_433 | todo | Miscellaneous telemetry |
gr-dsd | todo | Digital voice modes supported by DSD |
this list is no doubt incomplete and other modules/plugins will be added as time permits