joachim
/
openwebrx-clone
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

remove incomplete setup instructions and link to the wiki

This commit is contained in:
Jakob Ketterl 2020-03-05 20:53:47 +01:00
parent c2702e02a9
commit beb59da6a6
1 changed files with 6 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@ -19,58 +19,14 @@ It has the following features:
## Setup
### Raspberry Pi SD Card Images
The following methods of setting up a receiver are currently available:
Probably the quickest way to get started is to download the latest Raspberry Pi SD Card Image. It contains all the
depencencies out of the box, and should work on all Raspberry Pis. It is based off the Raspbian Lite distribution,
so [their installation instructions](https://www.raspberrypi.org/documentation/installation/installing-images/) apply.
- Raspberry Pi SD card images
- Debian repository
- Docker images
- Manual installation
You can find the latest images [here](https://s3.eu-central-1.amazonaws.com/de.dd5jfk.openwebrx/index.html). You can
also checkout the `nightly` folder, which has the most recent builds, albeit untested.
Once you have booted a Raspberry with the SD Card, it will appear in your network with the hostname "openwebrx", which
should make it available as https://openwebrx/ on most networks. This may vary depending on your specific setup.
For Digital voice, the minimum requirement right now seems to be a Rasbperry Pi 3B+. I would like to work on optimizing
this for lower specs, but at this point I am not sure how much can be done.
### Docker Images
For those familiar with docker, I am providing
[recent builds and Releases for both x86 and arm processors on the Docker hub](https://hub.docker.com/r/jketterl/openwebrx).
You can find a short introduction there.
### Manual Installation
OpenWebRX currently requires Linux and python >= 3.6 to run.
First you will need to install the dependencies:
- [csdr](https://github.com/jketterl/csdr)
- [rtl-sdr](http://sdr.osmocom.org/trac/wiki/rtl-sdr)
- [owrx_connector](https://github.com/jketterl/owrx_connector)
Optional dependencies if you want to be able to listen do digital voice:
- [digiham](https://github.com/jketterl/digiham)
- [dsd](https://github.com/f4exb/dsdcc)
Optional dependency if you want to decode WSJT-X modes:
- [wsjt-x](https://physics.princeton.edu/pulsar/k1jt/wsjtx.html)
[Detailed installation instructions in the Wiki](https://github.com/jketterl/openwebrx/wiki/Manual-Package-installation-(including-digital-voice))
After cloning this repository and connecting an RTL-SDR dongle to your computer, you can run the server:
./openwebrx.py
You can now open the GUI at <a href="http://localhost:8073">http://localhost:8073</a>.
Now the next step is to customize the parameters of your server in `config_webrx.py`.
Actually, if you do something cool with OpenWebRX, please drop me a mail:
*Jakob Ketterl, DD5JFK &lt;dd5jfk@darc.de&gt;*
Please checkout the [setup guide on the wiki](https://github.com/jketterl/openwebrx/wiki/Setup-Guide) for more details on the respective methods.
## Usage tips