spksrc
spksrc copied to clipboard
SynoCommunity
update rsnapshot package description
Setup
Package Name: rsnapshot Package Version: 1.4.4-4
Expected behavior
The package description should tell the user what to do after the package was installed. e.g. where to place the rsnapshop.conf file, where to store SSH keys, where to find a sample conf file to modify, if any automatic jobs need to be created in Control Center.
Actual behavior
No information about how to use the Synology package.
Steps to reproduce
1. install package 2. check for installed package icons, check package description
The Synocommunity only package existing applicatie in a Synology package to be able to run on a Synology Nas. All information on how to use that application must be provided by the application developers.
I think we can create a simple wiki entry: https://github.com/SynoCommunity/spksrc/wiki/Package-Documentation-Index but yea updating the package description is unlikely. FYI the wiki can be updated by anyone, so feel free to create a new page if we don't get around to doing it.
Package configuration is typically in /var/packages/<packagename>/var or /var/packages/<packagename>/target/var on dsm6
It is possible to integrate a html help file into the DSM help environment. This is described in the Synology Developers Guide in the following chapter. Synology DSM Integration - Application Help
So if somebody would supply for applications a html file with help information in the correct format it can be integrated in a Application Package. The html format should be:
<!DOCTYPE html>
<html class="img-no-display">
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<link href="../../../../help/help.css" rel="stylesheet" type="text/css">
<link href="../../../../help/scrollbar/flexcroll.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../../../../help/scrollbar/flexcroll.js"></script>
<script type="text/javascript" src="../../../../help/scrollbar/initFlexcroll.js"></script>
</head>
<body>
This is my help document content
</body>
</html>
Thanks, Yea that is also a possibility. I just find the GitHub wiki easier to edit/collaborate on. AFAIK the GitHub Wiki has been the recommended way to add documentation.
Some way to contact the application developer who requested his package to be added or navigate to their isssue-ticket system would be a great help and free SynoCommunity of tickets like this.
I've seen that but as Github has no messaging feature, there is no way to contact him. I propose a policy change to have a website or email/forum/discord/whatever as a required field for newly added packages.
You get everything with rsnapshot help. If you need more information you have to dig into the resources available in the www.
Unfortunately there is no man command available under DSM. So we do not include the man pages in our packages.
$ rsnapshot help
rsnapshot 1.4.4
Usage: rsnapshot [-vtxqVD] [-c cfgfile] [command] [args]
Type "man rsnapshot" for more information.
rsnapshot is a filesystem snapshot utility. It can take incremental
snapshots of local and remote filesystems for any number of machines.
rsnapshot comes with ABSOLUTELY NO WARRANTY. This is free software,
and you are welcome to redistribute it under certain conditions.
See the GNU General Public License for details.
Options:
-v verbose - Show equivalent shell commands being executed.
-t test - Show verbose output, but don't touch anything.
This will be similar, but not always exactly the same
as the real output from a live run.
-c [file] - Specify alternate config file (-c /path/to/file)
-q quiet - Suppress non-fatal warnings.
-V extra verbose - The same as -v, but with more detail.
-D debug - A firehose of diagnostic information.
-x one_fs - Don't cross filesystems (same as -x option to rsync).
Commands:
[backuplevel] - A backup level as defined in rsnapshot.conf.
configtest - Syntax check the config file.
sync [dest] - Sync files, without rotating. "sync_first" must be
enabled for this to work. If a full backup point
destination is given as an optional argument, only
those files will be synced.
diff - Front-end interface to the rsnapshot-diff program.
Accepts two optional arguments which can be either
filesystem paths or backup directories within the
snapshot_root (e.g., /etc/ beta.0/etc/). The default
is to compare the two most recent snapshots.
du - Show disk usage in the snapshot_root.
Accepts an optional destination path for comparison
across snapshots (e.g., localhost/home/user/foo).
version - Show the version number for rsnapshot.
help - Show this help message.
Ah, so you're supposed to use it on the command line by enabling SSH on the Synology. Not place your rsnapshot.conf and a dedicated SSH private key somewhere and it's either run by cron already or needs a scheduled task.