Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Documentation for Restoration from backup #29321

Merged
merged 3 commits into from
Feb 25, 2024

Conversation

kralo
Copy link
Contributor

@kralo kralo commented Feb 22, 2024

Comment the default path for repos and suggest using doctor for when things are stuck

by default, repositories is a subfolder of data/ `%(APP_DATA_PATH)s/gitea-repositories`
after update, bare git repositories might throw

```
 [E] RepoAssignment Invalid repo /var/lib/gitea/data/gitea-repositories/tester/testrepo.git: exit status 128 - fatal: not a git repository (or any of the parent directories): .git
2024/02/22 11:50:44 ...eb/routing/logger.go:102:func1() [I] router: completed GET /tester/testrepo for, 500 Internal Server Error in 5.4ms @ context/repo.go:425(context.RepoAssignment)
```
@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Feb 22, 2024
@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Feb 22, 2024
@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Feb 24, 2024
@@ -92,7 +92,7 @@ cd gitea-dump-1610949662
mv app.ini /etc/gitea/conf/app.ini
mv data/* /var/lib/gitea/data/
mv log/* /var/lib/gitea/log/
mv repos/* /var/lib/gitea/gitea-repositories/
mv repos/* /var/lib/gitea/data/gitea-repositories/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We seem to be inconsistent with this path throughout the docs, would suggest cleaning up:

$ rg gitea-repositories docs
docs/content/help/faq.en-us.md:76:  - Default `%(APP_DATA_PATH)/gitea-repositories`
docs/content/help/faq.zh-cn.md:77:  - 默认值为`%(APP_DATA_PATH)/gitea-repositories`
docs/content/administration/config-cheat-sheet.zh-cn.md:78:- `ROOT`: **%(APP_DATA_PATH)s/gitea-repositories**: 存放git工程的根目录,建议填绝对路径。
docs/content/administration/backup-and-restore.zh-cn.md:34:2016/12/27 22:32:09 Dumping local repositories.../home/git/gitea-repositories
docs/content/administration/backup-and-restore.zh-cn.md:91:mv repos/* /var/lib/gitea/gitea-repositories/
docs/content/administration/backup-and-restore.zh-cn.md:125:mv repos/* /data/git/gitea-repositories/
docs/content/administration/backup-and-restore.zh-cn.md:149:mv repos/* /var/lib/gitea/git/gitea-repositories
docs/content/administration/config-cheat-sheet.en-us.md:78:- `ROOT`: **%(APP_DATA_PATH)s/gitea-repositories**: Root path for storing all repository data.
docs/content/administration/config-cheat-sheet.en-us.md:550:- `ONLY_ALLOW_PUSH_IF_GITEA_ENVIRONMENT_SET`: **true**: Set to `false` to allow local users to push to gitea-repositories without setting up the Gitea environment. This is not recommended and if you want local users to push to Gitea repositories you should set the environment appropriately.
docs/content/administration/backup-and-restore.en-us.md:36:2016/12/27 22:32:09 Dumping local repositories.../home/git/gitea-repositories
docs/content/administration/backup-and-restore.en-us.md:95:mv repos/* /var/lib/gitea/gitea-repositories/
docs/content/administration/backup-and-restore.en-us.md:129:mv repos/* /data/git/gitea-repositories/
docs/content/administration/backup-and-restore.en-us.md:153:mv repos/* /var/lib/gitea/git/gitea-repositories

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's impossible to make them consistent.

  • Some are by default systemd installation, eg: /var/lib/gitea/data/gitea-repositories/
  • Some are caused by bugs: /var/lib/gitea/gitea-repositories/
  • Some are for docker: /data/git/gitea-repositories/
  • Some are for docker rootless: /var/lib/gitea/git/gitea-repositories

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, site admin should learn how to handle directories correctly .....

@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Feb 25, 2024
@silverwind silverwind added the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Feb 25, 2024
@silverwind silverwind enabled auto-merge (squash) February 25, 2024 23:35
@silverwind silverwind merged commit f13f932 into go-gitea:main Feb 25, 2024
26 checks passed
@GiteaBot GiteaBot added this to the 1.22.0 milestone Feb 25, 2024
@GiteaBot GiteaBot removed the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Feb 25, 2024
zjjhot added a commit to zjjhot/gitea that referenced this pull request Feb 26, 2024
* giteaofficial/main: (45 commits)
  Include resource state events in Gitlab downloads (go-gitea#29382)
  Add API to get PR by base/head (go-gitea#29242)
  [skip ci] Updated translations via Crowdin
  Improve Documentation for Restoration from backup (go-gitea#29321)
  Refactor "user/active" related logic (go-gitea#29390)
  Remove jQuery AJAX from the archive download links (go-gitea#29380)
  Add tailwindcss (go-gitea#29357)
  Add missing space (go-gitea#29393)
  Integrate alpine `noarch` packages into other architectures index (go-gitea#29137)
  enforce maxlength in frontend (go-gitea#29389)
  Remove incorrect and unnecessary Escape from templates (go-gitea#29394)
  Make actions animation rotate counterclockwisely (go-gitea#29378)
  Use `crypto/sha256` (go-gitea#29386)
  Add `io.Closer` guidelines (go-gitea#29387)
  Remove jQuery AJAX from the notice selection deletion button (go-gitea#29381)
  Refactor Safe modifier (go-gitea#29392)
  Add attachment support for code review comments (go-gitea#29220)
  Refactor modules/git global variables (go-gitea#29376)
  Remove jQuery from the code diff expansion buttons (go-gitea#29385)
  Remove jQuery AJAX from the markdown editor preview (go-gitea#29384)
  ...
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 4, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. modifies/docs size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants