SynologyNAS Docker Tutorial

[TomerGamerTV]

Checklist

• [X] I read and understood ASF's Contributing guidelines
• [X] I also read Setting-up and FAQ, I don't need help, this is a wiki suggestion
• [X] This is not a translation issue
• [X] This is not ASF-ui wiki suggestion

Wiki page

synologynas

The issue

I managed to set it up on a SynologyNAS and it took me a couple of hours to figure it out alone and get it to work, Because the steps are still fresh in my head I can help making a new wiki page tutorial explaining how to get it to work on a SynologyNAS.

All I need from you is to tell me how to contribute to the wiki page and if this suggestion even going to be used.

Wrong text

No response

Suggested improvement

A new tutorial page on how to get ASF to work on a SynologyNAS with docker

Additional info

Just tell me if you even want me to make a tutorial for you and if yes please guide me on how to do it correctly so it won't be a headache for both sides.

[Abrynos]

I'm not really in favour of the idea of including information about specific hardware vendors and their products in ASF wiki. Both docker and native setup are already documented extensively.

[TomerGamerTV]

I'm not really in favour of the idea of including information about specific hardware vendors and their products in ASF wiki. Both docker and native setup are already documented extensively.

Setting it on something like a SynologyNAS requires way more configuring than what the wiki shows. And that could also work for people that don’t use SynologyNAS, they could use my tutorial as a reference and configure on their own other stuff based on their NAS.

[JustArchi]

As @Abrynos said above, SynologyNAS is a specific hardware, and any resources using specific hardware should be included in that specific hardware wikis, help pages and other resources. ASF already includes full and complete instruction to install it on any supported by us OS, including docker (as ASF provides its own docker image), and even some selected integrations such as systemd (because, once again, we provide ASF-specific integration with it). In similar way we don't have resources on installing ASF on Raspberry Pi or teaching people basics of Linux - that's far out of the scope of the project. It doesn't contribute anything to the project, it contributes to people using specific hardware instead, which is not ASF purpose.

You're free to write your tutorial in any medium you want, even here in GitHub discussions, but ASF wiki is not a proper place for device-specific instructions (in my, and it looks like not only mine, opinion). This is because ASF wiki, as official documentation, abides by same maintenance burden as the code itself, needs to be up-to-date, relevant and precise. Since I don't own your hardware, and have no interest in using or supporting it, I can't make sure that your instructions written here will work in 5 years from now on, neither I want to give people false impression that somebody from the team owns the hardware and can help people with issues. SynologyNAS is not even recommended hardware to run ASF under, due to its heavy limitations and issues, which you probably want to write about.

Due to all of those (and more in my head) reasons, I prefer to not have a dedicated page to such topic.

[TomerGamerTV]

As @Abrynos said above, SynologyNAS is a specific hardware, and any resources using specific hardware should be included in that specific hardware wikis, help pages and other resources. ASF already includes full and complete instruction to install it on any supported by us OS, including docker (as ASF provides its own docker image), and even some selected integrations such as systemd (because, once again, we provide ASF-specific integration with it). In similar way we don't have resources on installing ASF on Raspberry Pi or teaching people basics of Linux - that's far out of the scope of the project. It doesn't contribute anything to the project, it contributes to people using specific hardware instead, which is not ASF purpose.

You're free to write your tutorial in any medium you want, even here in GitHub discussions, but ASF wiki is not a proper place for device-specific instructions (in my, and it looks like not only mine, opinion). This is because ASF wiki, as official documentation, abides by same maintenance burden as the code itself, needs to be up-to-date, relevant and precise. Since I don't own your hardware, and have no interest in using or supporting it, I can't make sure that your instructions written here will work in 5 years from now on, neither I want to give people false impression that somebody from the team owns the hardware and can help people with issues. SynologyNAS is not even recommended hardware to run ASF under, due to its heavy limitations and issues, which you probably want to write about.

Due to all of those (and more in my head) reasons, I prefer to not have a dedicated page to such topic.

So where do I write the tutorial in general or off topic?

[JustArchi]

General is fine :+1:

[Rudokhvist]

Archi, maybe we need separate sub-category for user-created guides?

[TomerGamerTV]

Archi, maybe we need separate sub-category for user-created guides?

I think that would be great, otherwise, tutorials and guides like mine will just get buried in general...