mirror of
https://github.com/go-vikunja/vikunja.git
synced 2026-02-01 14:44:05 +00:00
3aa1e90d7f
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
133 lines
2.9 KiB
Go
133 lines
2.9 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"
|
|
|
|
"code.vikunja.io/api/pkg/config"
|
|
"code.vikunja.io/api/pkg/files"
|
|
)
|
|
|
|
// CheckFiles returns file storage checks.
|
|
func CheckFiles() CheckGroup {
|
|
fileType := config.FilesType.GetString()
|
|
|
|
// Initialize file handler
|
|
if err := files.InitFileHandler(); err != nil {
|
|
return CheckGroup{
|
|
Name: fmt.Sprintf("Files (%s)", fileType),
|
|
Results: []CheckResult{
|
|
{
|
|
Name: "Initialization",
|
|
Passed: false,
|
|
Error: err.Error(),
|
|
},
|
|
},
|
|
}
|
|
}
|
|
|
|
var results []CheckResult
|
|
|
|
switch fileType {
|
|
case "local":
|
|
results = checkLocalStorage()
|
|
case "s3":
|
|
results = checkS3Storage()
|
|
default:
|
|
results = []CheckResult{
|
|
{
|
|
Name: "Type",
|
|
Passed: false,
|
|
Error: fmt.Sprintf("unknown storage type: %s", fileType),
|
|
},
|
|
}
|
|
}
|
|
|
|
return CheckGroup{
|
|
Name: fmt.Sprintf("Files (%s)", fileType),
|
|
Results: results,
|
|
}
|
|
}
|
|
|
|
func checkLocalStorage() []CheckResult {
|
|
basePath := config.FilesBasePath.GetString()
|
|
|
|
results := []CheckResult{
|
|
{
|
|
Name: "Path",
|
|
Passed: true,
|
|
Value: basePath,
|
|
},
|
|
}
|
|
|
|
// Check writable using the existing ValidateFileStorage function
|
|
if err := files.ValidateFileStorage(); err != nil {
|
|
results = append(results, CheckResult{
|
|
Name: "Writable",
|
|
Passed: false,
|
|
Error: err.Error(),
|
|
})
|
|
} else {
|
|
results = append(results, CheckResult{
|
|
Name: "Writable",
|
|
Passed: true,
|
|
Value: "yes",
|
|
})
|
|
}
|
|
|
|
// Check disk space (platform-specific)
|
|
results = append(results, checkDiskSpace(basePath))
|
|
|
|
return results
|
|
}
|
|
|
|
func checkS3Storage() []CheckResult {
|
|
endpoint := config.FilesS3Endpoint.GetString()
|
|
bucket := config.FilesS3Bucket.GetString()
|
|
|
|
results := []CheckResult{
|
|
{
|
|
Name: "Endpoint",
|
|
Passed: true,
|
|
Value: endpoint,
|
|
},
|
|
{
|
|
Name: "Bucket",
|
|
Passed: true,
|
|
Value: bucket,
|
|
},
|
|
}
|
|
|
|
// Check writable using the existing ValidateFileStorage function
|
|
if err := files.ValidateFileStorage(); err != nil {
|
|
results = append(results, CheckResult{
|
|
Name: "Writable",
|
|
Passed: false,
|
|
Error: err.Error(),
|
|
})
|
|
} else {
|
|
results = append(results, CheckResult{
|
|
Name: "Writable",
|
|
Passed: true,
|
|
Value: "yes",
|
|
})
|
|
}
|
|
|
|
return results
|
|
}
|