install.go 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320
  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/Unknwon/macaron"
  14. "github.com/go-xorm/xorm"
  15. "gopkg.in/ini.v1"
  16. "github.com/gogits/gogs/models"
  17. "github.com/gogits/gogs/models/cron"
  18. "github.com/gogits/gogs/modules/auth"
  19. "github.com/gogits/gogs/modules/base"
  20. "github.com/gogits/gogs/modules/log"
  21. "github.com/gogits/gogs/modules/mailer"
  22. "github.com/gogits/gogs/modules/middleware"
  23. "github.com/gogits/gogs/modules/setting"
  24. "github.com/gogits/gogs/modules/social"
  25. "github.com/gogits/gogs/modules/user"
  26. )
  27. const (
  28. INSTALL base.TplName = "install"
  29. )
  30. func checkRunMode() {
  31. switch setting.Cfg.Section("").Key("RUN_MODE").String() {
  32. case "prod":
  33. macaron.Env = macaron.PROD
  34. macaron.ColorLog = false
  35. setting.ProdMode = true
  36. }
  37. log.Info("Run Mode: %s", strings.Title(macaron.Env))
  38. }
  39. func NewServices() {
  40. setting.NewServices()
  41. social.NewOauthService()
  42. }
  43. // GlobalInit is for global configuration reload-able.
  44. func GlobalInit() {
  45. setting.NewConfigContext()
  46. log.Trace("Custom path: %s", setting.CustomPath)
  47. log.Trace("Log path: %s", setting.LogRootPath)
  48. mailer.NewMailerContext()
  49. models.LoadModelsConfig()
  50. NewServices()
  51. if setting.InstallLock {
  52. models.LoadRepoConfig()
  53. models.NewRepoContext()
  54. if err := models.NewEngine(); err != nil {
  55. log.Fatal(4, "Fail to initialize ORM engine: %v", err)
  56. }
  57. models.HasEngine = true
  58. cron.NewCronContext()
  59. models.InitDeliverHooks()
  60. log.NewGitLogger(path.Join(setting.LogRootPath, "http.log"))
  61. }
  62. if models.EnableSQLite3 {
  63. log.Info("SQLite3 Supported")
  64. }
  65. checkRunMode()
  66. }
  67. func InstallInit(ctx *middleware.Context) {
  68. if setting.InstallLock {
  69. ctx.Handle(404, "Install", errors.New("Installation is prohibited"))
  70. return
  71. }
  72. ctx.Data["Title"] = ctx.Tr("install.install")
  73. ctx.Data["PageIsInstall"] = true
  74. dbOpts := []string{"MySQL", "PostgreSQL"}
  75. if models.EnableSQLite3 {
  76. dbOpts = append(dbOpts, "SQLite3")
  77. }
  78. if models.EnableTidb {
  79. dbOpts = append(dbOpts, "TiDB")
  80. }
  81. ctx.Data["DbOptions"] = dbOpts
  82. }
  83. func Install(ctx *middleware.Context) {
  84. form := auth.InstallForm{}
  85. // Database settings
  86. form.DbHost = models.DbCfg.Host
  87. form.DbUser = models.DbCfg.User
  88. form.DbName = models.DbCfg.Name
  89. form.DbPath = models.DbCfg.Path
  90. ctx.Data["CurDbOption"] = "MySQL"
  91. switch models.DbCfg.Type {
  92. case "postgres":
  93. ctx.Data["CurDbOption"] = "PostgreSQL"
  94. case "sqlite3":
  95. if models.EnableSQLite3 {
  96. ctx.Data["CurDbOption"] = "SQLite3" // Default when enabled.
  97. }
  98. }
  99. // Application general settings
  100. form.AppName = setting.AppName
  101. form.RepoRootPath = setting.RepoRootPath
  102. // Note(unknwon): it's hard for Windows users change a running user,
  103. // so just use current one if config says default.
  104. if setting.IsWindows && setting.RunUser == "git" {
  105. form.RunUser = user.CurrentUsername()
  106. } else {
  107. form.RunUser = setting.RunUser
  108. }
  109. form.Domain = setting.Domain
  110. form.SSHPort = setting.SSHPort
  111. form.HTTPPort = setting.HttpPort
  112. form.AppUrl = setting.AppUrl
  113. // E-mail service settings
  114. if setting.MailService != nil {
  115. form.SMTPHost = setting.MailService.Host
  116. form.SMTPFrom = setting.MailService.From
  117. form.SMTPEmail = setting.MailService.User
  118. }
  119. form.RegisterConfirm = setting.Service.RegisterEmailConfirm
  120. form.MailNotify = setting.Service.EnableNotifyMail
  121. // Server and other services settings
  122. form.OfflineMode = setting.OfflineMode
  123. form.DisableGravatar = setting.DisableGravatar
  124. form.DisableRegistration = setting.Service.DisableRegistration
  125. form.RequireSignInView = setting.Service.RequireSignInView
  126. auth.AssignForm(form, ctx.Data)
  127. ctx.HTML(200, INSTALL)
  128. }
  129. func InstallPost(ctx *middleware.Context, form auth.InstallForm) {
  130. ctx.Data["CurDbOption"] = form.DbType
  131. if ctx.HasError() {
  132. if ctx.HasValue("Err_SMTPEmail") {
  133. ctx.Data["Err_SMTP"] = true
  134. }
  135. if ctx.HasValue("Err_AdminName") ||
  136. ctx.HasValue("Err_AdminPasswd") ||
  137. ctx.HasValue("Err_AdminEmail") {
  138. ctx.Data["Err_Admin"] = true
  139. }
  140. ctx.HTML(200, INSTALL)
  141. return
  142. }
  143. if _, err := exec.LookPath("git"); err != nil {
  144. ctx.RenderWithErr(ctx.Tr("install.test_git_failed", err), INSTALL, &form)
  145. return
  146. }
  147. // Pass basic check, now test configuration.
  148. // Test database setting.
  149. dbTypes := map[string]string{"MySQL": "mysql", "PostgreSQL": "postgres", "SQLite3": "sqlite3", "TiDB": "tidb"}
  150. models.DbCfg.Type = dbTypes[form.DbType]
  151. models.DbCfg.Host = form.DbHost
  152. models.DbCfg.User = form.DbUser
  153. models.DbCfg.Passwd = form.DbPasswd
  154. models.DbCfg.Name = form.DbName
  155. models.DbCfg.SSLMode = form.SSLMode
  156. models.DbCfg.Path = form.DbPath
  157. if models.DbCfg.Type == "sqlite3" && len(models.DbCfg.Path) == 0 {
  158. ctx.Data["Err_DbPath"] = true
  159. ctx.RenderWithErr(ctx.Tr("install.err_empty_sqlite_path"), INSTALL, &form)
  160. return
  161. }
  162. // Set test engine.
  163. var x *xorm.Engine
  164. if err := models.NewTestEngine(x); err != nil {
  165. if strings.Contains(err.Error(), `Unknown database type: sqlite3`) {
  166. ctx.Data["Err_DbType"] = true
  167. ctx.RenderWithErr(ctx.Tr("install.sqlite3_not_available", "http://gogs.io/docs/installation/install_from_binary.html"), INSTALL, &form)
  168. } else {
  169. ctx.Data["Err_DbSetting"] = true
  170. ctx.RenderWithErr(ctx.Tr("install.invalid_db_setting", err), INSTALL, &form)
  171. }
  172. return
  173. }
  174. // Test repository root path.
  175. if err := os.MkdirAll(form.RepoRootPath, os.ModePerm); err != nil {
  176. ctx.Data["Err_RepoRootPath"] = true
  177. ctx.RenderWithErr(ctx.Tr("install.invalid_repo_path", err), INSTALL, &form)
  178. return
  179. }
  180. // Check run user.
  181. curUser := user.CurrentUsername()
  182. if form.RunUser != curUser {
  183. ctx.Data["Err_RunUser"] = true
  184. ctx.RenderWithErr(ctx.Tr("install.run_user_not_match", form.RunUser, curUser), INSTALL, &form)
  185. return
  186. }
  187. // Check admin password.
  188. if form.AdminPasswd != form.AdminConfirmPasswd {
  189. ctx.Data["Err_Admin"] = true
  190. ctx.Data["Err_AdminPasswd"] = true
  191. ctx.RenderWithErr(ctx.Tr("form.password_not_match"), INSTALL, form)
  192. return
  193. }
  194. if form.AppUrl[len(form.AppUrl)-1] != '/' {
  195. form.AppUrl += "/"
  196. }
  197. // Save settings.
  198. cfg := ini.Empty()
  199. if com.IsFile(setting.CustomConf) {
  200. // Keeps custom settings if there is already something.
  201. if err := cfg.Append(setting.CustomConf); err != nil {
  202. log.Error(4, "Fail to load custom conf '%s': %v", setting.CustomConf, err)
  203. }
  204. }
  205. cfg.Section("database").Key("DB_TYPE").SetValue(models.DbCfg.Type)
  206. cfg.Section("database").Key("HOST").SetValue(models.DbCfg.Host)
  207. cfg.Section("database").Key("NAME").SetValue(models.DbCfg.Name)
  208. cfg.Section("database").Key("USER").SetValue(models.DbCfg.User)
  209. cfg.Section("database").Key("PASSWD").SetValue(models.DbCfg.Passwd)
  210. cfg.Section("database").Key("SSL_MODE").SetValue(models.DbCfg.SSLMode)
  211. cfg.Section("database").Key("PATH").SetValue(models.DbCfg.Path)
  212. cfg.Section("").Key("APP_NAME").SetValue(form.AppName)
  213. cfg.Section("repository").Key("ROOT").SetValue(form.RepoRootPath)
  214. cfg.Section("").Key("RUN_USER").SetValue(form.RunUser)
  215. cfg.Section("server").Key("DOMAIN").SetValue(form.Domain)
  216. cfg.Section("server").Key("HTTP_PORT").SetValue(form.HTTPPort)
  217. cfg.Section("server").Key("ROOT_URL").SetValue(form.AppUrl)
  218. if form.SSHPort == 0 {
  219. cfg.Section("server").Key("DISABLE_SSH").SetValue("true")
  220. } else {
  221. cfg.Section("server").Key("DISABLE_SSH").SetValue("false")
  222. cfg.Section("server").Key("SSH_PORT").SetValue(com.ToStr(form.SSHPort))
  223. }
  224. if len(strings.TrimSpace(form.SMTPHost)) > 0 {
  225. cfg.Section("mailer").Key("ENABLED").SetValue("true")
  226. cfg.Section("mailer").Key("HOST").SetValue(form.SMTPHost)
  227. cfg.Section("mailer").Key("FROM").SetValue(form.SMTPFrom)
  228. cfg.Section("mailer").Key("USER").SetValue(form.SMTPEmail)
  229. cfg.Section("mailer").Key("PASSWD").SetValue(form.SMTPPasswd)
  230. } else {
  231. cfg.Section("mailer").Key("ENABLED").SetValue("false")
  232. }
  233. cfg.Section("service").Key("REGISTER_EMAIL_CONFIRM").SetValue(com.ToStr(form.RegisterConfirm))
  234. cfg.Section("service").Key("ENABLE_NOTIFY_MAIL").SetValue(com.ToStr(form.MailNotify))
  235. cfg.Section("server").Key("OFFLINE_MODE").SetValue(com.ToStr(form.OfflineMode))
  236. cfg.Section("picture").Key("DISABLE_GRAVATAR").SetValue(com.ToStr(form.DisableGravatar))
  237. cfg.Section("service").Key("DISABLE_REGISTRATION").SetValue(com.ToStr(form.DisableRegistration))
  238. cfg.Section("service").Key("REQUIRE_SIGNIN_VIEW").SetValue(com.ToStr(form.RequireSignInView))
  239. cfg.Section("").Key("RUN_MODE").SetValue("prod")
  240. cfg.Section("session").Key("PROVIDER").SetValue("file")
  241. cfg.Section("log").Key("MODE").SetValue("file")
  242. cfg.Section("log").Key("LEVEL").SetValue("Info")
  243. cfg.Section("security").Key("INSTALL_LOCK").SetValue("true")
  244. cfg.Section("security").Key("SECRET_KEY").SetValue(base.GetRandomString(15))
  245. os.MkdirAll(filepath.Dir(setting.CustomConf), os.ModePerm)
  246. if err := cfg.SaveTo(setting.CustomConf); err != nil {
  247. ctx.RenderWithErr(ctx.Tr("install.save_config_failed", err), INSTALL, &form)
  248. return
  249. }
  250. GlobalInit()
  251. // Create admin account.
  252. if len(form.AdminName) > 0 {
  253. if err := models.CreateUser(&models.User{
  254. Name: form.AdminName,
  255. Email: form.AdminEmail,
  256. Passwd: form.AdminPasswd,
  257. IsAdmin: true,
  258. IsActive: true,
  259. }); err != nil {
  260. if !models.IsErrUserAlreadyExist(err) {
  261. setting.InstallLock = false
  262. ctx.Data["Err_AdminName"] = true
  263. ctx.Data["Err_AdminEmail"] = true
  264. ctx.RenderWithErr(ctx.Tr("install.invalid_admin_setting", err), INSTALL, &form)
  265. return
  266. }
  267. log.Info("Admin account already exist")
  268. }
  269. }
  270. log.Info("First-time run install finished!")
  271. ctx.Flash.Success(ctx.Tr("install.install_success"))
  272. ctx.Redirect(form.AppUrl + "user/login")
  273. }