Differences

This shows you the differences between two versions of the page.

--- code:vxmppb:install:npm [2022/04/16 11:31] – stephen
+++ code:vxmppb:install:npm [2023/12/14 17:08] (current) – stephen
@@ Line 1: / Line 1: @@
-====== How To Install vXMPPb using NPM ======
+====== VXMPPB ======
+=== NPM ===
 [[code:vxmppb:install:start|..]]
 ----
@@ Line 28: / Line 28: @@
 ----
 ===== General Bot Configuration =====
+[[config|See here]]
-=== api_pass ===
-Basic Auth password set in api.php
-=== api_url ===
-If you would like to install the API to keep track of unlocks, please [[code:vxmppb:api-setup|see here]].
-=== api_user ===
-Basic Auth user set in api.php
-=== asterisk_callfrom ===
-Number to originate the call from
-=== asterisk_callto ===
-Number to call to
-=== asterisk_callerID ===
-Caller ID information to display to user
-=== asterisk_context ===
-Context from which Asterisk will originate it's calls
-=== asterisk_host ===
-Hostname for Asterisk AMI
-=== asterisk_password ===
-Password for AMI user
-=== asterisk_port ===
-Port number to contact the AMI at
-=== asterisk_user ===
-Username for AMI
-=== bot_hostname ===
-Hostname for XMPP bot ((Just in case SRV fails))
-=== bot_jid ===
-The JID the bot will use to send and recieve messages.\\
-=== bot_password ===
-The bot's password\\
-=== city_code ===
-This is for weather updates. To find your city code visit <html><a href="https://openweathermap.org/find?q=">this page</a></html>.\\
-Once you've found the correct location, check the URL bar. The numbers at the end are your city code.\\
-Place them in your config.ini, under the city_code option.
-=== city_name ===
-Enter the city you intend to get weather updates for.
-=== gotify_api_key ===
-Gotify API key to send push notifications
-=== gotify_message ===
-Push notification message
-=== gotify_priority ===
-Gotify priority
-=== gotify_title ===
-Push notification title
-=== gotify_url ===
-URL which the Gotify API can be reached
-=== mastodon_token ===
-Token for mastodon account
-=== mastodon_toot ===
-Toot to send once the bot is online. ((More options coming soon))
-=== mastodon_url ===
-Server to query API requests at.
-=== mqtt_message ===
-Message MQTT should send on successful connect. ((More options coming soon))
-=== mqtt_password ===
-Password for MQTT user ((If applicable))
-=== mqtt_server ===
-Server to use (example.com:1883)
-=== mqtt_topic ===
-MQTT topic to publish to
-=== mqtt_user ===
-MQTT username for authentication ((If applicable))
-----
-<WRAP center round info 60%>
-Scripts for TuyaAPI will be posted in a separate repository
-</WRAP>
-=== tuya_name ===
-Name of device to control ((Multi-device coming...soon...ish))
-=== tuya_status_url ===
-URL to check lights status
-=== tuya_toggle_url ===
-URL to toggle lights status
-----
-=== user_jid ===
-This person will receive a message when the bot is online, as well as ping requests. \\
-All other users not included in this list will get install instrucions (This page...)
-=== user_name ===
-This will eventually be pulled from the users vCard. For now, this will be used in the ping command. It may also be included in any other future commands where the bots admin's name must be displayed.\\
-== weather_api_key ==
-Sign up <html><a href="https://home.openweathermap.org/users/sign_up">here</a></html>
-== weather_units ==
-By default, all calls are returned with Kelvin. To chose your local unit use the following options:
-  - imperial (F)
-  - metric (C)
 ----