7 changed files with 22 additions and 216 deletions
+1 -1
View File
@@ -13,7 +13,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Set up Go - name: Set up Go
uses: actions/setup-go@v5 uses: actions/setup-go@v4
with: with:
go-version: '1.20.2' go-version: '1.20.2'
- name: Check out code - name: Check out code
-23
View File
@@ -1,23 +0,0 @@
# Changelog
## [1.3.2] - 08-12-2024
* Fix to Browser Dev feature:
* Checking browser dev url when internet_accessible was checking the incorrect path. This is now fixed.
## [1.3.1] - 08-12-2024
* Fixes to Browser Dev feature:
* Now edgeboxctl also fetches or generates the browser dev environment url and saves it into an option both when starting, and every time the browser dev status is fetched.
## [1.3.0] - 05-12-2024
* Added Edgebox Browser Development Environment Feature Support
* Added tasks for handling browser development environment into tasks.go
* Added executable tasks to ExecuteTask and scheduled ones to ExecuteSchedules
* Other bug fixes and improvements.
### Missing Past Releases
Release notes for past versions are not available in this file. Please refer to the [GitHub releases](https://hithub.com/edgebox-iot/edgeboxctl/releases) for more information. Feel free to contribute to this file by adding missing release notes.
+1 -1
View File
@@ -67,7 +67,7 @@ run:
install: install:
@echo "📦 Installing edgeboxctl service (${RELEASE}) for ${GOOS} (${GOARCH})\n" @echo "📦 Installing edgeboxctl service (${RELEASE}) for ${GOOS} (${GOARCH})\n"
@echo "�🚧 Stopping edgeboxctl service if it is running" @echo "🚧 Stopping edgeboxctl service if it is running"
sudo systemctl stop edgeboxctl || true sudo systemctl stop edgeboxctl || true
@echo "\n🗑️ Removing old edgeboxctl binary and service" @echo "\n🗑️ Removing old edgeboxctl binary and service"
+4 -6
View File
@@ -59,12 +59,10 @@ To get a local copy up and running follow these simple steps.
If you're running for development purposes, a docker container suffices, so make sure you have: If you're running for development purposes, a docker container suffices, so make sure you have:
* docker * docker
* docker compose (docker-compose-v2 package) * docker compose
Check the following links for more info on [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/). Check the following links for more info on [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/).
**Note:** If you don't have `docker compose` available, install it with: `sudo apt-get install docker-compose-v2`
Aditionally, `edgeboxctl` needs the following bash commands available wherever it runs: Aditionally, `edgeboxctl` needs the following bash commands available wherever it runs:
* `arm-linux-gnueabi-gcc` (`sudo apt-get install gcc-arm*`) * `arm-linux-gnueabi-gcc` (`sudo apt-get install gcc-arm*`)
@@ -81,10 +79,10 @@ Aditionally, `edgeboxctl` needs the following bash commands available wherever i
```sh ```sh
git clone https://github.com/edgebox-iot/edgeboxctl.git git clone https://github.com/edgebox-iot/edgeboxctl.git
``` ```
2. Run Docker Compose 2. Run Docker-Compose
```sh
docker-compose up
``` ```
docker compose up
+3 -3
View File
@@ -489,7 +489,7 @@ func GetEdgeAppServices(ID string) []EdgeAppService {
// Check if the service is actually running // Check if the service is actually running
if shouldBeRunning { if shouldBeRunning {
cmdArgs = []string{"-f", wsPath + "/docker-compose.yml", "exec", "-T", serviceID, "echo", "'Service Check'"} cmdArgs = []string{"-f", wsPath + "/docker-compose.yml", "exec", "-T", serviceID, "echo", "'Service Check'"}
cmdResult := utils.Exec(wsPath, "docker", append([]string{"compose"}, cmdArgs...)) cmdResult := utils.Exec(wsPath, "docker-compose", cmdArgs)
if cmdResult != "" { if cmdResult != "" {
isRunning = true isRunning = true
} }
@@ -511,7 +511,7 @@ func RunEdgeApp(ID string) EdgeAppStatus {
for _, service := range services { for _, service := range services {
cmdArgs = []string{"-f", wsPath + "/docker-compose.yml", "start", service.ID} cmdArgs = []string{"-f", wsPath + "/docker-compose.yml", "start", service.ID}
utils.Exec(wsPath, "docker", append([]string{"compose"}, cmdArgs...)) utils.Exec(wsPath, "docker-compose", cmdArgs)
} }
// Wait for it to settle up before continuing... // Wait for it to settle up before continuing...
@@ -529,7 +529,7 @@ func StopEdgeApp(ID string) EdgeAppStatus {
for _, service := range services { for _, service := range services {
cmdArgs = []string{"-f", wsPath + "/docker-compose.yml", "stop", service.ID} cmdArgs = []string{"-f", wsPath + "/docker-compose.yml", "stop", service.ID}
utils.Exec(wsPath, "docker", append([]string{"compose"}, cmdArgs...)) utils.Exec(wsPath, "docker-compose", cmdArgs)
} }
// Wait for it to settle up before continuing... // Wait for it to settle up before continuing...
+12 -172
View File
@@ -18,8 +18,6 @@ import (
"github.com/edgebox-iot/edgeboxctl/internal/system" "github.com/edgebox-iot/edgeboxctl/internal/system"
"github.com/edgebox-iot/edgeboxctl/internal/utils" "github.com/edgebox-iot/edgeboxctl/internal/utils"
"github.com/joho/godotenv"
_ "github.com/go-sql-driver/mysql" // Mysql Driver _ "github.com/go-sql-driver/mysql" // Mysql Driver
_ "github.com/mattn/go-sqlite3" // SQlite Driver _ "github.com/mattn/go-sqlite3" // SQlite Driver
) )
@@ -297,21 +295,6 @@ func ExecuteTask(task Task) Task {
taskResult := taskStopShell() taskResult := taskStopShell()
task.Result = sql.NullString{String: taskResult, Valid: true} task.Result = sql.NullString{String: taskResult, Valid: true}
case "generate_ssh_key":
log.Println("Generating SSH Key...")
taskResult := taskGenerateSshKey()
task.Result = sql.NullString{String: taskResult, Valid: true}
case "get_ssh_key":
log.Println("Getting SSH Key...")
taskResult := taskGetSshKey()
task.Result = sql.NullString{String: taskResult, Valid: true}
case "revoke_ssh_key":
log.Println("Revoking SSH Key...")
taskResult := taskRevokeSshKey()
task.Result = sql.NullString{String: taskResult, Valid: true}
case "activate_browser_dev": case "activate_browser_dev":
log.Println("Activating Browser Dev Environment") log.Println("Activating Browser Dev Environment")
taskResult := taskActivateBrowserDev() taskResult := taskActivateBrowserDev()
@@ -548,8 +531,6 @@ func ExecuteSchedules(tick int) {
log.Println("Fetching Browser Dev Environment Information") log.Println("Fetching Browser Dev Environment Information")
taskGetBrowserDevPassword() taskGetBrowserDevPassword()
taskGetBrowserDevStatus() taskGetBrowserDevStatus()
taskCheckSystemUpdates()
ip := taskGetSystemIP() ip := taskGetSystemIP()
log.Println("System IP is: " + ip) log.Println("System IP is: " + ip)
@@ -579,7 +560,9 @@ func ExecuteSchedules(tick int) {
taskStartWs() taskStartWs()
log.Println(taskGetEdgeApps()) log.Println(taskGetEdgeApps())
taskUpdateSystemLoggerServices() taskUpdateSystemLoggerServices()
taskRecoverFromUpdate() taskRecoverFromUpdate()
taskCheckSystemUpdates()
} }
if tick%5 == 0 { if tick%5 == 0 {
@@ -588,10 +571,6 @@ func ExecuteSchedules(tick int) {
log.Println(taskGetStorageDevices()) log.Println(taskGetStorageDevices())
} }
if tick%15 == 0 {
taskGetBrowserDevStatus()
}
if tick%30 == 0 { if tick%30 == 0 {
// Executing every 30 ticks // Executing every 30 ticks
log.Println(taskGetEdgeApps()) log.Println(taskGetEdgeApps())
@@ -1168,13 +1147,10 @@ func taskGetBrowserDevStatus() string {
"sh", "sh",
[]string{"-c", "systemctl --quiet is-active code-server@root && echo 'active' || echo 'inactive'"}, []string{"-c", "systemctl --quiet is-active code-server@root && echo 'active' || echo 'inactive'"},
) )
if browserDevStatus == "active" { if browserDevStatus != "" {
fmt.Println("Browser Dev Environment is running") fmt.Println("Browser Dev Environment is running")
utils.WriteOption("BROWSERDEV_STATUS", "running") utils.WriteOption("BROWSERDEV_STATUS", "running")
taskGetBrowserDevUrl()
return "{\"status\": \"running\"}" return "{\"status\": \"running\"}"
} else { } else {
fmt.Println("Browser Dev Environment is not running") fmt.Println("Browser Dev Environment is not running")
utils.WriteOption("BROWSERDEV_STATUS", "not_running") utils.WriteOption("BROWSERDEV_STATUS", "not_running")
@@ -1182,24 +1158,6 @@ func taskGetBrowserDevStatus() string {
} }
} }
func taskGetBrowserDevUrl() string {
url := ""
myEdgeAppServiceEnv, err := godotenv.Read(utils.GetPath(utils.BrowserDevPath) + "myedgeapp.env")
if err != nil {
log.Println("No myedge.app environment file found. Status is Network-Only")
url = "http://dev." + system.GetHostname() + ".local"
} else {
if myEdgeAppServiceEnv["INTERNET_URL"] != "" {
url = "https://" + myEdgeAppServiceEnv["INTERNET_URL"]
}
}
fmt.Println("Browser Dev Url: " + url)
utils.WriteOption("BROWSERDEV_URL", url)
return url
}
func taskActivateBrowserDev() string { func taskActivateBrowserDev() string {
fmt.Println("Executing taskActivateBrowserDev") fmt.Println("Executing taskActivateBrowserDev")
wsPath := utils.GetPath(utils.WsPath) wsPath := utils.GetPath(utils.WsPath)
@@ -1212,10 +1170,6 @@ func taskActivateBrowserDev() string {
system.StartWs() system.StartWs()
// Write control option for API // Write control option for API
utils.WriteOption("BROWSERDEV_STATUS", "running") utils.WriteOption("BROWSERDEV_STATUS", "running")
// Write and refresh the dev environment password option
taskGetBrowserDevPassword()
return "{\"status\": \"ok\"}" return "{\"status\": \"ok\"}"
} }
@@ -1235,14 +1189,15 @@ func taskDeactivateBrowserDev() string {
func taskGetBrowserDevPassword() string { func taskGetBrowserDevPassword() string {
fmt.Println("Executing taskGetBrowserDevPassword") fmt.Println("Executing taskGetBrowserDevPassword")
password := utils.ReadOption("BROWSERDEV_PASSWORD")
password, err := system.FetchBrowserDevPasswordFromFile() if password == "" {
if err == nil { password, err := system.FetchBrowserDevPasswordFromFile()
utils.WriteOption("BROWSERDEV_PASSWORD", password) if err == nil {
} else { utils.WriteOption("BROWSERDEV_PASSWORD", password)
fmt.Println("Error fetching browser dev password from file: " + err.Error()) } else {
fmt.Println("Error fetching browser dev password from file: " + err.Error())
}
} }
return password return password
} }
@@ -1600,118 +1555,3 @@ func taskStartWs() {
fmt.Println("Executing taskStartWs") fmt.Println("Executing taskStartWs")
system.StartWs() system.StartWs()
} }
func taskGenerateSshKey() string {
fmt.Println("Executing taskGenerateSshKey")
keyPath := "/root/.ssh/id_ed25519"
pubKeyPath := keyPath + ".pub"
// Check if key already exists
if _, err := os.Stat(keyPath); os.IsNotExist(err) {
fmt.Println("SSH key not found, generating new ED25519 key pair...")
utils.Exec("/", "ssh-keygen", []string{"-t", "ed25519", "-f", keyPath, "-N", "", "-q"})
} else {
fmt.Println("SSH key already exists at " + keyPath)
}
// Read public key
pubKeyBytes, err := os.ReadFile(pubKeyPath)
if err != nil {
fmt.Println("Error reading public key: " + err.Error())
return "{\"status\": \"error\", \"message\": \"" + err.Error() + "\"}"
}
pubKey := string(pubKeyBytes)
// Read private key
privKeyBytes, err := os.ReadFile(keyPath)
if err != nil {
fmt.Println("Error reading private key: " + err.Error())
return "{\"status\": \"error\", \"message\": \"" + err.Error() + "\"}"
}
privKey := string(privKeyBytes)
// Also add public key to authorized_keys for root
utils.Exec("/", "sh", []string{"-c", "mkdir -p /root/.ssh && chmod 700 /root/.ssh"})
authorizedFile := "/root/.ssh/authorized_keys"
authorizedBytes, _ := os.ReadFile(authorizedFile)
authorizedContent := string(authorizedBytes)
// Only add if not already present
if !strings.Contains(authorizedContent, strings.TrimSpace(pubKey)) {
f, err := os.OpenFile(authorizedFile, os.O_APPEND|os.O_WRONLY, 0600)
if err == nil {
defer f.Close()
f.WriteString("\n" + pubKey)
fmt.Println("Added SSH public key to authorized_keys")
}
}
// Store in options for the API to read
utils.WriteOption("SSH_PUBLIC_KEY", strings.TrimSpace(pubKey))
utils.WriteOption("SSH_PRIVATE_KEY", privKey)
utils.WriteOption("SSH_KEY_FINGERPRINT", strings.TrimSpace(utils.Exec("/", "ssh-keygen", []string{"-lf", pubKeyPath, "-E", "sha256"})))
fmt.Println("SSH key stored in options")
return "{\"status\": \"ok\", \"public_key\": \"" + strings.TrimSpace(pubKey) + "\"}"
}
func taskGetSshKey() string {
fmt.Println("Executing taskGetSshKey")
pubKey := utils.ReadOption("SSH_PUBLIC_KEY")
fingerprint := utils.ReadOption("SSH_KEY_FINGERPRINT")
if pubKey == "" {
// Try to read from filesystem directly
return taskGenerateSshKey()
}
return "{\"status\": \"ok\", \"public_key\": \"" + pubKey + "\", \"fingerprint\": \"" + fingerprint + "\"}"
}
func taskRevokeSshKey() string {
fmt.Println("Executing taskRevokeSshKey")
keyPath := "/root/.ssh/id_ed25519"
pubKeyPath := keyPath + ".pub"
// Read current public key before deletion
var pubKeyForRemoval string
if bytes, err := os.ReadFile(pubKeyPath); err == nil {
pubKeyForRemoval = strings.TrimSpace(string(bytes))
}
// Remove SSH key pair from filesystem
if err := os.Remove(keyPath); err != nil {
fmt.Println("Warning: could not remove private key: " + err.Error())
}
if err := os.Remove(pubKeyPath); err != nil {
fmt.Println("Warning: could not remove public key: " + err.Error())
}
// Remove the public key from authorized_keys if present
if pubKeyForRemoval != "" {
authorizedFile := "/root/.ssh/authorized_keys"
if bytes, err := os.ReadFile(authorizedFile); err == nil {
lines := strings.Split(string(bytes), "\n")
newLines := []string{}
for _, line := range lines {
if strings.TrimSpace(line) != pubKeyForRemoval {
newLines = append(newLines, line)
}
}
_ = os.WriteFile(authorizedFile, []byte(strings.Join(newLines, "\n")), 0600)
}
}
// Remove SSH options from DB
utils.WriteOption("SSH_PUBLIC_KEY", "")
utils.WriteOption("SSH_PRIVATE_KEY", "")
utils.WriteOption("SSH_KEY_FINGERPRINT", "")
fmt.Println("SSH key pair revoked")
return "{\"status\": \"ok\", \"message\": \"SSH key pair revoked\"}"
}
+1 -10
View File
@@ -54,7 +54,7 @@ func Exec(path string, command string, args []string) string {
// log.Println(fmt.Sprint(err) + ": " + stderr.String()) // ... Silence... // log.Println(fmt.Sprint(err) + ": " + stderr.String()) // ... Silence...
} }
// log.Println("Result: " + out.String()) // ... Silence ... log.Println("Result: " + out.String()) // ... Silence ...
return strings.Trim(out.String(), " \n") return strings.Trim(out.String(), " \n")
@@ -111,7 +111,6 @@ const ApiPath string = "apiPath"
const EdgeAppsPath string = "edgeAppsPath" const EdgeAppsPath string = "edgeAppsPath"
const EdgeAppsBackupPath string = "edgeAppsBackupPath" const EdgeAppsBackupPath string = "edgeAppsBackupPath"
const WsPath string = "wsPath" const WsPath string = "wsPath"
const BrowserDevPath string = "browserDevPath"
const LoggerPath string = "loggerPath" const LoggerPath string = "loggerPath"
const BrowserDevPasswordFileLocation string = "browserDevPasswordFileLocation" const BrowserDevPasswordFileLocation string = "browserDevPasswordFileLocation"
const BrowserDevProxyPath string = "browserDevProxyPath" const BrowserDevProxyPath string = "browserDevProxyPath"
@@ -177,14 +176,6 @@ func GetPath(pathKey string) string {
targetPath = "/home/system/components/ws/" targetPath = "/home/system/components/ws/"
} }
case BrowserDevPath:
if env["BROWSERDEV_PATH"] != "" {
targetPath = env["BROWSERDEV_PATH"]
} else {
targetPath = "/home/system/components/dev/"
}
case LoggerPath: case LoggerPath:
if env["LOGGER_PATH"] != "" { if env["LOGGER_PATH"] != "" {
targetPath = env["LOGGER_PATH"] targetPath = env["LOGGER_PATH"]