meshtastic/website/docs/software/web/config.md

82 lines
3.4 KiB
Markdown
Raw Normal View History

2021-04-15 03:19:53 -07:00
---
id: web-config-software
title: Initial configuration
sidebar_label: Configuration
---
## Manual Installation
2021-04-15 05:01:22 -07:00
Pre-requisite: You have Meshtastic Device firmware between version 1.0.32 - 1.1.50. A client for version 1.2.x will be released shortly and the documentation will be updated accordingly.
2021-04-15 03:19:53 -07:00
We do realize this installation method is not "easy" and are exploring ways to simplify this in the future, ideally rolling it out as part of the device firmware.
2021-04-15 05:01:22 -07:00
Once you have your device loaded with the Meshtastic Device firmware you need to connect to it's wifi and then manually upload the web interface files.
2021-04-15 03:19:53 -07:00
### Connect to device wifi
The easiest way to turn on the device wifi is to do the following after the device has been powered on:
* Hold down the user button
* Press and release the reset button
* Count to 2
* Let go of the user button
:::note
Some devices call this the “prog” button. On devices with two buttons where one is a reset button — its usually the other one. On T-beam devices it is the middle button.
:::
The device will now go into WiFi SoftAP Admin Mode. In this mode, your device will broadcast the following credentials on a built in Access Point:
* SSID: meshtasticAdmin
* Password: 12345678
:::note
The first time your device restarts after enabling WiFi, it will take an additional 20-30 seconds to boot. This is to generate self-signed SSL keys. The keys will be saved for future reuse.
:::
2021-04-15 04:55:19 -07:00
### Upload web interface files
2021-04-15 03:19:53 -07:00
Next download the three files (app.css.gz, app.js.gz and index.html.gz) from:
[https://github.com/meshtastic/meshtastic-web/releases](https://github.com/meshtastic/meshtastic-web/releases)
Then manually upload them to your device by going to:
* Hostname over mDNS
* * [http://meshtastic.local/static](http://meshtastic.local/static)
* If mDNS doesn't work for you
* * http://{your device IP address here}/static
* * Device IP address typically defaults to 192.168.42.1
2021-04-15 04:55:19 -07:00
The web interface application can then be accessed by visiting [http://meshtastic.local/](http://meshtastic.local/) or [http://192.168.42.1/](http://192.168.42.1/)
2021-04-15 03:19:53 -07:00
We do realize this is not "easy" and are exploring ways to simplify this in the future, ideally rolling it out as part of the device firmware.
### Wifi configuration
2021-04-15 05:01:22 -07:00
To enable the WiFi to access the web interface, you must at minimum set two preferences:
2021-04-15 03:19:53 -07:00
`wifi_ssid`
`wifi_password`
For the wifi features to be enabled, those two properties must be set.
To turn it off, either of preference must be set as an empty string, that is a pair of double quotes each:
`wifi_ssid ""`
`wifi_password ""`
Alternatively, you can enable the internal Soft Access Point:
`wifi_ap_mode true`
2021-04-15 05:01:22 -07:00
With that enabled, we will broadcast a new wifi network with the SSID and password you set. In AP mode, your device will act as a Captive Portal with a built in DNS server that resolves all name requests back to the device. Additionally, Apple Captive Portal Assistant is implemented -- if you're on an Apple device, the web interface will pop up automagically.
2021-04-15 03:19:53 -07:00
To turn it off, simply reboot the device.
Right now, the only way to set those preference is through the Meshtastic-python command line tool. At some point, we will be able to configure this from your mobile phone over Bluetooth.
:::note
The first time your device restarts after enabling WiFi, it will take an additional 20-30 seconds to boot. This is to generate self-signed SSL keys. The keys will be saved for future reuse.
:::