ub1zcb
/
openwebrx
mirror of https://github.com/jketterl/openwebrx.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update bookmarks documentation

Jakob Ketterl 2021-04-22 00:56:43 +02:00
parent dc1dcaa9bf
commit 00ad0f8e98
1 changed files with 4 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
How-the-bookmarks-work.md

@ -1,4 +1,4 @@
Bookmarks (sometimes also referred to as markers) have been introduced to allow quick tuning of predefined frequencies, and as a way to allow users to qickly identify transmissions without the need to be familiar with the receiver's location and HF circumstances. Bookmarks (sometimes also referred to as markers) have been introduced to allow quick tuning of predefined frequencies, and as a way to allow users to qickly identify transmissions without the need to be familiar with the receiver's location and HF environment.
[[images/bookmarks.png]] [[images/bookmarks.png]]
@ -6,8 +6,8 @@ They're the little colored "bubbles" that show up above the frequency bar on the
* Bandplan frequencies (FT8 & co) in green, common amongst all users. Some specific modes have been tied in to specific frequencies, these are kept in the bandplan (`bands.json`) and are subject to little changes over time. The bandplan can be modified by the receiver operator. * Bandplan frequencies (FT8 & co) in green, common amongst all users. Some specific modes have been tied in to specific frequencies, these are kept in the bandplan (`bands.json`) and are subject to little changes over time. The bandplan can be modified by the receiver operator.
* Server-side bookmarks in yellow, common amongst all users. These are the classic bookmarks where you'd put your repeaters and radio stations. They are kept in a file named `bookmarks.json` which can be modified by the receiver operator. * Server-side bookmarks in yellow, common amongst all users. These are the classic bookmarks where you'd put your repeaters and radio stations. They can be modified in the settings area by the receiver operator.
* Client-side bookmarks in light blue, local to the current user. These bookmarks can be created using the bookmark button on the receiver panel and are stored in the browser's localstorage. They are not sent back to the receiver, and cannot be shared with other users. * Client-side bookmarks in light blue, local to the current user. These bookmarks can be created using the bookmark button on the receiver panel and are stored in the browser's localstorage. They are not sent back to the receiver, and cannot be shared with other users.
[[images/bookmark-button.png]] [[images/bookmark-button.png]]
@ -16,28 +16,4 @@ They're the little colored "bubbles" that show up above the frequency bar on the
## Defaults ## Defaults
When you first start the receiver, you may see some unrelated and strange bookmarks already in there. Those are the ones I collected on my development receiver, consider them examples. Of course you can replace them. Starting with OpenWebRX 1.0, no more example bookmarks are installed with the receiver. You can define your own in the web-based settings area of the receiver.
## Digimode bookmarks
The only way to have bookmarks that automatically enable the corresponding digimode decoder is by entering them into the bandplan, there's no support for those modes in the other sources. This is due to separate archictectures, and will be changed in the future.
## File location
The location of each of the files mentioned varies with the type of setup. In most cases, they should be kept in `/etc/openwebrx/`. If you have setup your receiver from source, the files will be located in the checkout folder, but it is recommended that you copy them over to `/etc/openwebrx/` and maintain your changes there. You will probably need to create the directory initially.
## File location when using docker
If you are running OpenWebRX inside a docker container, the file will be kept in `/etc/openwebrx/` as well, but that is in the container's filesystem. In order to maintain this file, you can mount a volume or directory into this location and then edit the files there. The docker container will copy its initial files to that location if it doesn't find anything on startup.
* Directory mount: `-v /my/local/directory:/etc/openwebrx` - you will find the files in `/my/local/directory` after the first run. For consistency, you can use `-f /etc/openwebrx:/etc/openwebrx` - that way your files will be in `/etc/openwebrx` on the host and inside the container. You will probably need to create the local directory first.
* Volume mount: `-v openwebrx-config:/etc/openwebrx` - you can find out where the files are stored on your local filesystem by running `docker volume inspect openwebrx-config`, they are usually under `/var/lib/docker/volumes/openwebrx-config/_data`. You will probably need to create the volume beforehand: `docker volume create openwebrx-config`
## A note about editing the files
Please be very careful when editing the files. The json format is pretty sensitive to missing quotations, commas and other syntax errors. There is no partial parsing, so the if there's an error in any of the files, you will not have any bookmarks at all.
You can use online syntax validators like [JSONLint](https://jsonlint.com/) to validate the syntax.
Please do not recommend other file formats to the authors. This is an intermediate solution until a frontend to edit the information contained in these files has been built.