diff --git a/Setup-Script.md b/Setup-Script.md index fca2cb4..0501a38 100644 --- a/Setup-Script.md +++ b/Setup-Script.md @@ -1,3 +1,40 @@ # LoMeS Setup -### Requirements \ No newline at end of file +### Requirements +- Meshtastic device + - _RAK WISBlock_ & _Heltec V3_ will be supported on my end +- Linux machine running Debian +- `apt` as package manager +- `systemd` as init system + +I will try to broaden the range of host os possibilities along the way + +## Development Setup + +1. Setup 64bit Linux Debian on host machine +2. Install git: +```bash +sudo apt install -y git +``` +3. Clone repository +```bash +git clone https://lab.c95.org/fr4nz/LoMeS.git && cd LoMeS +``` +4. Run development environment setup +```bash +chmod +x lomes-setup.sh && sudo ./lomes-setup.sh +``` +5. Start developing + +## What does the script do? + +1. checks for `sudo` or `root` privileges +2. searches & installs missing dependencies | cmd `apt` +3. gets some ID from your system (ip, network interface, hostname) | cmd `ip` & `hostname` +4. lets you change hostname (optional | reboot needed) | cmd `sed` +5. creates a certificate for `nginx` | cmd `mkdir`, `openssl`, `chmod` & `cp` +6. edits `nginx.conf` (domain, ip, cert & key path) | cmd `sed` +7. removes default nginx welcome page | cmd `rm` +8. checks `nginx.conf` & reloads nginx | cmd `nginx` +9. reviews `log | /tmp/LoMeS/install_log` for errors +10. asks to start flask | cmd `flask` **OR** reboot if `hostname` changed | cmd `reboot` \ No newline at end of file