You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
forgejo/cmd
wxiaoguang 2cdf260f42
Refactor path & config system (#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.



----

Close #24818
Close #24222
Close #21606
Close #21498
Close #25107
Close #24981
Maybe close #24503

Replace #23301
Replace #22754

And maybe more
1 year ago
..
actions.go Refactor path & config system (#25330) 1 year ago
admin.go Handle OpenID discovery URL errors a little nicer when creating/editing sources (#23397) 1 year ago
admin_auth_ldap.go Implement FSFE REUSE for golang files (#21840) 2 years ago
admin_auth_ldap_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
admin_user.go Add command to bulk set must-change-password (#22823) 1 year ago
admin_user_change_password.go Provide the ability to set password hash algorithm parameters (#22942) 1 year ago
admin_user_create.go Provide the ability to set password hash algorithm parameters (#22942) 1 year ago
admin_user_delete.go Add context cache as a request level cache (#22294) 1 year ago
admin_user_generate_access_token.go Add command to bulk set must-change-password (#22823) 1 year ago
admin_user_list.go Add command to bulk set must-change-password (#22823) 1 year ago
admin_user_must_change_password.go Add command to bulk set must-change-password (#22823) 1 year ago
cert.go Implement FSFE REUSE for golang files (#21840) 2 years ago
cmd.go Refactor path & config system (#25330) 1 year ago
convert.go Support converting varchar to nvarchar for mssql database (#24105) 1 year ago
docs.go Implement FSFE REUSE for golang files (#21840) 2 years ago
doctor.go Refactor path & config system (#25330) 1 year ago
dump.go Refactor path & config system (#25330) 1 year ago
dump_repo.go Refactor the setting to make unit test easier (#22405) 1 year ago
embedded.go Refactor path & config system (#25330) 1 year ago
generate.go Implement FSFE REUSE for golang files (#21840) 2 years ago
hook.go Use the type RefName for all the needed places and fix pull mirror sync bugs (#24634) 1 year ago
hook_test.go Refactor internal API for git commands, use meaningful messages instead of "Internal Server Error" (#23687) 1 year ago
keys.go Refactor internal API for git commands, use meaningful messages instead of "Internal Server Error" (#23687) 1 year ago
mailer.go Refactor path & config system (#25330) 1 year ago
main_test.go Merge setting.InitXXX into one function with options (#24389) 1 year ago
manager.go Add gitea manager reload-templates command (#24843) 1 year ago
manager_logging.go Rewrite logger system (#24726) 1 year ago
migrate.go Refactor the setting to make unit test easier (#22405) 1 year ago
migrate_storage.go Fix all possible setting error related storages and added some tests (#23911) 1 year ago
migrate_storage_test.go Fix all possible setting error related storages and added some tests (#23911) 1 year ago
restore_repo.go Refactor path & config system (#25330) 1 year ago
serv.go Refactor path & config system (#25330) 1 year ago
web.go Refactor path & config system (#25330) 1 year ago
web_acme.go Implement FSFE REUSE for golang files (#21840) 2 years ago
web_graceful.go Implement FSFE REUSE for golang files (#21840) 2 years ago
web_https.go Implement FSFE REUSE for golang files (#21840) 2 years ago