forked from gitea/gitea
1
0
Fork 0
gitea/cmd
wxiaoguang 061b68e995
Refactor path & config system (#25330) (#25416)
Backport #25330

# The problem

There were many "path tricks":

* By default, Gitea uses its program directory as its work path
* Gitea tries to use the "work path" to guess its "custom path" and
"custom conf (app.ini)"
* Users might want to use other directories as work path
* The non-default work path should be passed to Gitea by GITEA_WORK_DIR
or "--work-path"
* But some Gitea processes are started without these values
    * The "serv" process started by OpenSSH server
    * The CLI sub-commands started by site admin
* The paths are guessed by SetCustomPathAndConf again and again
* The default values of "work path / custom path / custom conf" can be
changed when compiling

# The solution

* Use `InitWorkPathAndCommonConfig` to handle these path tricks, and use
test code to cover its behaviors.
* When Gitea's web server runs, write the WORK_PATH to "app.ini", this
value must be the most correct one, because if this value is not right,
users would find that the web UI doesn't work and then they should be
able to fix it.
* Then all other sub-commands can use the WORK_PATH in app.ini to
initialize their paths.
* By the way, when Gitea starts for git protocol, it shouldn't output
any log, otherwise the git protocol gets broken and client blocks
forever.

The "work path" priority is: WORK_PATH in app.ini > cmd arg --work-path
> env var GITEA_WORK_DIR > builtin default

The "app.ini" searching order is: cmd arg --config > cmd arg "work path
/ custom path" > env var "work path / custom path" > builtin default


## ⚠️ BREAKING

If your instance's "work path / custom path / custom conf" doesn't meet
the requirements (eg: work path must be absolute), Gitea will report a
fatal error and exit. You need to set these values according to the
error log.
2023-06-22 16:27:18 +00:00
..
actions.go Refactor path & config system (#25330) (#25416) 2023-06-22 16:27:18 +00:00
admin.go Handle OpenID discovery URL errors a little nicer when creating/editing sources (#23397) 2023-03-10 01:14:43 -05:00
admin_auth_ldap.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
admin_auth_ldap_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
admin_user.go Add command to bulk set must-change-password (#22823) 2023-02-14 16:12:19 -06:00
admin_user_change_password.go Provide the ability to set password hash algorithm parameters (#22942) 2023-02-19 15:35:20 +08:00
admin_user_create.go Provide the ability to set password hash algorithm parameters (#22942) 2023-02-19 15:35:20 +08:00
admin_user_delete.go Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
admin_user_generate_access_token.go Add command to bulk set must-change-password (#22823) 2023-02-14 16:12:19 -06:00
admin_user_list.go Add command to bulk set must-change-password (#22823) 2023-02-14 16:12:19 -06:00
admin_user_must_change_password.go Add command to bulk set must-change-password (#22823) 2023-02-14 16:12:19 -06:00
cert.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
cmd.go Refactor path & config system (#25330) (#25416) 2023-06-22 16:27:18 +00:00
convert.go Support converting varchar to nvarchar for mssql database (#24105) 2023-04-17 21:22:10 +08:00
docs.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
doctor.go Refactor path & config system (#25330) (#25416) 2023-06-22 16:27:18 +00:00
dump.go Refactor path & config system (#25330) (#25416) 2023-06-22 16:27:18 +00:00
dump_repo.go Refactor the setting to make unit test easier (#22405) 2023-02-20 00:12:01 +08:00
embedded.go Refactor path & config system (#25330) (#25416) 2023-06-22 16:27:18 +00:00
generate.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
hook.go Use the type RefName for all the needed places and fix pull mirror sync bugs (#24634) 2023-05-26 01:04:48 +00:00
hook_test.go Refactor internal API for git commands, use meaningful messages instead of "Internal Server Error" (#23687) 2023-03-29 14:32:26 +08:00
keys.go Refactor internal API for git commands, use meaningful messages instead of "Internal Server Error" (#23687) 2023-03-29 14:32:26 +08:00
mailer.go Refactor path & config system (#25330) (#25416) 2023-06-22 16:27:18 +00:00
main_test.go Merge setting.InitXXX into one function with options (#24389) 2023-05-04 11:55:35 +08:00
manager.go Add gitea manager reload-templates command (#24843) 2023-05-22 23:51:40 +08:00
manager_logging.go Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
migrate.go Refactor the setting to make unit test easier (#22405) 2023-02-20 00:12:01 +08:00
migrate_storage.go Fix all possible setting error related storages and added some tests (#23911) (#25244) 2023-06-14 08:36:52 +02:00
migrate_storage_test.go Fix all possible setting error related storages and added some tests (#23911) (#25244) 2023-06-14 08:36:52 +02:00
restore_repo.go Refactor path & config system (#25330) (#25416) 2023-06-22 16:27:18 +00:00
serv.go Refactor path & config system (#25330) (#25416) 2023-06-22 16:27:18 +00:00
web.go Refactor path & config system (#25330) (#25416) 2023-06-22 16:27:18 +00:00
web_acme.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
web_graceful.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
web_https.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00