-
Notifications
You must be signed in to change notification settings - Fork 150
Things to Know
Things that are good to know.
- NOTE: Does not work in Windows under WSL
You can setup a systemd daemon for wire-pod. This allows it to run in the background and it to run automatically at startup.
cd ~/wire-pod
sudo ./setup.sh daemon-enable
To start the service, either restart your computer or run:
sudo systemctl start wire-pod
To see logs, run:
journalctl -fe | grep start.sh
If you would like to disable the daemon, run:
cd ~/wire-pod
sudo ./setup.sh daemon-disable
If you built from source (not installed from a .deb), follow the "Linux (non-Debian/non-Ubuntu)" steps instead.
Download wirepod_[arch]_v#.#.#.deb for your system from the latest release of WirePod and install it with sudo apt install ./Downloads/wirepod_[arch]_v#.#.#.deb. wire-pod will restart to the updated version automatically.
If you have set it up so wire-pod is running as a daemon in the background:
sudo systemctl stop wire-pod
cd ~/wire-pod
sudo ./update.sh
sudo ./setup.sh daemon-enable
sudo systemctl start wire-pod
Download WirePodInstaller-v#.#.#.exe from the latest release of WirePod and install. It will automatically update your WirePod installation without erasing any data.
Quit WirePod (click the rocket icon in the top bar and click "Quit"), download WirePod-v#.#.#.dmg from the latest release of WirePod, mount it, drag WirePod to your Applications folder, allow an overwrite, then launch WirePod from the Applications folder in Finder. No user data will be erased.
Download WirePod-#.#.#.apk from the latest release of WirePod and install it. No user data will be erased.
You may need to do this if you are running into issues with a wire-pod update or if a bot keeps deauthenticating.
This is also the only way to switch between an Escape Pod config and IP Address config.
sudo systemctl stop wire-pod
sudo rm -rf /etc/wire-pod/wire-pod
sudo systemctl start wire-pod
wire-pod -justip
# this will give you the configuration page, without needing to see logs
sudo systemctl stop wire-pod
cd ~/wire-pod
sudo rm -f chipper/apiConfig.json
sudo rm -f chipper/jdocs/*.json
sudo systemctl start wire-pod
- Go to Settings and find "Apps and Programs".
- Find WirePod and uninstall it. The uninstaller will ask you if you want to clear all user data.
- Reinstall WirePod per the Installation guide.
- Make sure WirePod isn't running.
- In a terminal, run:
rm -rf ~/Library/Application\ Support/wire-pod
- Start WirePod again.
- Open Settings.
- Head to Apps and find WirePod.
- Find the option to clear cache and data.
There are a few environment variables you can use to modify wire-pod behavior. Place these in ~/wire-pod/chipper/source.sh and restart wire-pod (via start.sh) for them to take effect.
VOSK_WITH_GRAMMER (true or false, default: false) - enables/default vosk grammer optimizations. Increases speed to the point where it can run on very low end hardware, but limits the transcribable words to only what intents can match to, meaning intent-graph functionality won't work.
JDOCS_ENABLE_PINGER (true or false, default: true) - enables/disables the jdocs pinger. The Jdocs pinger was created as a workaround and allows production bots to stay connected to wire-pod. This requires wire-pod to be able to connect to the robot. This is here in case you want to set wire-pod up as a public server.
WEBSERVER_PORT (int, default: 8080) - sets the web interface port.
In the Debian/Ubuntu .deb prebuilt versions, there is a /etc/wire-pod/config.ini file which includes options like these.
Chipper hosts a web interface at port 8080 (by default). This can be used to create custom intents and to configure specific bots.
To get to it, open a browser and go to http://serverip:8080, replacing serverip with the IP address of the machine running the chipper server. If you are running the browser on the machine running chipper, you can go to http://localhost:8080
- API setup
- If you want to change anything about your weather or knowledge graph API configuration, it should be done here
- Configure bots
- This is a page that allows you to configure any bot that has been logged in to your wire-pod instance.
- You can configure any setting the app can and more.
- There is a control page which allows you to assume behavior control of the robot and use your keyboard to control. You can also get a camera stream and make the robot say stuff.
- Custom intents
- See Custom Intents