OPNsense Forum
English Forums => Development and Code Review => Topic started by: annduy on December 06, 2023, 01:56:16 pm
-
I'm building a SDwan solution based on opnsense/wireguard/ospf. However, there is still an issue: I don't know how to restore a backup via API?
Please have a look then advise/comment.
https://youtu.be/c0L-5hwFrn4?si=0zUQyzdvm4RNuiEP (https://youtu.be/c0L-5hwFrn4?si=0zUQyzdvm4RNuiEP)
Thanks.
Annduy
-
The issue about restore opnsense's configuration was resolved as in the clip
https://youtu.be/Wz0CVxiWaw8 (https://youtu.be/Wz0CVxiWaw8)
And the updated introductory clip of my SDWan project
https://youtu.be/p1WQkB71Kis (https://youtu.be/p1WQkB71Kis)
Merry Xmas to all. :)
Annduy
-
Hi all,
My SDWan project was developed based on:
1. Opnsense for core functionality
2. AppSmith + Vue.js + Joint.js for frontend
3. Python + MongoDB for backend
4. Debian as Operating System
If I do commercialize my work, do I violate any copyright? if yes, how to fix the issue? :D
Thanks in advance for any advice,
Annduy.
-
If you want your project to gain any traction consider documenting what you did in written format. Video sucks and nobody in my generation is going to waist time watching. I can read multiple times as fast as anybody can speak, you need to pause and rewind to "reread" a sentence, you cannot copy & paste from a video. It's the absolute worst format for technical documentation.
As for the copyright question:
https://github.com/opnsense/core/blob/master/LICENSE
HTH,
Patrick
-
No problem to sell a product if in your source is still the original copyright.
-
Thanks @Patrick and and @Mimugmail for the advices.
Sorry for my late reply due to my travel in the last week. I've just resumed to work today, :).
@Patrick: In fact, the video is just to demonstrate how my product works. You can ignore it if video wastes your time. For you visibility, I do brief about my work:
1. Basically, there are 2 components in a SDWan solution: SDWan Edge Devices and SDWan Controller. Of course, there are still many other components in a commercial SDWan. However, at basis level I just consider the two mentioned components.
2. in my design, the prerequisites to an edge device is capability to manage the below configuration items via API calls:
- Create a connection from a device to another device.
- Manage routing entries on a device.
Fortunately, the above requirement is available in Opnsense via the plugins WireGuard VPN and FRR Routing Suite. Therefore, I just use these plugins in my SDWan project, do not need any further development at edge device side.
3. I just focus in developing the controller (web application) to provide webGUI to user. Then in its turn, the controller will perform API calls to create connections between edge devices as well as setup proper routing between edge devices.
Another API set is also used in my project is os-api-backup to keep the configuration of all edge devices centrally in my controller, in order that from controller we can backup/restore a certain edge device.
Well, in the project I leverage the OpnSense and some of its plugins: WireGuard, FRR Routing and os-api-backup. I just want to ensure that I have no issue about copyright with Deciso and the owners of mentioned plugins.
Thanks Patrick for your advice about documents. In fact, now I'm maintaining some documents: design document, code reference document. In future, when I implement it at customers, some other documents: deployment guide document, admin guide document, maintenance and support document,... must be in place.
@Mimugmail: great to to hear from you that there is no legal issue with my work if the original copyright is still in my source. However, as you see, I do not touch at the source code of OpnSense and the plugins. I just build my own controller (on another machine) that will change the configuration of OpnSense via APIs provided by OpnSense's plugins. if so, is there any potential legal risk with my approach? I'm thinking about the message "Powered by OpnSense and its plugins" at the footer of the WebGUI of my controller. is this citation appropriate?
Thank you, my friends.
Annduy
-
if so, is there any potential legal risk with my approach? I'm thinking about the message "Powered by OpnSense and its plugins" at the footer of the WebGUI of my controller. is this citation appropriate?
According to my understanding there cannot be any legal risk selling a product that simply plugs into an existing one via a public API.
You might want to consider the copyright situation of the Linux base system you are using to build your controller, though. Most of the Linux system is GPL licensed and whether your software represents a "derivative work" according to the terms of the GPL or not is best discussed with a lawyer.
As for OPNsense it is licensed under the BSD 2-clause license which neither mandates nor prohibits mentioning the product in advertising materials or similar so you are very probably fine.
Anyway I would ask the copyright/brand holder (Deciso probably or maybe @franco can chime in here) how they want the project to be referred to - i.e. whether it's supposed to be "OPNsense" or "The OPNsense project" or whatever. Just basic politeness, essentially.
Kind regards,
Patrick
-
Thanks Patrick so much for your very positive feedback. This motivates me a lot, ;D . I have no more concern about legal risk and I'm ready to go ahead my project.
Once again, thank you both @Patrick and @Mimugmail for valuable advices.
Annduy.
-
Hi Annduy, I'm interested in your project how can I contact you?
-
Hi Annduy, i am also working on SDWAN please do let me know if we can connect?
Regards
Yogendra