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

Update Synology docs #141

Merged
merged 2 commits into from
Jan 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Please download binaries from our [releases](https://github.com/nzbgetcom/nzbget

We also provide a docker image for popular architectures. [Docker readme](docker/README.md)

Synology DSM 7.x packages also available. [Synology readme](synology/README.md)
Synology packages are available as SynoCommunity packages and SPK packages. [Synology readme](synology/README.md)

## Migration from older NZBGet versions

Expand Down
35 changes: 35 additions & 0 deletions synology/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,28 @@
# Synology nzbget packages

We support Synology via SynoCommunity package (DSM 3.x / 6.x / 7.x) and native SPK package (DSM 7.x) for manual installation.

* [SynoCommunity package (DSM 3.x / 6.x / 7.x)](#synocommunity-package)
* [SPK package (DSM 7.x)](#spk-package)
* [Switch between SynoCommunity package and SPK](#switch-between-synocommunity-package-and-spk)


# SynoCommunity package

DSM versions: 3.x / 6.x / 7.x

https://synocommunity.com/package/nzbget

If you don't have SynoCommunity repository added on your device - please follow easy install instructions https://synocommunity.com/

If you have SynoCommunity added on your device - please simply install NZBGet under `Packages` - `Community`

If you have installed original NZBGet version (package version `20220406-29` and below) - upgrade to nzbgetcom version (latest / `20240115-30`)

# SPK package

DSM versions: 7.x

## Package versions

We provide native packages for most Synology platforms (DSM 7.x). To select a correct package for yours platform please find Synology model in [Synology NAS list](https://kb.synology.com/en-us/DSM/tutorial/What_kind_of_CPU_does_my_NAS_have) and select package based on `Package Arch` field:
Expand Down Expand Up @@ -51,3 +74,15 @@ When installed, the package adds all the necessary permissions for the selected
## Extensions

You can put custom extension in `ScriptDir` directory. During installation this directory appears in `selected_shared_folder\selected_download_directory\scripts` and populates with default scripts (Email and Logger). Synology DSM 7.x bundled with python 3.8, so you must make sure that the script you are installing supports it. Our forks of VideoSort/FailureLink/FakeDetector are tested and working.

# Switch between SynoCommunity package and SPK

- backup settings via WebUI
- remove old package completely (with wipe settings)
- install new version
- restore needeed settings
- fix download directory permissions (if needed)

## Known issues:

- if you switch from our old native SPK package to SynoCommunity, you may get an error running the package. To fix - install latest testing SPK for your platform and remove it completely (this error fixed in latest SPK) OR uninstall SynoCommunity package completely (with wipe settings) and reinstall again.