Sync wikijs with github wiki - homepages diverge

[chamalis]

Hi all,

Wiki.js Git storage behaves inconsistently for homepage when trying to support both Wiki.js home and GitHub wiki Home.md

Environment

Wiki.js 2.5.308
Docker / Compose
Postgres 17.5
Git storage over SSH to GitHub
Deployed under a subdomain `wiki.int.domain.com:7777` whose DNS record point to intranet IP. 

I can open all

/Home
/Home.md
/home
/home.md

which lead to the same homepage due to symlinks set up (read description below).

Problem summary

Normal pages sync correctly. The problem is specific to the homepage when trying to satisfy both:

• Wiki.js homepage slug/path: home
• GitHub wiki homepage filename: Home.md

Given that:

• wikijs URLs are case sensitive

Depending on how Home.md / home.md are arranged, there are 3 observed different bad outcomes.

Case 1 — Home.md real file, home.md -> Home.md symlink

Editing normal pages in Wiki.js works.
Editing homepage in Wiki.js logs:

Committing updated file [en] home...

but no local Git commit is created
Home.md remains modified and unstaged
next scheduled sync fails with:

Rendering page ID 114: [ COMPLETED ]
(STORAGE/GIT) Committing updated file [en] home...
Syncing with storage target git...
(STORAGE/GIT) Performing pull rebase from origin on branch main...
error: cannot pull with rebase: You have unstaged changes.

Result

GitHub homepage renders
Wiki.js homepage edits break Git sync

Case 2 — home.md real file, Home.md -> home.md symlink

This was tried as the opposite arrangement.

Homepage edits from Wiki.js can be committed/pushed
but GitHub wiki frontend becomes wrong / broken
in one variant GitHub rendered the homepage incorrectly / effectively empty
I suppose because github's wiki does not follow symlinks.

Result

Wiki.js side behaves better
GitHub homepage breaks

Case 3 — Home.md regular file, home -> Home.md symlink (no home.md)

This unexpectedly syncs without Git errors.

Wiki.js commits and pushes homepage edits successfully
but what is committed a new home.md file
so GitHub wiki frontend still renders the previous homepage from Home.md, therefore the home pages diverge.

Result

Git sync succeeds
the new homepage content is effectively ignored by the Github frontend

Conclusion

My question is, if sync breaks the homepage, how do people make use of wiki.js's github bidirectional auto-sync functionality? Is it only meant to update the remote repo? In that case bidirectional doesn't make sense to me. It should be only local wikijs -> git repo, no?

Thank you for your time!