Fork to maintain patches against the official gitea for https://code.ceondo.com https://github.com/go-gitea/gitea

install.go 12KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364
  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 routers
  5. import (
  6. "errors"
  7. "os"
  8. "os/exec"
  9. "path"
  10. "path/filepath"
  11. "strings"
  12. "github.com/Unknwon/com"
  13. "github.com/go-xorm/xorm"
  14. "gopkg.in/ini.v1"
  15. "code.gitea.io/gitea/models"
  16. "code.gitea.io/gitea/modules/auth"
  17. "code.gitea.io/gitea/modules/base"
  18. "code.gitea.io/gitea/modules/context"
  19. "code.gitea.io/gitea/modules/log"
  20. "code.gitea.io/gitea/modules/setting"
  21. "code.gitea.io/gitea/modules/user"
  22. )
  23. const (
  24. // tplInstall template for installation page
  25. tplInstall base.TplName = "install"
  26. )
  27. // InstallInit prepare for rendering installation page
  28. func InstallInit(ctx *context.Context) {
  29. if setting.InstallLock {
  30. ctx.Handle(404, "Install", errors.New("Installation is prohibited"))
  31. return
  32. }
  33. ctx.Data["Title"] = ctx.Tr("install.install")
  34. ctx.Data["PageIsInstall"] = true
  35. dbOpts := []string{"MySQL", "PostgreSQL", "MSSQL"}
  36. if models.EnableSQLite3 {
  37. dbOpts = append(dbOpts, "SQLite3")
  38. }
  39. if models.EnableTiDB {
  40. dbOpts = append(dbOpts, "TiDB")
  41. }
  42. ctx.Data["DbOptions"] = dbOpts
  43. }
  44. // Install render installation page
  45. func Install(ctx *context.Context) {
  46. form := auth.InstallForm{}
  47. // Database settings
  48. form.DbHost = models.DbCfg.Host
  49. form.DbUser = models.DbCfg.User
  50. form.DbName = models.DbCfg.Name
  51. form.DbPath = models.DbCfg.Path
  52. ctx.Data["CurDbOption"] = "MySQL"
  53. switch models.DbCfg.Type {
  54. case "postgres":
  55. ctx.Data["CurDbOption"] = "PostgreSQL"
  56. case "mssql":
  57. ctx.Data["CurDbOption"] = "MSSQL"
  58. case "sqlite3":
  59. if models.EnableSQLite3 {
  60. ctx.Data["CurDbOption"] = "SQLite3"
  61. }
  62. case "tidb":
  63. if models.EnableTiDB {
  64. ctx.Data["CurDbOption"] = "TiDB"
  65. }
  66. }
  67. // Application general settings
  68. form.AppName = setting.AppName
  69. form.RepoRootPath = setting.RepoRootPath
  70. form.LFSRootPath = setting.LFS.ContentPath
  71. // Note(unknwon): it's hard for Windows users change a running user,
  72. // so just use current one if config says default.
  73. if setting.IsWindows && setting.RunUser == "git" {
  74. form.RunUser = user.CurrentUsername()
  75. } else {
  76. form.RunUser = setting.RunUser
  77. }
  78. form.Domain = setting.Domain
  79. form.SSHPort = setting.SSH.Port
  80. form.HTTPPort = setting.HTTPPort
  81. form.AppURL = setting.AppURL
  82. form.LogRootPath = setting.LogRootPath
  83. // E-mail service settings
  84. if setting.MailService != nil {
  85. form.SMTPHost = setting.MailService.Host
  86. form.SMTPFrom = setting.MailService.From
  87. form.SMTPUser = setting.MailService.User
  88. }
  89. form.RegisterConfirm = setting.Service.RegisterEmailConfirm
  90. form.MailNotify = setting.Service.EnableNotifyMail
  91. // Server and other services settings
  92. form.OfflineMode = setting.OfflineMode
  93. form.DisableGravatar = setting.DisableGravatar
  94. form.EnableFederatedAvatar = setting.EnableFederatedAvatar
  95. form.DisableRegistration = setting.Service.DisableRegistration
  96. form.EnableCaptcha = setting.Service.EnableCaptcha
  97. form.RequireSignInView = setting.Service.RequireSignInView
  98. form.DefaultKeepEmailPrivate = setting.Service.DefaultKeepEmailPrivate
  99. form.NoReplyAddress = setting.Service.NoReplyAddress
  100. auth.AssignForm(form, ctx.Data)
  101. ctx.HTML(200, tplInstall)
  102. }
  103. // InstallPost response for submit install items
  104. func InstallPost(ctx *context.Context, form auth.InstallForm) {
  105. var err error
  106. ctx.Data["CurDbOption"] = form.DbType
  107. if ctx.HasError() {
  108. if ctx.HasValue("Err_SMTPUser") {
  109. ctx.Data["Err_SMTP"] = true
  110. }
  111. if ctx.HasValue("Err_AdminName") ||
  112. ctx.HasValue("Err_AdminPasswd") ||
  113. ctx.HasValue("Err_AdminEmail") {
  114. ctx.Data["Err_Admin"] = true
  115. }
  116. ctx.HTML(200, tplInstall)
  117. return
  118. }
  119. if _, err = exec.LookPath("git"); err != nil {
  120. ctx.RenderWithErr(ctx.Tr("install.test_git_failed", err), tplInstall, &form)
  121. return
  122. }
  123. // Pass basic check, now test configuration.
  124. // Test database setting.
  125. dbTypes := map[string]string{"MySQL": "mysql", "PostgreSQL": "postgres", "MSSQL": "mssql", "SQLite3": "sqlite3", "TiDB": "tidb"}
  126. models.DbCfg.Type = dbTypes[form.DbType]
  127. models.DbCfg.Host = form.DbHost
  128. models.DbCfg.User = form.DbUser
  129. models.DbCfg.Passwd = form.DbPasswd
  130. models.DbCfg.Name = form.DbName
  131. models.DbCfg.SSLMode = form.SSLMode
  132. models.DbCfg.Path = form.DbPath
  133. if (models.DbCfg.Type == "sqlite3" || models.DbCfg.Type == "tidb") &&
  134. len(models.DbCfg.Path) == 0 {
  135. ctx.Data["Err_DbPath"] = true
  136. ctx.RenderWithErr(ctx.Tr("install.err_empty_db_path"), tplInstall, &form)
  137. return
  138. } else if models.DbCfg.Type == "tidb" &&
  139. strings.ContainsAny(path.Base(models.DbCfg.Path), ".-") {
  140. ctx.Data["Err_DbPath"] = true
  141. ctx.RenderWithErr(ctx.Tr("install.err_invalid_tidb_name"), tplInstall, &form)
  142. return
  143. }
  144. // Set test engine.
  145. var x *xorm.Engine
  146. if err = models.NewTestEngine(x); err != nil {
  147. if strings.Contains(err.Error(), `Unknown database type: sqlite3`) {
  148. ctx.Data["Err_DbType"] = true
  149. ctx.RenderWithErr(ctx.Tr("install.sqlite3_not_available", "https://docs.gitea.io/installation/install_from_binary.html"), tplInstall, &form)
  150. } else {
  151. ctx.Data["Err_DbSetting"] = true
  152. ctx.RenderWithErr(ctx.Tr("install.invalid_db_setting", err), tplInstall, &form)
  153. }
  154. return
  155. }
  156. // Test repository root path.
  157. form.RepoRootPath = strings.Replace(form.RepoRootPath, "\\", "/", -1)
  158. if err = os.MkdirAll(form.RepoRootPath, os.ModePerm); err != nil {
  159. ctx.Data["Err_RepoRootPath"] = true
  160. ctx.RenderWithErr(ctx.Tr("install.invalid_repo_path", err), tplInstall, &form)
  161. return
  162. }
  163. // Test LFS root path if not empty, empty meaning disable LFS
  164. if form.LFSRootPath != "" {
  165. form.LFSRootPath = strings.Replace(form.LFSRootPath, "\\", "/", -1)
  166. if err := os.MkdirAll(form.LFSRootPath, os.ModePerm); err != nil {
  167. ctx.Data["Err_LFSRootPath"] = true
  168. ctx.RenderWithErr(ctx.Tr("install.invalid_lfs_path", err), tplInstall, &form)
  169. return
  170. }
  171. }
  172. // Test log root path.
  173. form.LogRootPath = strings.Replace(form.LogRootPath, "\\", "/", -1)
  174. if err = os.MkdirAll(form.LogRootPath, os.ModePerm); err != nil {
  175. ctx.Data["Err_LogRootPath"] = true
  176. ctx.RenderWithErr(ctx.Tr("install.invalid_log_root_path", err), tplInstall, &form)
  177. return
  178. }
  179. currentUser, match := setting.IsRunUserMatchCurrentUser(form.RunUser)
  180. if !match {
  181. ctx.Data["Err_RunUser"] = true
  182. ctx.RenderWithErr(ctx.Tr("install.run_user_not_match", form.RunUser, currentUser), tplInstall, &form)
  183. return
  184. }
  185. // Check logic loophole between disable self-registration and no admin account.
  186. if form.DisableRegistration && len(form.AdminName) == 0 {
  187. ctx.Data["Err_Services"] = true
  188. ctx.Data["Err_Admin"] = true
  189. ctx.RenderWithErr(ctx.Tr("install.no_admin_and_disable_registration"), tplInstall, form)
  190. return
  191. }
  192. // Check admin password.
  193. if len(form.AdminName) > 0 && len(form.AdminPasswd) == 0 {
  194. ctx.Data["Err_Admin"] = true
  195. ctx.Data["Err_AdminPasswd"] = true
  196. ctx.RenderWithErr(ctx.Tr("install.err_empty_admin_password"), tplInstall, form)
  197. return
  198. }
  199. if form.AdminPasswd != form.AdminConfirmPasswd {
  200. ctx.Data["Err_Admin"] = true
  201. ctx.Data["Err_AdminPasswd"] = true
  202. ctx.RenderWithErr(ctx.Tr("form.password_not_match"), tplInstall, form)
  203. return
  204. }
  205. if form.AppURL[len(form.AppURL)-1] != '/' {
  206. form.AppURL += "/"
  207. }
  208. // Save settings.
  209. cfg := ini.Empty()
  210. if com.IsFile(setting.CustomConf) {
  211. // Keeps custom settings if there is already something.
  212. if err = cfg.Append(setting.CustomConf); err != nil {
  213. log.Error(4, "Failed to load custom conf '%s': %v", setting.CustomConf, err)
  214. }
  215. }
  216. cfg.Section("database").Key("DB_TYPE").SetValue(models.DbCfg.Type)
  217. cfg.Section("database").Key("HOST").SetValue(models.DbCfg.Host)
  218. cfg.Section("database").Key("NAME").SetValue(models.DbCfg.Name)
  219. cfg.Section("database").Key("USER").SetValue(models.DbCfg.User)
  220. cfg.Section("database").Key("PASSWD").SetValue(models.DbCfg.Passwd)
  221. cfg.Section("database").Key("SSL_MODE").SetValue(models.DbCfg.SSLMode)
  222. cfg.Section("database").Key("PATH").SetValue(models.DbCfg.Path)
  223. cfg.Section("").Key("APP_NAME").SetValue(form.AppName)
  224. cfg.Section("repository").Key("ROOT").SetValue(form.RepoRootPath)
  225. cfg.Section("").Key("RUN_USER").SetValue(form.RunUser)
  226. cfg.Section("server").Key("SSH_DOMAIN").SetValue(form.Domain)
  227. cfg.Section("server").Key("HTTP_PORT").SetValue(form.HTTPPort)
  228. cfg.Section("server").Key("ROOT_URL").SetValue(form.AppURL)
  229. if form.SSHPort == 0 {
  230. cfg.Section("server").Key("DISABLE_SSH").SetValue("true")
  231. } else {
  232. cfg.Section("server").Key("DISABLE_SSH").SetValue("false")
  233. cfg.Section("server").Key("SSH_PORT").SetValue(com.ToStr(form.SSHPort))
  234. }
  235. if form.LFSRootPath != "" {
  236. cfg.Section("server").Key("LFS_START_SERVER").SetValue("true")
  237. cfg.Section("server").Key("LFS_CONTENT_PATH").SetValue(form.LFSRootPath)
  238. cfg.Section("server").Key("LFS_JWT_SECRET").SetValue(base.GetRandomBytesAsBase64(32))
  239. } else {
  240. cfg.Section("server").Key("LFS_START_SERVER").SetValue("false")
  241. }
  242. if len(strings.TrimSpace(form.SMTPHost)) > 0 {
  243. cfg.Section("mailer").Key("ENABLED").SetValue("true")
  244. cfg.Section("mailer").Key("HOST").SetValue(form.SMTPHost)
  245. cfg.Section("mailer").Key("FROM").SetValue(form.SMTPFrom)
  246. cfg.Section("mailer").Key("USER").SetValue(form.SMTPUser)
  247. cfg.Section("mailer").Key("PASSWD").SetValue(form.SMTPPasswd)
  248. } else {
  249. cfg.Section("mailer").Key("ENABLED").SetValue("false")
  250. }
  251. cfg.Section("service").Key("REGISTER_EMAIL_CONFIRM").SetValue(com.ToStr(form.RegisterConfirm))
  252. cfg.Section("service").Key("ENABLE_NOTIFY_MAIL").SetValue(com.ToStr(form.MailNotify))
  253. cfg.Section("server").Key("OFFLINE_MODE").SetValue(com.ToStr(form.OfflineMode))
  254. cfg.Section("picture").Key("DISABLE_GRAVATAR").SetValue(com.ToStr(form.DisableGravatar))
  255. cfg.Section("picture").Key("ENABLE_FEDERATED_AVATAR").SetValue(com.ToStr(form.EnableFederatedAvatar))
  256. cfg.Section("service").Key("DISABLE_REGISTRATION").SetValue(com.ToStr(form.DisableRegistration))
  257. cfg.Section("service").Key("ENABLE_CAPTCHA").SetValue(com.ToStr(form.EnableCaptcha))
  258. cfg.Section("service").Key("REQUIRE_SIGNIN_VIEW").SetValue(com.ToStr(form.RequireSignInView))
  259. cfg.Section("service").Key("DEFAULT_KEEP_EMAIL_PRIVATE").SetValue(com.ToStr(form.DefaultKeepEmailPrivate))
  260. cfg.Section("service").Key("NO_REPLY_ADDRESS").SetValue(com.ToStr(form.NoReplyAddress))
  261. cfg.Section("").Key("RUN_MODE").SetValue("prod")
  262. cfg.Section("session").Key("PROVIDER").SetValue("file")
  263. cfg.Section("log").Key("MODE").SetValue("file")
  264. cfg.Section("log").Key("LEVEL").SetValue("Info")
  265. cfg.Section("log").Key("ROOT_PATH").SetValue(form.LogRootPath)
  266. cfg.Section("security").Key("INSTALL_LOCK").SetValue("true")
  267. var secretKey string
  268. if secretKey, err = base.GetRandomString(10); err != nil {
  269. ctx.RenderWithErr(ctx.Tr("install.secret_key_failed", err), tplInstall, &form)
  270. return
  271. }
  272. cfg.Section("security").Key("SECRET_KEY").SetValue(secretKey)
  273. err = os.MkdirAll(filepath.Dir(setting.CustomConf), os.ModePerm)
  274. if err != nil {
  275. ctx.RenderWithErr(ctx.Tr("install.save_config_failed", err), tplInstall, &form)
  276. return
  277. }
  278. if err = cfg.SaveTo(setting.CustomConf); err != nil {
  279. ctx.RenderWithErr(ctx.Tr("install.save_config_failed", err), tplInstall, &form)
  280. return
  281. }
  282. GlobalInit()
  283. // Create admin account
  284. if len(form.AdminName) > 0 {
  285. u := &models.User{
  286. Name: form.AdminName,
  287. Email: form.AdminEmail,
  288. Passwd: form.AdminPasswd,
  289. IsAdmin: true,
  290. IsActive: true,
  291. }
  292. if err = models.CreateUser(u); err != nil {
  293. if !models.IsErrUserAlreadyExist(err) {
  294. setting.InstallLock = false
  295. ctx.Data["Err_AdminName"] = true
  296. ctx.Data["Err_AdminEmail"] = true
  297. ctx.RenderWithErr(ctx.Tr("install.invalid_admin_setting", err), tplInstall, &form)
  298. return
  299. }
  300. log.Info("Admin account already exist")
  301. u, _ = models.GetUserByName(u.Name)
  302. }
  303. // Auto-login for admin
  304. if err = ctx.Session.Set("uid", u.ID); err != nil {
  305. ctx.RenderWithErr(ctx.Tr("install.save_config_failed", err), tplInstall, &form)
  306. return
  307. }
  308. if err = ctx.Session.Set("uname", u.Name); err != nil {
  309. ctx.RenderWithErr(ctx.Tr("install.save_config_failed", err), tplInstall, &form)
  310. return
  311. }
  312. }
  313. log.Info("First-time run install finished!")
  314. ctx.Flash.Success(ctx.Tr("install.install_success"))
  315. ctx.Redirect(form.AppURL + "user/login")
  316. }