Files
Gokapi/cmd/gokapi/Main.go
spaghetti-coder 84eb70edbb Add deprecation alerts, deprecate DOCKER_NONROOT in favor of docker --user ... (#327)
* deprecate DOCKER_NONROOT in favor of docker --user ...

* remove redundant named volumes creation in compose
* remove DOCKER_NONROOT from demo env file
* add deprecation warning to docker entrypoint
* update documentation

* Added feature to show deprecation messages in UI and logs
Added deprecation message for Docker_NONROOT
Fixed documentation

---------

Co-authored-by: Marc Ole Bulling <Marc-Ole@gmx.de>
2025-11-04 22:26:04 +01:00

239 lines
7.4 KiB
Go
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
//go:build go1.24
package main
/**
Main routine
*/
import (
"fmt"
"os"
"os/signal"
"runtime/debug"
"syscall"
"github.com/forceu/gokapi/internal/configuration/database/migration"
"github.com/forceu/gokapi/internal/helper/systemd"
"github.com/forceu/gokapi/internal/configuration"
"github.com/forceu/gokapi/internal/configuration/cloudconfig"
"github.com/forceu/gokapi/internal/configuration/database"
"github.com/forceu/gokapi/internal/configuration/setup"
"github.com/forceu/gokapi/internal/encryption"
"github.com/forceu/gokapi/internal/environment"
"github.com/forceu/gokapi/internal/environment/flagparser"
"github.com/forceu/gokapi/internal/logging"
"github.com/forceu/gokapi/internal/storage"
"github.com/forceu/gokapi/internal/storage/filesystem"
"github.com/forceu/gokapi/internal/storage/filesystem/s3filesystem/aws"
"github.com/forceu/gokapi/internal/webserver"
"github.com/forceu/gokapi/internal/webserver/authentication"
"github.com/forceu/gokapi/internal/webserver/ssl"
)
// versionGokapi is the current version in readable form.
// Other version numbers can be modified in /build/go-generate/updateVersionNumbers.go
const versionGokapi = "2.1.0"
// The following calls update the version numbers, update documentation, minify Js/CSS and build the WASM modules
//go:generate go run "../../build/go-generate/updateVersionNumbers.go"
//go:generate go run "../../build/go-generate/updateProtectedUrls.go"
//go:generate go run "../../build/go-generate/updateApiRouting.go"
//go:generate go run "../../build/go-generate/buildWasm.go"
//go:generate go run "../../build/go-generate/copyStaticFiles.go"
//go:generate go run "../../build/go-generate/minifyStaticContent.go"
// Main routine that is called on startup
func main() {
passedFlags := flagparser.ParseFlags()
handleServiceInstall(passedFlags)
handleDbMigration(passedFlags)
showVersion(passedFlags)
fmt.Println(logo)
fmt.Println("Gokapi v" + versionGokapi + " starting")
setup.RunIfFirstStart()
configuration.Load()
if !reconfigureServer(passedFlags) {
configuration.ConnectDatabase()
}
setDeploymentPassword(passedFlags)
checkIfUserExists()
encryption.Init(*configuration.Get())
authentication.Init(configuration.Get().Authentication)
createSsl(passedFlags)
initCloudConfig(passedFlags)
go storage.CleanUp(true)
logging.LogStartup()
showDeprecationWarnings()
go webserver.Start()
c := make(chan os.Signal)
signal.Notify(c, os.Interrupt, syscall.SIGTERM)
<-c
shutdown()
os.Exit(0)
}
func shutdown() {
fmt.Println("Shutting down...")
webserver.Shutdown()
logging.LogShutdown()
database.Close()
}
// Checks for command line arguments that have to be parsed before loading the configuration
func showVersion(passedFlags flagparser.MainFlags) {
if !passedFlags.ShowVersion {
return
}
fmt.Println("Gokapi v" + versionGokapi)
fmt.Println()
fmt.Println("Builder: " + environment.Builder)
fmt.Println("Build Date: " + environment.BuildTime)
fmt.Println("Is Docker Version: " + environment.IsDocker)
info, ok := debug.ReadBuildInfo()
if ok {
fmt.Println("Go Version: " + info.GoVersion)
} else {
fmt.Println("Go Version: unknown")
}
if info == nil {
fmt.Println("Build Settings: unknown")
} else {
parseBuildSettings(info.Settings)
}
osExit(0)
}
func showDeprecationWarnings() {
for _, dep := range configuration.Environment.ActiveDeprecations {
fmt.Println()
fmt.Println("WARNING, deprecated feature: " + dep.Name)
fmt.Println(dep.Description)
fmt.Println("See " + dep.DocUrl + " for more information.")
fmt.Println()
logging.LogDeprecation(dep)
}
}
func parseBuildSettings(infos []debug.BuildSetting) {
lookups := make(map[string]string)
lookups["-tags"] = "Build Tags"
lookups["vcs.revision"] = "Git Commit"
lookups["vcs.time"] = "Git Commit Timestamp"
lookups["GOARCH"] = "Architecture"
lookups["GOOS"] = "Operating System"
for key, value := range lookups {
result := "None"
for _, buildSetting := range infos {
if buildSetting.Key == key {
result = buildSetting.Value
break
}
}
fmt.Println(value + ": " + result)
}
for _, info := range infos {
if info.Key == "vcs.modified" {
if info.Value == "true" {
fmt.Println("Code has been modified after last git commit")
}
break
}
}
}
func initCloudConfig(passedFlags flagparser.MainFlags) {
cConfig, ok := cloudconfig.Load()
if ok && aws.Init(cConfig.Aws) {
fmt.Println("Saving new files to cloud storage")
filesystem.SetAws()
encLevel := configuration.Get().Encryption.Level
env := environment.New()
corsCheckDisabled := passedFlags.DisableCorsCheck || env.DisableCorsCheck
if !corsCheckDisabled && (encLevel == encryption.FullEncryptionStored || encLevel == encryption.FullEncryptionInput || encLevel == encryption.EndToEndEncryption) {
ok, err := aws.IsCorsCorrectlySet(cConfig.Aws.Bucket, configuration.Get().ServerUrl)
if err != nil {
fmt.Println("Warning: Cannot check CORS settings. " + err.Error())
fmt.Println("If your provider does not implement the CORS API call and you are certain that it is set correctly, you can disable this check with --disable-cors-check")
} else {
if !ok {
fmt.Println("Warning: CORS settings for bucket " + cConfig.Aws.Bucket + " might not be set correctly. Download might not be possible with encryption.")
}
}
}
} else {
fmt.Println("Saving new files to local storage")
}
}
// Checks for command line arguments that have to be parsed after loading the configuration
func reconfigureServer(passedFlags flagparser.MainFlags) bool {
if passedFlags.Reconfigure {
logging.LogSetup()
setup.RunConfigModification()
return true
}
return false
}
func createSsl(passedFlags flagparser.MainFlags) {
if passedFlags.CreateSsl {
ssl.GenerateIfInvalidCert(configuration.Get().ServerUrl, true)
}
}
func checkIfUserExists() {
if len(database.GetAllUsers()) == 0 {
fmt.Println("No user found in database. Please run setup first or create user with --deployment-password")
os.Exit(1)
}
}
func handleDbMigration(passedFlags flagparser.MainFlags) {
if !passedFlags.Migration.DoMigration {
return
}
migration.Do(passedFlags.Migration)
osExit(0)
}
func handleServiceInstall(passedFlags flagparser.MainFlags) {
if passedFlags.InstallService && passedFlags.UninstallService {
fmt.Println("Error: Both install and uninstall flags are set.")
osExit(1)
}
if passedFlags.InstallService {
systemd.InstallService()
osExit(0)
}
if passedFlags.UninstallService {
systemd.UninstallService()
osExit(0)
}
}
func setDeploymentPassword(passedFlags flagparser.MainFlags) {
if passedFlags.DeploymentPassword == "" {
return
}
logging.LogDeploymentPassword()
configuration.SetDeploymentPassword(passedFlags.DeploymentPassword)
}
var osExit = os.Exit
// ASCII art logo
const logo = `
██████  ██████   ██  ██  █████  ██████  ██ 
██       ██    ██ ██  ██  ██   ██ ██   ██ ██ 
██  ███ ██  ██ █████   ███████ ██████  ██ 
██  ██ ██  ██ ██  ██  ██   ██ ██      ██ 
 ██████   ██████  ██  ██ ██  ██ ██  ██ 
`