Add support for database schema in PostgreSQL

custom/conf/app.ini.sample

@@ -317,6 +317,10 @@ NAME = gitea
 USER = root
 ; Use PASSWD = `your password` for quoting if you use special characters in the password.
 PASSWD =
+; For Postgres, schema to use if different from "public". The schema must exist beforehand,
+; the user must have creation privileges on it, and the user search path must be set
+; to the look into the schema first. e.g.:ALTER USER user SET SEARCH_PATH = schema_name,"$user",public;
+SCHEMA =
 ; For Postgres, either "disable" (default), "require", or "verify-full"
 ; For MySQL, either "false" (default), "true", or "skip-verify"
 SSL_MODE = disable

docs/content/doc/advanced/config-cheat-sheet.en-us.md

@@ -204,6 +204,9 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`.
 - `NAME`: **gitea**: Database name.
 - `USER`: **root**: Database username.
 - `PASSWD`: **\<empty\>**: Database user password. Use \`your password\` for quoting if you use special characters in the password.
+- `SCHEMA`: **\<empty\>**: For PostgreSQL only, schema to use if different from "public". The schema must exist beforehand,
+ the user must have creation privileges on it, and the user search path must be set to the look into the schema first 
+ (e.g. `ALTER USER user SET SEARCH_PATH = schema_name,"$user",public;`).
 - `SSL_MODE`: **disable**: For PostgreSQL and MySQL only.
 - `CHARSET`: **utf8**: For MySQL only, either "utf8" or "utf8mb4", default is "utf8". NOTICE: for "utf8mb4" you must use MySQL InnoDB > 5.6. Gitea is unable to check this.
 - `PATH`: **data/gitea.db**: For SQLite3 only, the database file path.

models/models.go

@@ -128,7 +128,12 @@ func getEngine() (*xorm.Engine, error) {
  return nil, err
  }
 
- return xorm.NewEngine(setting.Database.Type, connStr)
+ engine, err := xorm.NewEngine(setting.Database.Type, connStr)
+ if err != nil {
+ return nil, err
+ }
+ engine.SetSchema(setting.Database.Schema)
+ return engine, nil
 }
 
 // NewTestEngine sets a new test xorm.Engine

modules/auth/user_form.go

@@ -25,6 +25,7 @@ type InstallForm struct {
  SSLMode string
  Charset string `binding:"Required;In(utf8,utf8mb4)"`
  DbPath string
+ DbSchema string
 
  AppName string `binding:"Required" locale:"install.app_name"`
  RepoRootPath string `binding:"Required"`

modules/setting/database.go

@@ -30,6 +30,7 @@ var (
  Name string
  User string
  Passwd string
+ Schema string
  SSLMode string
  Path string
  LogSQL bool
@@ -75,6 +76,7 @@ func InitDBConfig() {
  if len(Database.Passwd) == 0 {
  Database.Passwd = sec.Key("PASSWD").String()
  }
+ Database.Schema = sec.Key("SCHEMA").String()
  Database.SSLMode = sec.Key("SSL_MODE").MustString("disable")
  Database.Charset = sec.Key("CHARSET").In("utf8", []string{"utf8", "utf8mb4"})
  Database.Path = sec.Key("PATH").MustString(filepath.Join(AppDataPath, "gitea.db"))

options/locale/locale_en-US.ini

@@ -101,6 +101,8 @@ user = Username
 password = Password
 db_name = Database Name
 db_helper = Note to MySQL users: please use the InnoDB storage engine and if you use "utf8mb4", your InnoDB version must be greater than 5.6 .
+db_schema = Schema
+db_schema_helper = Leave blank for database default ("public").
 ssl_mode = SSL
 charset = Charset
 path = Path
@@ -1916,6 +1918,7 @@ config.db_type = Type
 config.db_host = Host
 config.db_name = Name
 config.db_user = Username
+config.db_schema = Schema
 config.db_ssl_mode = SSL
 config.db_path = Path
 

routers/install.go

@@ -54,6 +54,7 @@ func Install(ctx *context.Context) {
  form.DbPasswd = setting.Database.Passwd
  form.DbName = setting.Database.Name
  form.DbPath = setting.Database.Path
+ form.DbSchema = setting.Database.Schema
  form.Charset = setting.Database.Charset
 
  ctx.Data["CurDbOption"] = "MySQL"
@@ -147,6 +148,7 @@ func InstallPost(ctx *context.Context, form auth.InstallForm) {
  setting.Database.User = form.DbUser
  setting.Database.Passwd = form.DbPasswd
  setting.Database.Name = form.DbName
+ setting.Database.Schema = form.DbSchema
  setting.Database.SSLMode = form.SSLMode
  setting.Database.Charset = form.Charset
  setting.Database.Path = form.DbPath
@@ -267,6 +269,7 @@ func InstallPost(ctx *context.Context, form auth.InstallForm) {
  cfg.Section("database").Key("NAME").SetValue(setting.Database.Name)
  cfg.Section("database").Key("USER").SetValue(setting.Database.User)
  cfg.Section("database").Key("PASSWD").SetValue(setting.Database.Passwd)
+ cfg.Section("database").Key("SCHEMA").SetValue(setting.Database.Schema)
  cfg.Section("database").Key("SSL_MODE").SetValue(setting.Database.SSLMode)
  cfg.Section("database").Key("CHARSET").SetValue(setting.Database.Charset)
  cfg.Section("database").Key("PATH").SetValue(setting.Database.Path)

templates/admin/config.tmpl

@@ -128,6 +128,8 @@
  <dd>{{if .DbCfg.User}}{{.DbCfg.User}}{{else}}-{{end}}</dd>
  {{end}}
  {{if eq .DbCfg.Type "postgres"}}
+ <dt>{{.i18n.Tr "admin.config.db_schema"}}</dt>
+ <dd>{{if .DbCfg.Schema}}{{.DbCfg.Schema}}{{else}}-{{end}}</dd>
  <dt>{{.i18n.Tr "admin.config.db_ssl_mode"}}</dt>
  <dd>{{if .DbCfg.SSLMode}}{{.DbCfg.SSLMode}}{{else}}-{{end}}</dd>
  {{end}}

templates/install.tmpl

@@ -62,6 +62,11 @@
  </div>
  </div>
  </div>
+ <div class="inline field {{if .Err_DbSetting}}error{{end}}">
+ <label for="db_schema">{{.i18n.Tr "install.db_schema"}}</label>
+ <input id="db_schema" name="db_schema" value="{{.db_schema}}">
+ <span class="help">{{.i18n.Tr "install.db_schema_helper"}}</span>
+ </div>
  </div>
 
  <div id="mysql_settings" class="{{if not (eq .CurDbOption "MySQL")}}hide{{end}}">