mirror of
https://codeberg.org/forgejo/forgejo
synced 2024-08-19 06:01:31 +02:00
As the docs of codeberg refer to the strings printed by the Forgejo ssh servers, this is user-facing and is nice to update to the new product name. (cherry picked from commit103991d73f
) (cherry picked from commit2a0d3f85f1
) (cherry picked from commiteb2b4ce388
) (cherry picked from commit0998b51716
) [BRANDING] forgejo log message (cherry picked from commitd51a046ebe
) (cherry picked from commitd66e1c7b6e
) (cherry picked from commitb5bffe4ce8
) (cherry picked from commit3fa776d856
) (cherry picked from commit18d064f472
) (cherry picked from commitc95094e355
) (cherry picked from commit5784290bc4
) (cherry picked from commitaee336886b
) (cherry picked from commitec2f60b516
) (cherry picked from commit7af742a284
) (cherry picked from commitf279e2a264
) (cherry picked from commitfd38cfb14e
) (cherry picked from commit64c8226618
) (cherry picked from commitb546fb2304
) (cherry picked from commitad10202177
) (cherry picked from commitc89cab9c2b
) (cherry picked from commit9579322ec2
) (cherry picked from commit16b44ad18d
) (cherry picked from commit2571ff703b
) (cherry picked from commitad61d9ce9b
) (cherry picked from commit9b2c45d4d3
) (cherry picked from commited01b79a59
) (cherry picked from commitd040b66427
) (cherry picked from commitffe0bbea48
) (cherry picked from commit4c1b2c409b
) (cherry picked from commit3d8338ed10
) (cherry picked from commita92f044ea9
) [BRANDING] link to forgejo.org/docs instead of docs.gitea.io (cherry picked from commit3efafd0e08
) (cherry picked from commit148185e34b
) (cherry picked from commit834e264698
) (cherry picked from commite72fa6eb1e
) [BRANDING] link to forgejo.org/docs instead of docs.gitea.io Fix the link that was 404. (cherry picked from commitae515d7258
) (cherry picked from commitfacc2367f0
) (cherry picked from commit25784b9f21
) (cherry picked from commit2efc6138d9
) (cherry picked from commitb9d0871631
) (cherry picked from commitf0446e51b9
) (cherry picked from commit1638aa67fb
) (cherry picked from commit290db6a018
) (cherry picked from commit89b87cf542
) (cherry picked from commit656ed94962
) (cherry picked from commit036f879f96
) (cherry picked from commit69eea35f81
) (cherry picked from commitb72e3f4a92
) (cherry picked from commitaf606b8574
) (cherry picked from commit7e47f8135c
) (cherry picked from commit0e5218cc53
) (cherry picked from commit7c2a20a528
) (cherry picked from commit4e94006363
) (cherry picked from commite47cdfc43f
) (cherry picked from commit1dcb3e1da4
) (cherry picked from commit67367c4e0f
) (cherry picked from commit252087d1ff
) (cherry picked from commitf5977a43e5
) Conflicts: templates/base/head_navbar.tmpl https://codeberg.org/forgejo/forgejo/pulls/1351 (cherry picked from commit594938eb15
) (cherry picked from commit0257d038a7
) (cherry picked from commit72821dd140
) [BRANDING] s/gitea/forgejo/ in HTML placeholders Replaced Gitea branding with Forgejo for input placeholders Closes: #686 Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/752 (cherry picked from commit6160d37ca9
) (cherry picked from commitdf61138c7e
) (cherry picked from commit1f30566c3f
) (cherry picked from commit539bb825f5
) (cherry picked from commitbee0f66c86
) (cherry picked from commit60ad005c95
) (cherry picked from commit282e26222e
) (cherry picked from commitf9ca551f3d
) (cherry picked from commitb2e04b04c3
) (cherry picked from commitc8f395a03c
) (cherry picked from commit0d58ce49ae
) (cherry picked from commitc602ddf91e
) (cherry picked from commit029e37271e
) (cherry picked from commitfdaa96b3cc
) (cherry picked from commit515d99e27d
) (cherry picked from commitda73274ba1
) (cherry picked from commitce90b696a0
) (cherry picked from commitb6bf98763b
) (cherry picked from commit5b380d22d7
) [BRANDING] How to start a runner: URL to Actions admin documentation (cherry picked from commitda91799e6f
) (cherry picked from commit28231663b6
) (cherry picked from commit533a90345b
) (cherry picked from commit6a0e4e55dd
) (cherry picked from commitf47cd611c6
) (cherry picked from commit001264b784
) (cherry picked from commite4099e9bb9
) (cherry picked from commit3a1885649f
) (cherry picked from commitc42802c710
) (cherry picked from commita611ce8d6d
) (cherry picked from commita3d7d10a80
) (cherry picked from commit52adde671f
) (cherry picked from commitc9a3820fef
) (cherry picked from commitdce40997c9
) (cherry picked from commit312a6b92f3
) [BRANDING] package templates & links - Change Gitea to Forgejo where necessary. - Point all documentation to Forgejo's documentation. - Resolves #992 (cherry picked from commitd0b78a6ede
) (cherry picked from commite2382f30ba
) (cherry picked from commitc41cf05a33
) (cherry picked from commit797e598ae7
) (cherry picked from commit970031a1c2
) (cherry picked from commit0c1180e2e1
) Conflicts: templates/package/content/alpine.tmpl templates/package/content/cargo.tmpl templates/package/content/chef.tmpl templates/package/content/composer.tmpl templates/package/content/conan.tmpl templates/package/content/conda.tmpl templates/package/content/container.tmpl templates/package/content/cran.tmpl templates/package/content/debian.tmpl templates/package/content/generic.tmpl templates/package/content/go.tmpl templates/package/content/helm.tmpl templates/package/content/maven.tmpl templates/package/content/npm.tmpl templates/package/content/nuget.tmpl templates/package/content/pub.tmpl templates/package/content/pypi.tmpl templates/package/content/rpm.tmpl templates/package/content/rubygems.tmpl templates/package/content/swift.tmpl templates/package/content/vagrant.tmpl https://codeberg.org/forgejo/forgejo/pulls/1351 (cherry picked from commit42ac9ff2ab
) (cherry picked from commite390000bce
) (cherry picked from commit56a437b29b
) Conflicts: templates/package/content/cargo.tmpl https://codeberg.org/forgejo/forgejo/pulls/1466 [BRANDING] s/Gitea/Forgejo/ in user visible help & comments - Modify the README of the docker directory to point to the relevant docker files and documentation for Forgejo. (cherry picked from commitaca6371215
) (cherry picked from commit0ba96b1bc4
) (cherry picked from commit5c8e6b53f1
) Conflicts: docker/README.md https://codeberg.org/forgejo/forgejo/pulls/1351 (cherry picked from commitb3121c8004
) (cherry picked from commit607f870416
) (cherry picked from commit191d96afe4
) [BRANDING] healthcheck/check.go (cherry picked from commitd703a236ce
) (cherry picked from commitd84ce3ff20
) (cherry picked from commit2dbb844606
) (cherry picked from commit14d3ae7e3a
) [BRANDING] s/Gitea/Forgejo/g in CLI output (cherry picked from commit7543c126bb
) (cherry picked from commitb66f422fc3
) (cherry picked from commita81e4e46f3
) [BRANDING] Gitea->Forgejo in mailer code (cherry picked from commitb91afea4ff
) (cherry picked from commit5d7428167c
) (cherry picked from commited8101ba6c
) [BRANDING] use 'Forgejo' for Discord, Packagist, and Slack webhooks Refs: https://codeberg.org/forgejo/forgejo/issues/1387 (cherry picked from commit7dc3a05f5b
) (cherry picked from commit133f2fc6cc
) [BRANDING] cmd/manager.go (cherry picked from commitd1dba2c79d
) [BRANDING] pyproject.toml (cherry picked from commit7e8c868db2
) (cherry picked from commit2395995c8b
) (cherry picked from commitdd6fbbf332
) Conflicts: templates/package/content/cargo.tmpl https://codeberg.org/forgejo/forgejo/pulls/1548 (cherry picked from commit6f9a5d5cab
) (cherry picked from commitd0635c4a07
) (cherry picked from commit5d3b4594df
) (cherry picked from commit6da3b43eff
) (cherry picked from commitb60dfaba10
) (cherry picked from commitbcb9bb4dee
) (cherry picked from commitd5301b6a24
)
358 lines
11 KiB
Go
358 lines
11 KiB
Go
// Copyright 2014 The Gogs Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package cmd
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net"
|
|
"net/http"
|
|
"os"
|
|
"path/filepath"
|
|
"strconv"
|
|
"strings"
|
|
|
|
_ "net/http/pprof" // Used for debugging if enabled and a web server is running
|
|
|
|
"code.gitea.io/gitea/modules/container"
|
|
"code.gitea.io/gitea/modules/graceful"
|
|
"code.gitea.io/gitea/modules/log"
|
|
"code.gitea.io/gitea/modules/process"
|
|
"code.gitea.io/gitea/modules/public"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
"code.gitea.io/gitea/routers"
|
|
"code.gitea.io/gitea/routers/install"
|
|
|
|
"github.com/felixge/fgprof"
|
|
"github.com/urfave/cli/v2"
|
|
)
|
|
|
|
// PIDFile could be set from build tag
|
|
var PIDFile = "/run/gitea.pid"
|
|
|
|
// CmdWeb represents the available web sub-command.
|
|
var CmdWeb = &cli.Command{
|
|
Name: "web",
|
|
Usage: "Start the Forgejo web server",
|
|
Description: `The Forgejo web server is the only thing you need to run,
|
|
and it takes care of all the other things for you`,
|
|
Before: PrepareConsoleLoggerLevel(log.INFO),
|
|
Action: runWeb,
|
|
Flags: []cli.Flag{
|
|
&cli.StringFlag{
|
|
Name: "port",
|
|
Aliases: []string{"p"},
|
|
Value: "3000",
|
|
Usage: "Temporary port number to prevent conflict",
|
|
},
|
|
&cli.StringFlag{
|
|
Name: "install-port",
|
|
Value: "3000",
|
|
Usage: "Temporary port number to run the install page on to prevent conflict",
|
|
},
|
|
&cli.StringFlag{
|
|
Name: "pid",
|
|
Aliases: []string{"P"},
|
|
Value: PIDFile,
|
|
Usage: "Custom pid file path",
|
|
},
|
|
&cli.BoolFlag{
|
|
Name: "quiet",
|
|
Aliases: []string{"q"},
|
|
Usage: "Only display Fatal logging errors until logging is set-up",
|
|
},
|
|
&cli.BoolFlag{
|
|
Name: "verbose",
|
|
Usage: "Set initial logging to TRACE level until logging is properly set-up",
|
|
},
|
|
},
|
|
}
|
|
|
|
func runHTTPRedirector() {
|
|
_, _, finished := process.GetManager().AddTypedContext(graceful.GetManager().HammerContext(), "Web: HTTP Redirector", process.SystemProcessType, true)
|
|
defer finished()
|
|
|
|
source := fmt.Sprintf("%s:%s", setting.HTTPAddr, setting.PortToRedirect)
|
|
dest := strings.TrimSuffix(setting.AppURL, "/")
|
|
log.Info("Redirecting: %s to %s", source, dest)
|
|
|
|
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
target := dest + r.URL.Path
|
|
if len(r.URL.RawQuery) > 0 {
|
|
target += "?" + r.URL.RawQuery
|
|
}
|
|
http.Redirect(w, r, target, http.StatusTemporaryRedirect)
|
|
})
|
|
|
|
err := runHTTP("tcp", source, "HTTP Redirector", handler, setting.RedirectorUseProxyProtocol)
|
|
if err != nil {
|
|
log.Fatal("Failed to start port redirection: %v", err)
|
|
}
|
|
}
|
|
|
|
func createPIDFile(pidPath string) {
|
|
currentPid := os.Getpid()
|
|
if err := os.MkdirAll(filepath.Dir(pidPath), os.ModePerm); err != nil {
|
|
log.Fatal("Failed to create PID folder: %v", err)
|
|
}
|
|
|
|
file, err := os.Create(pidPath)
|
|
if err != nil {
|
|
log.Fatal("Failed to create PID file: %v", err)
|
|
}
|
|
defer file.Close()
|
|
if _, err := file.WriteString(strconv.FormatInt(int64(currentPid), 10)); err != nil {
|
|
log.Fatal("Failed to write PID information: %v", err)
|
|
}
|
|
}
|
|
|
|
func showWebStartupMessage(msg string) {
|
|
log.Info("Forgejo version: %s%s", setting.AppVer, setting.AppBuiltWith)
|
|
log.Info("* RunMode: %s", setting.RunMode)
|
|
log.Info("* AppPath: %s", setting.AppPath)
|
|
log.Info("* WorkPath: %s", setting.AppWorkPath)
|
|
log.Info("* CustomPath: %s", setting.CustomPath)
|
|
log.Info("* ConfigFile: %s", setting.CustomConf)
|
|
log.Info("%s", msg)
|
|
}
|
|
|
|
func serveInstall(ctx *cli.Context) error {
|
|
showWebStartupMessage("Prepare to run install page")
|
|
|
|
routers.InitWebInstallPage(graceful.GetManager().HammerContext())
|
|
|
|
// Flag for port number in case first time run conflict
|
|
if ctx.IsSet("port") {
|
|
if err := setPort(ctx.String("port")); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
if ctx.IsSet("install-port") {
|
|
if err := setPort(ctx.String("install-port")); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
c := install.Routes()
|
|
err := listen(c, false)
|
|
if err != nil {
|
|
log.Critical("Unable to open listener for installer. Is Forgejo already running?")
|
|
graceful.GetManager().DoGracefulShutdown()
|
|
}
|
|
select {
|
|
case <-graceful.GetManager().IsShutdown():
|
|
<-graceful.GetManager().Done()
|
|
log.Info("PID: %d Forgejo Web Finished", os.Getpid())
|
|
log.GetManager().Close()
|
|
return err
|
|
default:
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func serveInstalled(ctx *cli.Context) error {
|
|
setting.InitCfgProvider(setting.CustomConf)
|
|
setting.LoadCommonSettings()
|
|
setting.MustInstalled()
|
|
|
|
showWebStartupMessage("Prepare to run web server")
|
|
|
|
if setting.AppWorkPathMismatch {
|
|
log.Error("WORK_PATH from config %q doesn't match other paths from environment variables or command arguments. "+
|
|
"Only WORK_PATH in config should be set and used. Please make sure the path in config file is correct, "+
|
|
"remove the other outdated work paths from environment variables and command arguments", setting.CustomConf)
|
|
}
|
|
|
|
rootCfg := setting.CfgProvider
|
|
if rootCfg.Section("").Key("WORK_PATH").String() == "" {
|
|
saveCfg, err := rootCfg.PrepareSaving()
|
|
if err != nil {
|
|
log.Error("Unable to prepare saving WORK_PATH=%s to config %q: %v\nYou should set it manually, otherwise there might be bugs when accessing the git repositories.", setting.AppWorkPath, setting.CustomConf, err)
|
|
} else {
|
|
rootCfg.Section("").Key("WORK_PATH").SetValue(setting.AppWorkPath)
|
|
saveCfg.Section("").Key("WORK_PATH").SetValue(setting.AppWorkPath)
|
|
if err = saveCfg.Save(); err != nil {
|
|
log.Error("Unable to update WORK_PATH=%s to config %q: %v\nYou should set it manually, otherwise there might be bugs when accessing the git repositories.", setting.AppWorkPath, setting.CustomConf, err)
|
|
}
|
|
}
|
|
}
|
|
|
|
// in old versions, user's custom web files are placed in "custom/public", and they were served as "http://domain.com/assets/xxx"
|
|
// now, Gitea only serves pre-defined files in the "custom/public" folder basing on the web root, the user should move their custom files to "custom/public/assets"
|
|
publicFiles, _ := public.AssetFS().ListFiles(".")
|
|
publicFilesSet := container.SetOf(publicFiles...)
|
|
publicFilesSet.Remove(".well-known")
|
|
publicFilesSet.Remove("assets")
|
|
publicFilesSet.Remove("robots.txt")
|
|
for _, fn := range publicFilesSet.Values() {
|
|
log.Error("Found legacy public asset %q in CustomPath. Please move it to %s/public/assets/%s", fn, setting.CustomPath, fn)
|
|
}
|
|
if _, err := os.Stat(filepath.Join(setting.CustomPath, "robots.txt")); err == nil {
|
|
log.Error(`Found legacy public asset "robots.txt" in CustomPath. Please move it to %s/public/robots.txt`, setting.CustomPath)
|
|
}
|
|
|
|
routers.InitWebInstalled(graceful.GetManager().HammerContext())
|
|
|
|
// We check that AppDataPath exists here (it should have been created during installation)
|
|
// We can't check it in `InitWebInstalled`, because some integration tests
|
|
// use cmd -> InitWebInstalled, but the AppDataPath doesn't exist during those tests.
|
|
if _, err := os.Stat(setting.AppDataPath); err != nil {
|
|
log.Fatal("Can not find APP_DATA_PATH %q", setting.AppDataPath)
|
|
}
|
|
|
|
// Override the provided port number within the configuration
|
|
if ctx.IsSet("port") {
|
|
if err := setPort(ctx.String("port")); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
// Set up Chi routes
|
|
webRoutes := routers.NormalRoutes()
|
|
err := listen(webRoutes, true)
|
|
<-graceful.GetManager().Done()
|
|
log.Info("PID: %d Forgejo Web Finished", os.Getpid())
|
|
log.GetManager().Close()
|
|
return err
|
|
}
|
|
|
|
func servePprof() {
|
|
http.DefaultServeMux.Handle("/debug/fgprof", fgprof.Handler())
|
|
_, _, finished := process.GetManager().AddTypedContext(context.Background(), "Web: PProf Server", process.SystemProcessType, true)
|
|
// The pprof server is for debug purpose only, it shouldn't be exposed on public network. At the moment it's not worth to introduce a configurable option for it.
|
|
log.Info("Starting pprof server on localhost:6060")
|
|
log.Info("Stopped pprof server: %v", http.ListenAndServe("localhost:6060", nil))
|
|
finished()
|
|
}
|
|
|
|
func runWeb(ctx *cli.Context) error {
|
|
defer func() {
|
|
if panicked := recover(); panicked != nil {
|
|
log.Fatal("PANIC: %v\n%s", panicked, log.Stack(2))
|
|
}
|
|
}()
|
|
|
|
managerCtx, cancel := context.WithCancel(context.Background())
|
|
graceful.InitManager(managerCtx)
|
|
defer cancel()
|
|
|
|
if os.Getppid() > 1 && len(os.Getenv("LISTEN_FDS")) > 0 {
|
|
log.Info("Restarting Forgejo on PID: %d from parent PID: %d", os.Getpid(), os.Getppid())
|
|
} else {
|
|
log.Info("Starting Forgejo on PID: %d", os.Getpid())
|
|
}
|
|
|
|
// Set pid file setting
|
|
if ctx.IsSet("pid") {
|
|
createPIDFile(ctx.String("pid"))
|
|
}
|
|
|
|
if !setting.InstallLock {
|
|
if err := serveInstall(ctx); err != nil {
|
|
return err
|
|
}
|
|
} else {
|
|
NoInstallListener()
|
|
}
|
|
|
|
if setting.EnablePprof {
|
|
go servePprof()
|
|
}
|
|
|
|
return serveInstalled(ctx)
|
|
}
|
|
|
|
func setPort(port string) error {
|
|
setting.AppURL = strings.Replace(setting.AppURL, setting.HTTPPort, port, 1)
|
|
setting.HTTPPort = port
|
|
|
|
switch setting.Protocol {
|
|
case setting.HTTPUnix:
|
|
case setting.FCGI:
|
|
case setting.FCGIUnix:
|
|
default:
|
|
defaultLocalURL := string(setting.Protocol) + "://"
|
|
if setting.HTTPAddr == "0.0.0.0" {
|
|
defaultLocalURL += "localhost"
|
|
} else {
|
|
defaultLocalURL += setting.HTTPAddr
|
|
}
|
|
defaultLocalURL += ":" + setting.HTTPPort + "/"
|
|
|
|
// Save LOCAL_ROOT_URL if port changed
|
|
rootCfg := setting.CfgProvider
|
|
saveCfg, err := rootCfg.PrepareSaving()
|
|
if err != nil {
|
|
return fmt.Errorf("failed to save config file: %v", err)
|
|
}
|
|
rootCfg.Section("server").Key("LOCAL_ROOT_URL").SetValue(defaultLocalURL)
|
|
saveCfg.Section("server").Key("LOCAL_ROOT_URL").SetValue(defaultLocalURL)
|
|
if err = saveCfg.Save(); err != nil {
|
|
return fmt.Errorf("failed to save config file: %v", err)
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func listen(m http.Handler, handleRedirector bool) error {
|
|
listenAddr := setting.HTTPAddr
|
|
if setting.Protocol != setting.HTTPUnix && setting.Protocol != setting.FCGIUnix {
|
|
listenAddr = net.JoinHostPort(listenAddr, setting.HTTPPort)
|
|
}
|
|
_, _, finished := process.GetManager().AddTypedContext(graceful.GetManager().HammerContext(), "Web: Forgejo Server", process.SystemProcessType, true)
|
|
defer finished()
|
|
log.Info("Listen: %v://%s%s", setting.Protocol, listenAddr, setting.AppSubURL)
|
|
// This can be useful for users, many users do wrong to their config and get strange behaviors behind a reverse-proxy.
|
|
// A user may fix the configuration mistake when he sees this log.
|
|
// And this is also very helpful to maintainers to provide help to users to resolve their configuration problems.
|
|
log.Info("AppURL(ROOT_URL): %s", setting.AppURL)
|
|
|
|
if setting.LFS.StartServer {
|
|
log.Info("LFS server enabled")
|
|
}
|
|
|
|
var err error
|
|
switch setting.Protocol {
|
|
case setting.HTTP:
|
|
if handleRedirector {
|
|
NoHTTPRedirector()
|
|
}
|
|
err = runHTTP("tcp", listenAddr, "Web", m, setting.UseProxyProtocol)
|
|
case setting.HTTPS:
|
|
if setting.EnableAcme {
|
|
err = runACME(listenAddr, m)
|
|
break
|
|
}
|
|
if handleRedirector {
|
|
if setting.RedirectOtherPort {
|
|
go runHTTPRedirector()
|
|
} else {
|
|
NoHTTPRedirector()
|
|
}
|
|
}
|
|
err = runHTTPS("tcp", listenAddr, "Web", setting.CertFile, setting.KeyFile, m, setting.UseProxyProtocol, setting.ProxyProtocolTLSBridging)
|
|
case setting.FCGI:
|
|
if handleRedirector {
|
|
NoHTTPRedirector()
|
|
}
|
|
err = runFCGI("tcp", listenAddr, "FCGI Web", m, setting.UseProxyProtocol)
|
|
case setting.HTTPUnix:
|
|
if handleRedirector {
|
|
NoHTTPRedirector()
|
|
}
|
|
err = runHTTP("unix", listenAddr, "Web", m, setting.UseProxyProtocol)
|
|
case setting.FCGIUnix:
|
|
if handleRedirector {
|
|
NoHTTPRedirector()
|
|
}
|
|
err = runFCGI("unix", listenAddr, "Web", m, setting.UseProxyProtocol)
|
|
default:
|
|
log.Fatal("Invalid protocol: %s", setting.Protocol)
|
|
}
|
|
if err != nil {
|
|
log.Critical("Failed to start server: %v", err)
|
|
}
|
|
log.Info("HTTP Listener: %s Closed", listenAddr)
|
|
return err
|
|
}
|