install.go 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429
  1. // Copyright 2014 The Gogs Authors. All rights reserved.
  2. // Use of this source code is governed by a MIT-style
  3. // license that can be found in the LICENSE file.
  4. package route
  5. import (
  6. "net/mail"
  7. "os"
  8. "os/exec"
  9. "path/filepath"
  10. "strings"
  11. "github.com/gogs/git-module"
  12. "github.com/pkg/errors"
  13. "github.com/unknwon/com"
  14. "gopkg.in/ini.v1"
  15. "gopkg.in/macaron.v1"
  16. log "unknwon.dev/clog/v2"
  17. "gogs.io/gogs/internal/conf"
  18. "gogs.io/gogs/internal/context"
  19. "gogs.io/gogs/internal/cron"
  20. "gogs.io/gogs/internal/database"
  21. "gogs.io/gogs/internal/email"
  22. "gogs.io/gogs/internal/form"
  23. "gogs.io/gogs/internal/markup"
  24. "gogs.io/gogs/internal/osutil"
  25. "gogs.io/gogs/internal/ssh"
  26. "gogs.io/gogs/internal/strutil"
  27. "gogs.io/gogs/internal/template/highlight"
  28. )
  29. const (
  30. INSTALL = "install"
  31. )
  32. func checkRunMode() {
  33. if conf.IsProdMode() {
  34. macaron.Env = macaron.PROD
  35. macaron.ColorLog = false
  36. git.SetOutput(nil)
  37. } else {
  38. git.SetOutput(os.Stdout)
  39. }
  40. log.Info("Run mode: %s", strings.Title(macaron.Env))
  41. }
  42. // GlobalInit is for global configuration reload-able.
  43. func GlobalInit(customConf string) error {
  44. err := conf.Init(customConf)
  45. if err != nil {
  46. return errors.Wrap(err, "init configuration")
  47. }
  48. conf.InitLogging(false)
  49. log.Info("%s %s", conf.App.BrandName, conf.App.Version)
  50. log.Trace("Work directory: %s", conf.WorkDir())
  51. log.Trace("Custom path: %s", conf.CustomDir())
  52. log.Trace("Custom config: %s", conf.CustomConf)
  53. log.Trace("Log path: %s", conf.Log.RootPath)
  54. log.Trace("Build time: %s", conf.BuildTime)
  55. log.Trace("Build commit: %s", conf.BuildCommit)
  56. if conf.Email.Enabled {
  57. log.Trace("Email service is enabled")
  58. }
  59. email.NewContext()
  60. if conf.Security.InstallLock {
  61. highlight.NewContext()
  62. markup.NewSanitizer()
  63. db, err := database.NewEngine()
  64. if err != nil {
  65. log.Fatal("Failed to initialize ORM engine: %v", err)
  66. }
  67. database.SetHandle(db)
  68. database.HasEngine = true
  69. database.LoadRepoConfig()
  70. database.NewRepoContext()
  71. // Booting long running goroutines.
  72. cron.NewContext()
  73. database.InitSyncMirrors()
  74. database.InitDeliverHooks()
  75. database.InitTestPullRequests()
  76. }
  77. if conf.HasMinWinSvc {
  78. log.Info("Builtin Windows Service is supported")
  79. }
  80. if conf.Server.LoadAssetsFromDisk {
  81. log.Trace("Assets are loaded from disk")
  82. }
  83. checkRunMode()
  84. if !conf.Security.InstallLock {
  85. return nil
  86. }
  87. if conf.SSH.StartBuiltinServer {
  88. ssh.Listen(conf.SSH, conf.Server.AppDataPath)
  89. log.Info("SSH server started on %s:%v", conf.SSH.ListenHost, conf.SSH.ListenPort)
  90. log.Trace("SSH server cipher list: %v", conf.SSH.ServerCiphers)
  91. log.Trace("SSH server MAC list: %v", conf.SSH.ServerMACs)
  92. log.Trace("SSH server algorithms: %v", conf.SSH.ServerAlgorithms)
  93. }
  94. if conf.SSH.RewriteAuthorizedKeysAtStart {
  95. if err := database.RewriteAuthorizedKeys(); err != nil {
  96. log.Warn("Failed to rewrite authorized_keys file: %v", err)
  97. }
  98. }
  99. return nil
  100. }
  101. func InstallInit(c *context.Context) {
  102. if conf.Security.InstallLock {
  103. c.NotFound()
  104. return
  105. }
  106. c.Title("install.install")
  107. c.PageIs("Install")
  108. c.Data["DbOptions"] = []string{"MySQL", "PostgreSQL", "SQLite3"}
  109. }
  110. func Install(c *context.Context) {
  111. f := form.Install{}
  112. // Database settings
  113. f.DbHost = conf.Database.Host
  114. f.DbUser = conf.Database.User
  115. f.DbName = conf.Database.Name
  116. f.DbSchema = conf.Database.Schema
  117. f.DbPath = conf.Database.Path
  118. c.Data["CurDbOption"] = "PostgreSQL"
  119. switch conf.Database.Type {
  120. case "mysql":
  121. c.Data["CurDbOption"] = "MySQL"
  122. case "sqlite3":
  123. c.Data["CurDbOption"] = "SQLite3"
  124. }
  125. // Application general settings
  126. f.AppName = conf.App.BrandName
  127. f.RepoRootPath = conf.Repository.Root
  128. // Note(unknwon): it's hard for Windows users change a running user,
  129. // so just use current one if config says default.
  130. if conf.IsWindowsRuntime() && conf.App.RunUser == "git" {
  131. f.RunUser = osutil.CurrentUsername()
  132. } else {
  133. f.RunUser = conf.App.RunUser
  134. }
  135. f.Domain = conf.Server.Domain
  136. f.SSHPort = conf.SSH.Port
  137. f.UseBuiltinSSHServer = conf.SSH.StartBuiltinServer
  138. f.HTTPPort = conf.Server.HTTPPort
  139. f.AppUrl = conf.Server.ExternalURL
  140. f.LogRootPath = conf.Log.RootPath
  141. f.DefaultBranch = conf.Repository.DefaultBranch
  142. // E-mail service settings
  143. if conf.Email.Enabled {
  144. f.SMTPHost = conf.Email.Host
  145. f.SMTPFrom = conf.Email.From
  146. f.SMTPUser = conf.Email.User
  147. }
  148. f.RegisterConfirm = conf.Auth.RequireEmailConfirmation
  149. f.MailNotify = conf.User.EnableEmailNotification
  150. // Server and other services settings
  151. f.OfflineMode = conf.Server.OfflineMode
  152. f.DisableGravatar = conf.Picture.DisableGravatar
  153. f.EnableFederatedAvatar = conf.Picture.EnableFederatedAvatar
  154. f.DisableRegistration = conf.Auth.DisableRegistration
  155. f.EnableCaptcha = conf.Auth.EnableRegistrationCaptcha
  156. f.RequireSignInView = conf.Auth.RequireSigninView
  157. form.Assign(f, c.Data)
  158. c.Success(INSTALL)
  159. }
  160. func InstallPost(c *context.Context, f form.Install) {
  161. c.Data["CurDbOption"] = f.DbType
  162. if c.HasError() {
  163. if c.HasValue("Err_SMTPEmail") {
  164. c.FormErr("SMTP")
  165. }
  166. if c.HasValue("Err_AdminName") ||
  167. c.HasValue("Err_AdminPasswd") ||
  168. c.HasValue("Err_AdminEmail") {
  169. c.FormErr("Admin")
  170. }
  171. c.Success(INSTALL)
  172. return
  173. }
  174. if _, err := exec.LookPath("git"); err != nil {
  175. c.RenderWithErr(c.Tr("install.test_git_failed", err), INSTALL, &f)
  176. return
  177. }
  178. // Pass basic check, now test configuration.
  179. // Test database setting.
  180. dbTypes := map[string]string{
  181. "PostgreSQL": "postgres",
  182. "MySQL": "mysql",
  183. "SQLite3": "sqlite3",
  184. }
  185. conf.Database.Type = dbTypes[f.DbType]
  186. conf.Database.Host = f.DbHost
  187. conf.Database.User = f.DbUser
  188. conf.Database.Password = f.DbPasswd
  189. conf.Database.Name = f.DbName
  190. conf.Database.Schema = f.DbSchema
  191. conf.Database.SSLMode = f.SSLMode
  192. conf.Database.Path = f.DbPath
  193. if conf.Database.Type == "sqlite3" && conf.Database.Path == "" {
  194. c.FormErr("DbPath")
  195. c.RenderWithErr(c.Tr("install.err_empty_db_path"), INSTALL, &f)
  196. return
  197. }
  198. // Set test engine.
  199. if err := database.NewTestEngine(); err != nil {
  200. if strings.Contains(err.Error(), `Unknown database type: sqlite3`) {
  201. c.FormErr("DbType")
  202. c.RenderWithErr(c.Tr("install.sqlite3_not_available", "https://gogs.io/docs/installation/install_from_binary.html"), INSTALL, &f)
  203. } else {
  204. c.FormErr("DbSetting")
  205. c.RenderWithErr(c.Tr("install.invalid_db_setting", err), INSTALL, &f)
  206. }
  207. return
  208. }
  209. // Test repository root path.
  210. f.RepoRootPath = strings.ReplaceAll(f.RepoRootPath, "\\", "/")
  211. if err := os.MkdirAll(f.RepoRootPath, os.ModePerm); err != nil {
  212. c.FormErr("RepoRootPath")
  213. c.RenderWithErr(c.Tr("install.invalid_repo_path", err), INSTALL, &f)
  214. return
  215. }
  216. // Test log root path.
  217. f.LogRootPath = strings.ReplaceAll(f.LogRootPath, "\\", "/")
  218. if err := os.MkdirAll(f.LogRootPath, os.ModePerm); err != nil {
  219. c.FormErr("LogRootPath")
  220. c.RenderWithErr(c.Tr("install.invalid_log_root_path", err), INSTALL, &f)
  221. return
  222. }
  223. currentUser, match := conf.CheckRunUser(f.RunUser)
  224. if !match {
  225. c.FormErr("RunUser")
  226. c.RenderWithErr(c.Tr("install.run_user_not_match", f.RunUser, currentUser), INSTALL, &f)
  227. return
  228. }
  229. // Check host address and port
  230. if len(f.SMTPHost) > 0 && !strings.Contains(f.SMTPHost, ":") {
  231. c.FormErr("SMTP", "SMTPHost")
  232. c.RenderWithErr(c.Tr("install.smtp_host_missing_port"), INSTALL, &f)
  233. return
  234. }
  235. // Make sure FROM field is valid
  236. if len(f.SMTPFrom) > 0 {
  237. _, err := mail.ParseAddress(f.SMTPFrom)
  238. if err != nil {
  239. c.FormErr("SMTP", "SMTPFrom")
  240. c.RenderWithErr(c.Tr("install.invalid_smtp_from", err), INSTALL, &f)
  241. return
  242. }
  243. }
  244. // Check logic loophole between disable self-registration and no admin account.
  245. if f.DisableRegistration && f.AdminName == "" {
  246. c.FormErr("Services", "Admin")
  247. c.RenderWithErr(c.Tr("install.no_admin_and_disable_registration"), INSTALL, f)
  248. return
  249. }
  250. // Check admin password.
  251. if len(f.AdminName) > 0 && f.AdminPasswd == "" {
  252. c.FormErr("Admin", "AdminPasswd")
  253. c.RenderWithErr(c.Tr("install.err_empty_admin_password"), INSTALL, f)
  254. return
  255. }
  256. if f.AdminPasswd != f.AdminConfirmPasswd {
  257. c.FormErr("Admin", "AdminPasswd")
  258. c.RenderWithErr(c.Tr("form.password_not_match"), INSTALL, f)
  259. return
  260. }
  261. if f.AppUrl[len(f.AppUrl)-1] != '/' {
  262. f.AppUrl += "/"
  263. }
  264. // Save settings.
  265. cfg := ini.Empty()
  266. if osutil.IsFile(conf.CustomConf) {
  267. // Keeps custom settings if there is already something.
  268. if err := cfg.Append(conf.CustomConf); err != nil {
  269. log.Error("Failed to load custom conf %q: %v", conf.CustomConf, err)
  270. }
  271. }
  272. cfg.Section("database").Key("TYPE").SetValue(conf.Database.Type)
  273. cfg.Section("database").Key("HOST").SetValue(conf.Database.Host)
  274. cfg.Section("database").Key("NAME").SetValue(conf.Database.Name)
  275. cfg.Section("database").Key("SCHEMA").SetValue(conf.Database.Schema)
  276. cfg.Section("database").Key("USER").SetValue(conf.Database.User)
  277. cfg.Section("database").Key("PASSWORD").SetValue(conf.Database.Password)
  278. cfg.Section("database").Key("SSL_MODE").SetValue(conf.Database.SSLMode)
  279. cfg.Section("database").Key("PATH").SetValue(conf.Database.Path)
  280. cfg.Section("").Key("BRAND_NAME").SetValue(f.AppName)
  281. cfg.Section("repository").Key("ROOT").SetValue(f.RepoRootPath)
  282. cfg.Section("repository").Key("DEFAULT_BRANCH").SetValue(f.DefaultBranch)
  283. cfg.Section("").Key("RUN_USER").SetValue(f.RunUser)
  284. cfg.Section("server").Key("DOMAIN").SetValue(f.Domain)
  285. cfg.Section("server").Key("HTTP_PORT").SetValue(f.HTTPPort)
  286. cfg.Section("server").Key("EXTERNAL_URL").SetValue(f.AppUrl)
  287. if f.SSHPort == 0 {
  288. cfg.Section("server").Key("DISABLE_SSH").SetValue("true")
  289. } else {
  290. cfg.Section("server").Key("DISABLE_SSH").SetValue("false")
  291. cfg.Section("server").Key("SSH_PORT").SetValue(com.ToStr(f.SSHPort))
  292. cfg.Section("server").Key("START_SSH_SERVER").SetValue(com.ToStr(f.UseBuiltinSSHServer))
  293. }
  294. if len(strings.TrimSpace(f.SMTPHost)) > 0 {
  295. cfg.Section("mailer").Key("ENABLED").SetValue("true")
  296. cfg.Section("mailer").Key("HOST").SetValue(f.SMTPHost)
  297. cfg.Section("mailer").Key("FROM").SetValue(f.SMTPFrom)
  298. cfg.Section("mailer").Key("USER").SetValue(f.SMTPUser)
  299. cfg.Section("mailer").Key("PASSWD").SetValue(f.SMTPPasswd)
  300. } else {
  301. cfg.Section("mailer").Key("ENABLED").SetValue("false")
  302. }
  303. cfg.Section("server").Key("OFFLINE_MODE").SetValue(com.ToStr(f.OfflineMode))
  304. cfg.Section("auth").Key("REQUIRE_EMAIL_CONFIRMATION").SetValue(com.ToStr(f.RegisterConfirm))
  305. cfg.Section("auth").Key("DISABLE_REGISTRATION").SetValue(com.ToStr(f.DisableRegistration))
  306. cfg.Section("auth").Key("ENABLE_REGISTRATION_CAPTCHA").SetValue(com.ToStr(f.EnableCaptcha))
  307. cfg.Section("auth").Key("REQUIRE_SIGNIN_VIEW").SetValue(com.ToStr(f.RequireSignInView))
  308. cfg.Section("user").Key("ENABLE_EMAIL_NOTIFICATION").SetValue(com.ToStr(f.MailNotify))
  309. cfg.Section("picture").Key("DISABLE_GRAVATAR").SetValue(com.ToStr(f.DisableGravatar))
  310. cfg.Section("picture").Key("ENABLE_FEDERATED_AVATAR").SetValue(com.ToStr(f.EnableFederatedAvatar))
  311. cfg.Section("").Key("RUN_MODE").SetValue("prod")
  312. cfg.Section("session").Key("PROVIDER").SetValue("file")
  313. mode := "file"
  314. if f.EnableConsoleMode {
  315. mode = "console, file"
  316. }
  317. cfg.Section("log").Key("MODE").SetValue(mode)
  318. cfg.Section("log").Key("LEVEL").SetValue("Info")
  319. cfg.Section("log").Key("ROOT_PATH").SetValue(f.LogRootPath)
  320. cfg.Section("security").Key("INSTALL_LOCK").SetValue("true")
  321. secretKey, err := strutil.RandomChars(15)
  322. if err != nil {
  323. c.RenderWithErr(c.Tr("install.secret_key_failed", err), INSTALL, &f)
  324. return
  325. }
  326. cfg.Section("security").Key("SECRET_KEY").SetValue(secretKey)
  327. _ = os.MkdirAll(filepath.Dir(conf.CustomConf), os.ModePerm)
  328. if err := cfg.SaveTo(conf.CustomConf); err != nil {
  329. c.RenderWithErr(c.Tr("install.save_config_failed", err), INSTALL, &f)
  330. return
  331. }
  332. // NOTE: We reuse the current value because this handler does not have access to CLI flags.
  333. err = GlobalInit(conf.CustomConf)
  334. if err != nil {
  335. c.RenderWithErr(c.Tr("install.init_failed", err), INSTALL, &f)
  336. return
  337. }
  338. // Create admin account
  339. if len(f.AdminName) > 0 {
  340. user, err := database.Users.Create(
  341. c.Req.Context(),
  342. f.AdminName,
  343. f.AdminEmail,
  344. database.CreateUserOptions{
  345. Password: f.AdminPasswd,
  346. Activated: true,
  347. Admin: true,
  348. },
  349. )
  350. if err != nil {
  351. if !database.IsErrUserAlreadyExist(err) {
  352. conf.Security.InstallLock = false
  353. c.FormErr("AdminName", "AdminEmail")
  354. c.RenderWithErr(c.Tr("install.invalid_admin_setting", err), INSTALL, &f)
  355. return
  356. }
  357. log.Info("Admin account already exist")
  358. user, err = database.Users.GetByUsername(c.Req.Context(), f.AdminName)
  359. if err != nil {
  360. c.Error(err, "get user by name")
  361. return
  362. }
  363. }
  364. // Auto-login for admin
  365. _ = c.Session.Set("uid", user.ID)
  366. _ = c.Session.Set("uname", user.Name)
  367. }
  368. log.Info("First-time run install finished!")
  369. c.Flash.Success(c.Tr("install.install_success"))
  370. c.Redirect(f.AppUrl + "user/login")
  371. }