From cc0b3a18d9cfbedd41416fc56e745033fc537e09 Mon Sep 17 00:00:00 2001 From: "vladimir.kuznetsov" Date: Tue, 24 Jan 2023 10:38:29 +0300 Subject: [PATCH] moved the container config to a separate diagram --- .gitignore | 2 +- .../wireguardContainerConfig.plantuml | 11 +++++++ .../serverConfigImportProcess.plantuml | 2 +- ...erverConfigProcessingOnConnection.plantuml | 2 +- .../serverConfigWithWriteAccess.plantuml | 31 ++++++++++++++++++ .../serverConfigWithoutWriteAccessV1.plantuml | 30 +++++++++++++++++ .../serverConfigWithoutWriteAccessV2.plantuml | 32 +++++++++++++++++++ .../amneziaWireGuardAdminConfigV1.plantuml | 20 ------------ .../amneziaWireGuardClientConfigV1.plantuml | 20 ------------ .../amneziaWireGuardClientConfigV2.plantuml | 22 ------------- 10 files changed, 107 insertions(+), 65 deletions(-) create mode 100644 docs/configs/containerConfig/wireguard/wireguardContainerConfig.plantuml create mode 100644 docs/configs/serverConfigWithWriteAccess.plantuml create mode 100644 docs/configs/serverConfigWithoutWriteAccessV1.plantuml create mode 100644 docs/configs/serverConfigWithoutWriteAccessV2.plantuml delete mode 100644 docs/configs/wireguard/amneziaWireGuardAdminConfigV1.plantuml delete mode 100644 docs/configs/wireguard/amneziaWireGuardClientConfigV1.plantuml delete mode 100644 docs/configs/wireguard/amneziaWireGuardClientConfigV2.plantuml diff --git a/.gitignore b/.gitignore index 562b2ee7..88a3b397 100644 --- a/.gitignore +++ b/.gitignore @@ -129,4 +129,4 @@ captures/ client/3rd/ShadowSocks/ss_ios.xcconfig # UML generated pics -out/ \ No newline at end of file +out/ diff --git a/docs/configs/containerConfig/wireguard/wireguardContainerConfig.plantuml b/docs/configs/containerConfig/wireguard/wireguardContainerConfig.plantuml new file mode 100644 index 00000000..330bb94d --- /dev/null +++ b/docs/configs/containerConfig/wireguard/wireguardContainerConfig.plantuml @@ -0,0 +1,11 @@ +@startjson +{ + "container : string": "amnezia-wireguard", + "wireguard : array": + { + "last_config : string": "native wireguard config", + "port : string": "port number", + "transport_proto : string": "udp" + } +} +@endjson diff --git a/docs/configs/serverConfigImportProcess.plantuml b/docs/configs/serverConfigImportProcess.plantuml index c9acfc86..3c974d2a 100644 --- a/docs/configs/serverConfigImportProcess.plantuml +++ b/docs/configs/serverConfigImportProcess.plantuml @@ -20,4 +20,4 @@ else (no) endif stop -@enduml \ No newline at end of file +@enduml diff --git a/docs/configs/serverConfigProcessingOnConnection.plantuml b/docs/configs/serverConfigProcessingOnConnection.plantuml index 30c3188d..7ba6bafa 100644 --- a/docs/configs/serverConfigProcessingOnConnection.plantuml +++ b/docs/configs/serverConfigProcessingOnConnection.plantuml @@ -17,4 +17,4 @@ else endif :continue connect process; stop -@enduml \ No newline at end of file +@enduml diff --git a/docs/configs/serverConfigWithWriteAccess.plantuml b/docs/configs/serverConfigWithWriteAccess.plantuml new file mode 100644 index 00000000..e96e43f0 --- /dev/null +++ b/docs/configs/serverConfigWithWriteAccess.plantuml @@ -0,0 +1,31 @@ +@startjson +{ + "containers : array": + [ + { + "container : string": "amnezia-openvpn", + "openvpn : array": "openvpn container config" + }, + { + "container : string": "amnezia-openvpn-cloak", + "openvpn : array": "openvpn container config", + "cloak : array": "cloak container config" + }, + { + "container : string": "amnezia-shadowsocks", + "openvpn : array": "openvpn container config", + "shadowsocks : array": "shadowsocks container config" + }, + { + "container : string": "amnezia-wireguard", + "wireguard : array": "wireguard container config" + } + ], + "defaultContainer : string": "container name", + "description : string": "server name alias", + "hostName : string": "server address", + "password : string": "password for user", + "port : string": "port number", + "userName : string": "user for ssh connection" +} +@endjson diff --git a/docs/configs/serverConfigWithoutWriteAccessV1.plantuml b/docs/configs/serverConfigWithoutWriteAccessV1.plantuml new file mode 100644 index 00000000..a940ef1a --- /dev/null +++ b/docs/configs/serverConfigWithoutWriteAccessV1.plantuml @@ -0,0 +1,30 @@ +@startjson +{ + "containers : array": + [ + { + "container : string": "amnezia-openvpn", + "openvpn : array": "openvpn container config" + }, + { + "container : string": "amnezia-openvpn-cloak", + "openvpn : array": "openvpn container config", + "cloak : array": "cloak container config" + }, + { + "container : string": "amnezia-shadowsocks", + "openvpn : array": "openvpn container config", + "shadowsocks : array": "shadowsocks container config" + }, + { + "container : string": "amnezia-wireguard", + "wireguard : array": "wireguard container config" + } + ], + "defaultContainer : string": "container name", + "description : string": "server name alias", + "dns1 : string": "dns address", + "dns2 : string": "dns address", + "hostName : string": "server address" +} +@endjson diff --git a/docs/configs/serverConfigWithoutWriteAccessV2.plantuml b/docs/configs/serverConfigWithoutWriteAccessV2.plantuml new file mode 100644 index 00000000..0bd0d8c5 --- /dev/null +++ b/docs/configs/serverConfigWithoutWriteAccessV2.plantuml @@ -0,0 +1,32 @@ +@startjson +{ + "containers : array": + [ + { + "container : string": "amnezia-openvpn", + "openvpn : array": "openvpn container config" + }, + { + "container : string": "amnezia-openvpn-cloak", + "openvpn : array": "openvpn container config", + "cloak : array": "cloak container config" + }, + { + "container : string": "amnezia-shadowsocks", + "openvpn : array": "openvpn container config", + "shadowsocks : array": "shadowsocks container config" + }, + { + "container : string": "amnezia-wireguard", + "wireguard : array": "wireguard container config" + } + ], + "defaultContainer : string": "container name", + "description : string": "server name alias", + "dns1 : string": "dns address", + "dns2 : string": "dns address", + "hostName : string": "server address", + "version : number": "2", + "lastConfigStorage : string": "storage address" +} +@endjson diff --git a/docs/configs/wireguard/amneziaWireGuardAdminConfigV1.plantuml b/docs/configs/wireguard/amneziaWireGuardAdminConfigV1.plantuml deleted file mode 100644 index 192c7998..00000000 --- a/docs/configs/wireguard/amneziaWireGuardAdminConfigV1.plantuml +++ /dev/null @@ -1,20 +0,0 @@ -@startjson -{ - "containers : array": - { - "container : string": "amnezia-wireguard", - "wireguard : array": - { - "last_config : string": "native wireguard config", - "port : string": "port number", - "transport_proto : string": "udp" - } - }, - "defaultContainer : string": "amnezia-wireguard", - "description : string": "server name alias", - "hostName : string": "server address", - "password : string": "password for user", - "port : string": "port number", - "userName : string": "user for ssh connection" -} -@endjson \ No newline at end of file diff --git a/docs/configs/wireguard/amneziaWireGuardClientConfigV1.plantuml b/docs/configs/wireguard/amneziaWireGuardClientConfigV1.plantuml deleted file mode 100644 index e35fedd7..00000000 --- a/docs/configs/wireguard/amneziaWireGuardClientConfigV1.plantuml +++ /dev/null @@ -1,20 +0,0 @@ -@startjson -{ - "containers : array": - { - "container : string": "amnezia-wireguard", - "wireguard : array": - { - "isThirdPartyConfig : bool": "depends on import source", - "last_config : string": "native wireguard config", - "port : string": "port number", - "transport_proto : string": "udp" - } - }, - "defaultContainer : string": "amnezia-wireguard", - "description : string": "server name alias", - "dns1 : string": "dns address", - "dns2 : string": "dns address", - "hostName : string": "server address" -} -@endjson \ No newline at end of file diff --git a/docs/configs/wireguard/amneziaWireGuardClientConfigV2.plantuml b/docs/configs/wireguard/amneziaWireGuardClientConfigV2.plantuml deleted file mode 100644 index e7ed24a2..00000000 --- a/docs/configs/wireguard/amneziaWireGuardClientConfigV2.plantuml +++ /dev/null @@ -1,22 +0,0 @@ -@startjson -{ - "containers : array": - { - "container : string": "amnezia-wireguard", - "wireguard : array": - { - "isThirdPartyConfig : bool": "depends on import source", - "last_config : string": "native wireguard config", - "port : string": "port number", - "transport_proto : string": "udp" - } - }, - "defaultContainer : string": "amnezia-wireguard", - "description : string": "server name alias", - "dns1 : string": "dns address", - "dns2 : string": "dns address", - "hostName : string": "server address", - "version : number": "2", - "lastConfigStorage : string": "storage address" -} -@endjson \ No newline at end of file