User Tools

Site Tools


code:vxmppb:install:config

vXMPPb Configuration

FIXME FIXME FIXME

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 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 1)

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 this page
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. 2)

mastodon_url

Server to query API requests at.

mqtt_message

Message MQTT should send on successful connect. 3)

mqtt_password

Password for MQTT user 4)

mqtt_server

Server to use (example.com:1883)

mqtt_topic

MQTT topic to publish to

mqtt_user

MQTT username for authentication 5)


Scripts for TuyaAPI will be posted in a separate repository

tuya_name

Name of device to control 6)

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 here

weather_units

By default, all calls are returned with Kelvin. To chose your local unit use the following options:

  1. imperial (F)
  2. metric (C)
1)
Just in case SRV fails
2) , 3)
More options coming soon
4) , 5)
If applicable
6)
Multi-device coming…soon…ish
code/vxmppb/install/config.txt · Last modified: 2023/11/11 22:22 by stephen