Files
vikunja/pkg/doctor/system.go
kolaente 3aa1e90d7f feat: add vikunja doctor command for diagnostic checks (#2165)
Add a new `vikunja doctor` CLI command that performs diagnostic checks.

Checks performed:

- **System**: Version, Go version, OS/arch, running user, working
directory
- **Configuration**: Config file path, public URL, JWT secret, CORS
origins
- **Database**: Connection test, server version
(SQLite/MySQL/PostgreSQL)
- **Files**: Storage path, writability, disk space (Unix only)
- **Optional services** (when enabled):
  - Redis: Connection ping
  - Typesense: Health endpoint
  - Mailer: SMTP connection
  - LDAP: Bind authentication test
  - OpenID Connect: Discovery endpoint for each configured provider
2026-01-27 09:12:31 +00:00

83 lines
1.8 KiB
Go

// Vikunja is a to-do list application to facilitate your life.
// Copyright 2018-present Vikunja and contributors. All rights reserved.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
package doctor
import (
"fmt"
"os"
"runtime"
"code.vikunja.io/api/pkg/version"
)
// CheckSystem returns system information checks.
func CheckSystem() CheckGroup {
results := []CheckResult{
checkVersion(),
checkGoVersion(),
checkOS(),
checkUser(),
checkWorkingDirectory(),
}
return CheckGroup{
Name: "System",
Results: results,
}
}
func checkVersion() CheckResult {
return CheckResult{
Name: "Version",
Passed: true,
Value: version.Version,
}
}
func checkGoVersion() CheckResult {
return CheckResult{
Name: "Go",
Passed: true,
Value: runtime.Version(),
}
}
func checkOS() CheckResult {
return CheckResult{
Name: "OS",
Passed: true,
Value: fmt.Sprintf("%s/%s", runtime.GOOS, runtime.GOARCH),
}
}
func checkWorkingDirectory() CheckResult {
wd, err := os.Getwd()
if err != nil {
return CheckResult{
Name: "Working directory",
Passed: false,
Error: err.Error(),
}
}
return CheckResult{
Name: "Working directory",
Passed: true,
Value: wd,
}
}