mirror of
https://github.com/craigerl/aprsd.git
synced 2024-11-25 09:28:38 -05:00
Updated README docs
This patch updates the 2 readme files with copies for the latest sample-config output to match the 1.6.0 release's config. Also fixed a small issue with the Dockerfile.
This commit is contained in:
parent
a266c987fd
commit
b6ba90de53
120
README.rst
120
README.rst
@ -161,40 +161,77 @@ Output
|
|||||||
└─[$] > aprsd sample-config
|
└─[$] > aprsd sample-config
|
||||||
|
|
||||||
aprs:
|
aprs:
|
||||||
host: rotate.aprs.net
|
# Get the passcode for your callsign here:
|
||||||
logfile: /tmp/arsd.log
|
# https://apps.magicbug.co.uk/passcode
|
||||||
login: someusername
|
host: rotate.aprs2.net
|
||||||
password: somepassword
|
login: CALLSIGN
|
||||||
port: 14580
|
password: '00000'
|
||||||
|
port: 14580
|
||||||
aprsd:
|
aprsd:
|
||||||
enabled_plugins:
|
email:
|
||||||
- aprsd.plugin.EmailPlugin
|
enabled: true
|
||||||
- aprsd.plugin.FortunePlugin
|
imap:
|
||||||
- aprsd.plugin.LocationPlugin
|
debug: false
|
||||||
- aprsd.plugin.PingPlugin
|
host: imap.gmail.com
|
||||||
- aprsd.plugin.TimePlugin
|
login: IMAP_USERNAME
|
||||||
- aprsd.plugin.WeatherPlugin
|
password: IMAP_PASSWORD
|
||||||
- aprsd.plugin.VersionPlugin
|
port: 993
|
||||||
plugin_dir: ~/.config/aprsd/plugins
|
use_ssl: true
|
||||||
|
shortcuts:
|
||||||
|
aa: 5551239999@vtext.com
|
||||||
|
cl: craiglamparter@somedomain.org
|
||||||
|
wb: 555309@vtext.com
|
||||||
|
smtp:
|
||||||
|
debug: false
|
||||||
|
host: smtp.gmail.com
|
||||||
|
login: SMTP_USERNAME
|
||||||
|
password: SMTP_PASSWORD
|
||||||
|
port: 465
|
||||||
|
use_ssl: false
|
||||||
|
enabled_plugins:
|
||||||
|
- aprsd.plugins.email.EmailPlugin
|
||||||
|
- aprsd.plugins.fortune.FortunePlugin
|
||||||
|
- aprsd.plugins.location.LocationPlugin
|
||||||
|
- aprsd.plugins.ping.PingPlugin
|
||||||
|
- aprsd.plugins.query.QueryPlugin
|
||||||
|
- aprsd.plugins.time.TimePlugin
|
||||||
|
- aprsd.plugins.weather.USWeatherPlugin
|
||||||
|
- aprsd.plugins.version.VersionPlugin
|
||||||
|
logfile: /tmp/aprsd.log
|
||||||
|
plugin_dir: ~/.config/aprsd/plugins
|
||||||
|
trace: false
|
||||||
|
units: imperial
|
||||||
|
web:
|
||||||
|
enabled: true
|
||||||
|
host: 0.0.0.0
|
||||||
|
port: 8001
|
||||||
|
users:
|
||||||
|
admin: aprsd
|
||||||
ham:
|
ham:
|
||||||
callsign: KFART
|
callsign: CALLSIGN
|
||||||
imap:
|
services:
|
||||||
host: imap.gmail.com
|
aprs.fi:
|
||||||
login: imapuser
|
# Get the apiKey from your aprs.fi account here:
|
||||||
password: something here too
|
# http://aprs.fi/account
|
||||||
port: 993
|
apiKey: APIKEYVALUE
|
||||||
use_ssl: true
|
avwx:
|
||||||
shortcuts:
|
# (Optional for AVWXWeatherPlugin)
|
||||||
aa: 5551239999@vtext.com
|
# Use hosted avwx-api here: https://avwx.rest
|
||||||
cl: craiglamparter@somedomain.org
|
# or deploy your own from here:
|
||||||
wb: 555309@vtext.com
|
# https://github.com/avwx-rest/avwx-api
|
||||||
smtp:
|
apiKey: APIKEYVALUE
|
||||||
host: imap.gmail.com
|
base_url: http://host:port
|
||||||
login: something
|
opencagedata:
|
||||||
password: some lame password
|
# (Optional for TimeOpenCageDataPlugin)
|
||||||
port: 465
|
# Get the apiKey from your opencagedata account here:
|
||||||
use_ssl: false
|
# https://opencagedata.com/dashboard#api-keys
|
||||||
|
apiKey: APIKEYVALUE
|
||||||
|
openweathermap:
|
||||||
|
# (Optional for OWMWeatherPlugin)
|
||||||
|
# Get the apiKey from your
|
||||||
|
# openweathermap account here:
|
||||||
|
# https://home.openweathermap.org/api_keys
|
||||||
|
apiKey: APIKEYVALUE
|
||||||
|
|
||||||
server
|
server
|
||||||
======
|
======
|
||||||
@ -212,7 +249,7 @@ look for incomming commands to the callsign configured in the config file
|
|||||||
Options:
|
Options:
|
||||||
--loglevel [CRITICAL|ERROR|WARNING|INFO|DEBUG]
|
--loglevel [CRITICAL|ERROR|WARNING|INFO|DEBUG]
|
||||||
The log level to use for aprsd.log
|
The log level to use for aprsd.log
|
||||||
[default: DEBUG]
|
[default: INFO]
|
||||||
|
|
||||||
--quiet Don't log to stdout
|
--quiet Don't log to stdout
|
||||||
--disable-validation Disable email shortcut validation. Bad
|
--disable-validation Disable email shortcut validation. Bad
|
||||||
@ -220,15 +257,20 @@ look for incomming commands to the callsign configured in the config file
|
|||||||
responses!!
|
responses!!
|
||||||
|
|
||||||
-c, --config TEXT The aprsd config file to use for options.
|
-c, --config TEXT The aprsd config file to use for options.
|
||||||
[default: ~/.config/aprsd/aprsd.yml]
|
[default:
|
||||||
|
/home/waboring/.config/aprsd/aprsd.yml]
|
||||||
|
|
||||||
|
-f, --flush Flush out all old aged messages on disk.
|
||||||
|
[default: False]
|
||||||
|
|
||||||
-h, --help Show this message and exit.
|
-h, --help Show this message and exit.
|
||||||
(.venv3) ┌─[waboring@dl360-1] - [~/devel/aprsd] - [Sun Dec 20, 12:32] -
|
|
||||||
└─[$] <git:(master*)> aprsd server
|
$ aprsd server
|
||||||
Load config
|
Load config
|
||||||
[12/20/2020 12:33:03 PM] [MainThread ] [INFO ] APRSD Started version: 1.0.2
|
[02/13/2021 09:22:09 AM] [MainThread ] [INFO ] APRSD Started version: 1.6.0
|
||||||
[12/20/2020 12:33:03 PM] [MainThread ] [INFO ] Checking IMAP configuration
|
[02/13/2021 09:22:09 AM] [MainThread ] [INFO ] Checking IMAP configuration
|
||||||
[12/20/2020 12:33:04 PM] [MainThread ] [INFO ] Checking SMTP configuration
|
[02/13/2021 09:22:09 AM] [MainThread ] [INFO ] Checking SMTP configuration
|
||||||
|
[02/13/2021 09:22:10 AM] [MainThread ] [INFO ] Validating 2 Email shortcuts. This can take up to 10 seconds per shortcut
|
||||||
|
|
||||||
|
|
||||||
send-message
|
send-message
|
||||||
|
|||||||
@ -39,6 +39,7 @@ RUN git clone -b $APRSD_BRANCH $APRSD $INSTALL/aprsd
|
|||||||
RUN cd $INSTALL/aprsd && pip3 install .
|
RUN cd $INSTALL/aprsd && pip3 install .
|
||||||
RUN which aprsd
|
RUN which aprsd
|
||||||
USER root
|
USER root
|
||||||
|
RUN mkdir /config
|
||||||
RUN aprsd sample-config > /config/aprsd.yml
|
RUN aprsd sample-config > /config/aprsd.yml
|
||||||
RUN chown -R $APRS_USER:$APRS_USER /config
|
RUN chown -R $APRS_USER:$APRS_USER /config
|
||||||
|
|
||||||
|
|||||||
120
docs/readme.rst
120
docs/readme.rst
@ -160,40 +160,77 @@ Output
|
|||||||
└─[$] > aprsd sample-config
|
└─[$] > aprsd sample-config
|
||||||
|
|
||||||
aprs:
|
aprs:
|
||||||
host: rotate.aprs.net
|
# Get the passcode for your callsign here:
|
||||||
logfile: /tmp/arsd.log
|
# https://apps.magicbug.co.uk/passcode
|
||||||
login: someusername
|
host: rotate.aprs2.net
|
||||||
password: somepassword
|
login: CALLSIGN
|
||||||
port: 14580
|
password: '00000'
|
||||||
|
port: 14580
|
||||||
aprsd:
|
aprsd:
|
||||||
enabled_plugins:
|
email:
|
||||||
- aprsd.plugin.EmailPlugin
|
enabled: true
|
||||||
- aprsd.plugin.FortunePlugin
|
imap:
|
||||||
- aprsd.plugin.LocationPlugin
|
debug: false
|
||||||
- aprsd.plugin.PingPlugin
|
host: imap.gmail.com
|
||||||
- aprsd.plugin.TimePlugin
|
login: IMAP_USERNAME
|
||||||
- aprsd.plugin.WeatherPlugin
|
password: IMAP_PASSWORD
|
||||||
- aprsd.plugin.VersionPlugin
|
port: 993
|
||||||
plugin_dir: ~/.config/aprsd/plugins
|
use_ssl: true
|
||||||
|
shortcuts:
|
||||||
|
aa: 5551239999@vtext.com
|
||||||
|
cl: craiglamparter@somedomain.org
|
||||||
|
wb: 555309@vtext.com
|
||||||
|
smtp:
|
||||||
|
debug: false
|
||||||
|
host: smtp.gmail.com
|
||||||
|
login: SMTP_USERNAME
|
||||||
|
password: SMTP_PASSWORD
|
||||||
|
port: 465
|
||||||
|
use_ssl: false
|
||||||
|
enabled_plugins:
|
||||||
|
- aprsd.plugins.email.EmailPlugin
|
||||||
|
- aprsd.plugins.fortune.FortunePlugin
|
||||||
|
- aprsd.plugins.location.LocationPlugin
|
||||||
|
- aprsd.plugins.ping.PingPlugin
|
||||||
|
- aprsd.plugins.query.QueryPlugin
|
||||||
|
- aprsd.plugins.time.TimePlugin
|
||||||
|
- aprsd.plugins.weather.USWeatherPlugin
|
||||||
|
- aprsd.plugins.version.VersionPlugin
|
||||||
|
logfile: /tmp/aprsd.log
|
||||||
|
plugin_dir: ~/.config/aprsd/plugins
|
||||||
|
trace: false
|
||||||
|
units: imperial
|
||||||
|
web:
|
||||||
|
enabled: true
|
||||||
|
host: 0.0.0.0
|
||||||
|
port: 8001
|
||||||
|
users:
|
||||||
|
admin: aprsd
|
||||||
ham:
|
ham:
|
||||||
callsign: KFART
|
callsign: CALLSIGN
|
||||||
imap:
|
services:
|
||||||
host: imap.gmail.com
|
aprs.fi:
|
||||||
login: imapuser
|
# Get the apiKey from your aprs.fi account here:
|
||||||
password: something here too
|
# http://aprs.fi/account
|
||||||
port: 993
|
apiKey: APIKEYVALUE
|
||||||
use_ssl: true
|
avwx:
|
||||||
shortcuts:
|
# (Optional for AVWXWeatherPlugin)
|
||||||
aa: 5551239999@vtext.com
|
# Use hosted avwx-api here: https://avwx.rest
|
||||||
cl: craiglamparter@somedomain.org
|
# or deploy your own from here:
|
||||||
wb: 555309@vtext.com
|
# https://github.com/avwx-rest/avwx-api
|
||||||
smtp:
|
apiKey: APIKEYVALUE
|
||||||
host: imap.gmail.com
|
base_url: http://host:port
|
||||||
login: something
|
opencagedata:
|
||||||
password: some lame password
|
# (Optional for TimeOpenCageDataPlugin)
|
||||||
port: 465
|
# Get the apiKey from your opencagedata account here:
|
||||||
use_ssl: false
|
# https://opencagedata.com/dashboard#api-keys
|
||||||
|
apiKey: APIKEYVALUE
|
||||||
|
openweathermap:
|
||||||
|
# (Optional for OWMWeatherPlugin)
|
||||||
|
# Get the apiKey from your
|
||||||
|
# openweathermap account here:
|
||||||
|
# https://home.openweathermap.org/api_keys
|
||||||
|
apiKey: APIKEYVALUE
|
||||||
|
|
||||||
server
|
server
|
||||||
------
|
------
|
||||||
@ -211,7 +248,7 @@ look for incomming commands to the callsign configured in the config file
|
|||||||
Options:
|
Options:
|
||||||
--loglevel [CRITICAL|ERROR|WARNING|INFO|DEBUG]
|
--loglevel [CRITICAL|ERROR|WARNING|INFO|DEBUG]
|
||||||
The log level to use for aprsd.log
|
The log level to use for aprsd.log
|
||||||
[default: DEBUG]
|
[default: INFO]
|
||||||
|
|
||||||
--quiet Don't log to stdout
|
--quiet Don't log to stdout
|
||||||
--disable-validation Disable email shortcut validation. Bad
|
--disable-validation Disable email shortcut validation. Bad
|
||||||
@ -219,15 +256,20 @@ look for incomming commands to the callsign configured in the config file
|
|||||||
responses!!
|
responses!!
|
||||||
|
|
||||||
-c, --config TEXT The aprsd config file to use for options.
|
-c, --config TEXT The aprsd config file to use for options.
|
||||||
[default: ~/.config/aprsd/aprsd.yml]
|
[default:
|
||||||
|
/home/waboring/.config/aprsd/aprsd.yml]
|
||||||
|
|
||||||
|
-f, --flush Flush out all old aged messages on disk.
|
||||||
|
[default: False]
|
||||||
|
|
||||||
-h, --help Show this message and exit.
|
-h, --help Show this message and exit.
|
||||||
(.venv3) ┌─[waboring@dl360-1] - [~/devel/aprsd] - [Sun Dec 20, 12:32] -
|
|
||||||
└─[$] <git:(master*)> aprsd server
|
$ aprsd server
|
||||||
Load config
|
Load config
|
||||||
[12/20/2020 12:33:03 PM] [MainThread ] [INFO ] APRSD Started version: 1.0.2
|
[02/13/2021 09:22:09 AM] [MainThread ] [INFO ] APRSD Started version: 1.6.0
|
||||||
[12/20/2020 12:33:03 PM] [MainThread ] [INFO ] Checking IMAP configuration
|
[02/13/2021 09:22:09 AM] [MainThread ] [INFO ] Checking IMAP configuration
|
||||||
[12/20/2020 12:33:04 PM] [MainThread ] [INFO ] Checking SMTP configuration
|
[02/13/2021 09:22:09 AM] [MainThread ] [INFO ] Checking SMTP configuration
|
||||||
|
[02/13/2021 09:22:10 AM] [MainThread ] [INFO ] Validating 2 Email shortcuts. This can take up to 10 seconds per shortcut
|
||||||
|
|
||||||
|
|
||||||
send-message
|
send-message
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user