Code Monkey home page Code Monkey logo

shinysdr-docker's Introduction

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.

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 server RUN sections to allow for quicker builds while adding and refining modules, plugins, supporting apps and new versions of ShinySDR.

fetch-js-deps.sh

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

Python

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

Plugins/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

shinysdr-docker's People

Contributors

jeffersonjhunt avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.