Documentation hasbroken links
Closed this issue · 2 comments
Serversync Version: 4.2.0
Minecraft Version: N/A
Issue: Documentation is lacking, what are the options for sync_mode and directories mode: mirror? There are also many broken links in the documentation wiki pages.
Can't seem to find this documented anywhere. Wondering if there is an option available to make the directories match exactly by deleting any folders which do not match but also just interested in what settings are available for these options and what they actually do?
The default mode of operation is to make any configured directories match exactly, its the only way to really guarantee that a client can connect.
e.g. this would be a super basic setup that just mirrors everything in mods.
{
"rules": {
"files": ["mods/**"],
"directories": [{"path": "mods", "mode": "mirror"}]
}
}There are only two modes currently, mirror and push.
The idea behind push is for syncing directories like config where loads of valid user files exist that you don't want to delete. That being said I would not generally recommend syncing the entire config directory.
Ignore sync_mode, its a bit of an internal detail and should not be changed.
Do you have more specific pages on the wiki with broken links? They all seem to function properly.
https://github.com/superzanti/ServerSync/wiki/Server-setup
The config files definitely need some dedicated docs though.