rt/wrolpi-help
1
0
Fork 0
mirror of https://github.com/wrolpi/wrolpi-help.git synced 2026-10-25 18:40:11 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Repos: choose a directory; import a clone where it is

Browse source 
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Roland 2026-10-06 19:24:50 -06:00
parent ad99de72ff
commit 11a462c0e1
No known key found for this signature in database
GPG key ID: 1BA620CE6C9A4680
1 changed files with 7 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/modules/repos/index.md
View file

@ -20,6 +20,7 @@ to date while you have Internet access. You can browse a repo's files and read i
| Mode | **Full history** (default) or **Snapshot**. See [Modes](#modes). |
| Branch | Optional. Empty follows the repo's default branch (usually `main` or `master`). |
| Include submodules | Optional. Also download the other repos this repo includes. See [Submodules](#submodules). |
| Directory | Optional. Where to save the repo; it must be empty. Empty saves it in the [Repos Directory](#repos-directory). |
WROLPi clones the repo in the background; its progress is on the Downloads page. Any git host that supports
`https://` works (GitHub, GitLab, Codeberg, Gitea, sourcehut, and others). SSH URLs, and repos that require a password,
@ -37,9 +38,10 @@ If you already have a git clone in your media directory, WROLPi can take it over
> To import a clone, click **Repos** in the navigation bar, click **Import**, then choose the clone's directory.
WROLPi shows the clone's origin, branch and latest commit, and where it will be moved. Then:
WROLPi shows the clone's origin, branch and latest commit. Then:
* The clone is **moved** into the Repos Directory (so its files are no longer indexed).
* The clone **stays where it is**. Unless its directory is ignored, its files stay indexed (searchable); to keep them
out of search, ignore the directory in Files.
* Its URL must be the clone's origin. An SSH origin like `git@github.com:owner/repo.git` is converted to its
`https://` URL; if the clone has no origin, enter its URL.
* Like a new repo, it follows the remote's default branch unless you enter a Branch.
@ -137,6 +139,9 @@ The Repos Directory must start with a fixed directory (like `repos/`) and contai
directory is always ignored when WROLPi refreshes your files, so the many files of a repo do not crowd your file
search. It cannot be (or be inside) another special directory, like `videos` or `config`.
A repo saved in another directory (chosen when adding it, or imported where it was) is not ignored: its files are
indexed, unless you ignore that directory in Files.
## Config
Your repos are saved in `repos.yaml` in the [config directory](../../system/configs.md). If your database is lost, your