anomaly / gallagher

The missing toolkit for extending Gallagher Command Centre, featuring a CLI, SQL interface, TUI and a Python idiomatic SDK
https://anomaly.github.io/gallagher/
MIT License
11 stars 2 forks source link

Document the missing portions of the WAN configuration in `HARDWARE` configuration, additionally document a `VPN/L2TP` based setup to avoid exposing WAN ports #54

Closed devraj closed 3 months ago

devraj commented 3 months ago

Is your feature request related to a problem? Please describe. Gallagher have been very kind to provide me documentation on how to configure a Controller that is placed outside of the private network.

There are some behaviours that I have noticed that aren't present or obvious in the documentation. These are primarily related to:

Describe the solution you'd like Updated documentation to ensure we can reliably reconfigure the controller to communicate with the Command Centre over a WAN.

Ideally we want this work over a VPN setup so we aren't exposing the WAN port (although the protocol in use is encrypted and firewall rules can be setup to particular IP addresses).

Document various pitfalls of VPN based setup as well:

These can be solved by proper design e.g site-to-site VPN on network appliances.

Describe alternatives you've considered NA

Additional context

devraj commented 3 months ago

I have documented this for the alpha-5 release. For now I am ignoring the requirements around VPN configuration (mostly because it is not a core focus of what we do and it's unlikely that we would turn this into a consulting service either).

For greater chance of success we must narrow our focus down purely to the developer experience and engineering.

If this becomes of interest in the future then we can open the ticket again and revisit the requirements.

I will be sure to reference this ticket in the documentation as alpha-5 is merged into the mainline.