202 |
203 |
204 | {renderMountsIfAny()}
205 |
206 |
207 | )
208 | }
209 |
210 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 |
2 | Apache License
3 | Version 2.0, January 2004
4 | http://www.apache.org/licenses/
5 |
6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7 |
8 | 1. Definitions.
9 |
10 | "License" shall mean the terms and conditions for use, reproduction,
11 | and distribution as defined by Sections 1 through 9 of this document.
12 |
13 | "Licensor" shall mean the copyright owner or entity authorized by
14 | the copyright owner that is granting the License.
15 |
16 | "Legal Entity" shall mean the union of the acting entity and all
17 | other entities that control, are controlled by, or are under common
18 | control with that entity. For the purposes of this definition,
19 | "control" means (i) the power, direct or indirect, to cause the
20 | direction or management of such entity, whether by contract or
21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
22 | outstanding shares, or (iii) beneficial ownership of such entity.
23 |
24 | "You" (or "Your") shall mean an individual or Legal Entity
25 | exercising permissions granted by this License.
26 |
27 | "Source" form shall mean the preferred form for making modifications,
28 | including but not limited to software source code, documentation
29 | source, and configuration files.
30 |
31 | "Object" form shall mean any form resulting from mechanical
32 | transformation or translation of a Source form, including but
33 | not limited to compiled object code, generated documentation,
34 | and conversions to other media types.
35 |
36 | "Work" shall mean the work of authorship, whether in Source or
37 | Object form, made available under the License, as indicated by a
38 | copyright notice that is included in or attached to the work
39 | (an example is provided in the Appendix below).
40 |
41 | "Derivative Works" shall mean any work, whether in Source or Object
42 | form, that is based on (or derived from) the Work and for which the
43 | editorial revisions, annotations, elaborations, or other modifications
44 | represent, as a whole, an original work of authorship. For the purposes
45 | of this License, Derivative Works shall not include works that remain
46 | separable from, or merely link (or bind by name) to the interfaces of,
47 | the Work and Derivative Works thereof.
48 |
49 | "Contribution" shall mean any work of authorship, including
50 | the original version of the Work and any modifications or additions
51 | to that Work or Derivative Works thereof, that is intentionally
52 | submitted to Licensor for inclusion in the Work by the copyright owner
53 | or by an individual or Legal Entity authorized to submit on behalf of
54 | the copyright owner. For the purposes of this definition, "submitted"
55 | means any form of electronic, verbal, or written communication sent
56 | to the Licensor or its representatives, including but not limited to
57 | communication on electronic mailing lists, source code control systems,
58 | and issue tracking systems that are managed by, or on behalf of, the
59 | Licensor for the purpose of discussing and improving the Work, but
60 | excluding communication that is conspicuously marked or otherwise
61 | designated in writing by the copyright owner as "Not a Contribution."
62 |
63 | "Contributor" shall mean Licensor and any individual or Legal Entity
64 | on behalf of whom a Contribution has been received by Licensor and
65 | subsequently incorporated within the Work.
66 |
67 | 2. Grant of Copyright License. Subject to the terms and conditions of
68 | this License, each Contributor hereby grants to You a perpetual,
69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70 | copyright license to reproduce, prepare Derivative Works of,
71 | publicly display, publicly perform, sublicense, and distribute the
72 | Work and such Derivative Works in Source or Object form.
73 |
74 | 3. Grant of Patent License. Subject to the terms and conditions of
75 | this License, each Contributor hereby grants to You a perpetual,
76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77 | (except as stated in this section) patent license to make, have made,
78 | use, offer to sell, sell, import, and otherwise transfer the Work,
79 | where such license applies only to those patent claims licensable
80 | by such Contributor that are necessarily infringed by their
81 | Contribution(s) alone or by combination of their Contribution(s)
82 | with the Work to which such Contribution(s) was submitted. If You
83 | institute patent litigation against any entity (including a
84 | cross-claim or counterclaim in a lawsuit) alleging that the Work
85 | or a Contribution incorporated within the Work constitutes direct
86 | or contributory patent infringement, then any patent licenses
87 | granted to You under this License for that Work shall terminate
88 | as of the date such litigation is filed.
89 |
90 | 4. Redistribution. You may reproduce and distribute copies of the
91 | Work or Derivative Works thereof in any medium, with or without
92 | modifications, and in Source or Object form, provided that You
93 | meet the following conditions:
94 |
95 | (a) You must give any other recipients of the Work or
96 | Derivative Works a copy of this License; and
97 |
98 | (b) You must cause any modified files to carry prominent notices
99 | stating that You changed the files; and
100 |
101 | (c) You must retain, in the Source form of any Derivative Works
102 | that You distribute, all copyright, patent, trademark, and
103 | attribution notices from the Source form of the Work,
104 | excluding those notices that do not pertain to any part of
105 | the Derivative Works; and
106 |
107 | (d) If the Work includes a "NOTICE" text file as part of its
108 | distribution, then any Derivative Works that You distribute must
109 | include a readable copy of the attribution notices contained
110 | within such NOTICE file, excluding those notices that do not
111 | pertain to any part of the Derivative Works, in at least one
112 | of the following places: within a NOTICE text file distributed
113 | as part of the Derivative Works; within the Source form or
114 | documentation, if provided along with the Derivative Works; or,
115 | within a display generated by the Derivative Works, if and
116 | wherever such third-party notices normally appear. The contents
117 | of the NOTICE file are for informational purposes only and
118 | do not modify the License. You may add Your own attribution
119 | notices within Derivative Works that You distribute, alongside
120 | or as an addendum to the NOTICE text from the Work, provided
121 | that such additional attribution notices cannot be construed
122 | as modifying the License.
123 |
124 | You may add Your own copyright statement to Your modifications and
125 | may provide additional or different license terms and conditions
126 | for use, reproduction, or distribution of Your modifications, or
127 | for any such Derivative Works as a whole, provided Your use,
128 | reproduction, and distribution of the Work otherwise complies with
129 | the conditions stated in this License.
130 |
131 | 5. Submission of Contributions. Unless You explicitly state otherwise,
132 | any Contribution intentionally submitted for inclusion in the Work
133 | by You to the Licensor shall be under the terms and conditions of
134 | this License, without any additional terms or conditions.
135 | Notwithstanding the above, nothing herein shall supersede or modify
136 | the terms of any separate license agreement you may have executed
137 | with Licensor regarding such Contributions.
138 |
139 | 6. Trademarks. This License does not grant permission to use the trade
140 | names, trademarks, service marks, or product names of the Licensor,
141 | except as required for reasonable and customary use in describing the
142 | origin of the Work and reproducing the content of the NOTICE file.
143 |
144 | 7. Disclaimer of Warranty. Unless required by applicable law or
145 | agreed to in writing, Licensor provides the Work (and each
146 | Contributor provides its Contributions) on an "AS IS" BASIS,
147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 | implied, including, without limitation, any warranties or conditions
149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 | PARTICULAR PURPOSE. You are solely responsible for determining the
151 | appropriateness of using or redistributing the Work and assume any
152 | risks associated with Your exercise of permissions under this License.
153 |
154 | 8. Limitation of Liability. In no event and under no legal theory,
155 | whether in tort (including negligence), contract, or otherwise,
156 | unless required by applicable law (such as deliberate and grossly
157 | negligent acts) or agreed to in writing, shall any Contributor be
158 | liable to You for damages, including any direct, indirect, special,
159 | incidental, or consequential damages of any character arising as a
160 | result of this License or out of the use or inability to use the
161 | Work (including but not limited to damages for loss of goodwill,
162 | work stoppage, computer failure or malfunction, or any and all
163 | other commercial damages or losses), even if such Contributor
164 | has been advised of the possibility of such damages.
165 |
166 | 9. Accepting Warranty or Additional Liability. While redistributing
167 | the Work or Derivative Works thereof, You may choose to offer,
168 | and charge a fee for, acceptance of support, warranty, indemnity,
169 | or other liability obligations and/or rights consistent with this
170 | License. However, in accepting such obligations, You may act only
171 | on Your own behalf and on Your sole responsibility, not on behalf
172 | of any other Contributor, and only if You agree to indemnify,
173 | defend, and hold each Contributor harmless for any liability
174 | incurred by, or claims asserted against, such Contributor by reason
175 | of your accepting any such warranty or additional liability.
176 |
177 | END OF TERMS AND CONDITIONS
--------------------------------------------------------------------------------
/ui/src/configurationEditor/ConfigurationEditor.tsx:
--------------------------------------------------------------------------------
1 | import {
2 | Box,
3 | Button,
4 | FormControl,
5 | Grid,
6 | InputLabel,
7 | MenuItem,
8 | Select,
9 | SelectChangeEvent,
10 | Slide,
11 | Typography
12 | } from "@mui/material";
13 | import DataObjectIcon from "@mui/icons-material/DataObject";
14 | import PublishIcon from "@mui/icons-material/Publish";
15 | import UndoIcon from "@mui/icons-material/Undo";
16 | import {useEffect, useState} from "react";
17 | import {InstancesService} from "../instances/InstancesService";
18 | import {Add, Close, FileDownload} from "@mui/icons-material";
19 | import {NewConfigurationFile} from "./NewConfigurationFile";
20 | import {createDockerDesktopClient} from "@docker/extension-api-client";
21 | import {Editor} from "../prism/Editor";
22 | import {Base64} from "js-base64";
23 |
24 | interface ConfigurationEditorProps {
25 | nginxInstance: any
26 |
27 | }
28 |
29 | //Refactor! Dependency violation!
30 | let instanceService: InstancesService = new InstancesService()
31 |
32 | export function ConfigurationEditor(props: ConfigurationEditorProps) {
33 | const [configFile, setCF] = useState("")
34 | const [fileName, setFileName] = useState("")
35 | const [configurationFileContent, setCFContent] = useState("");
36 | const [oldConfiguration, setOldConfiguration] = useState("");
37 | const [configuration, setConfiguration] = useState([])
38 | const [newConfigurationFileSlide, setNewConfigurationFileSlide] = useState(false);
39 | const [errorClasses, setErrorClasses] = useState({
40 | bannerBackground: "nginx-banner-neutral",
41 | bannerErrorMessage: "",
42 | backToDashboardDisabled: false,
43 | undoChangesButtonDisabled: true,
44 | });
45 |
46 | useEffect(() => {
47 | const getConfiguration = async () => {
48 | instanceService.getConfigurations(props.nginxInstance.id).then((data: any) => {
49 | let filesArray: Array = data
50 | filesArray = filesArray.filter(item => item != "").map((item: string) => {
51 | let match = item.match('\\/.*$');
52 | if (match != undefined) {
53 | return match[0].replace(`:`, ``)
54 | } else {
55 | return ""
56 | }
57 | })
58 | setConfiguration(filesArray)
59 | })
60 | }
61 | getConfiguration().catch(console.error)
62 | }, [])
63 |
64 | const configurationFileOnClickHandler: any = (fileName: string) => (event: any) => {
65 | instanceService.getConfigurationFileContent(fileName, props.nginxInstance.id).then((data: any) => {
66 | setOldConfiguration(data.stdout)
67 | setCFContent(data.stdout);
68 | setFileName(fileName);
69 | }).catch((error: any) => console.error())
70 |
71 | }
72 | const saveConfigurationToFile: any = (file: string, containerId: string) => (event: any) => {
73 | //build dynamically from TextInput as B64.
74 | const content = Base64.encode(configurationFileContent)
75 | instanceService.sendConfigurationToFile(file, containerId, content).then((data: any) => {
76 | //error handling here.
77 | instanceService.reloadNGINX(containerId).then((data: any) => {
78 | instanceService.displaySuccessMessage("Configuration successfully updated!");
79 | setErrorClasses({
80 | bannerBackground: "nginx-banner-neutral",
81 | backToDashboardDisabled: false,
82 | undoChangesButtonDisabled: true,
83 | bannerErrorMessage: ""
84 | });
85 | }).catch((reason: any) => {
86 | instanceService.displayErrorMessage(`Error while updating configuration: ${reason.stderr.split("\n")[1]}`);
87 | setErrorClasses({
88 | bannerBackground: "nginx-banner-error",
89 | backToDashboardDisabled: true,
90 | undoChangesButtonDisabled: false,
91 | bannerErrorMessage: `Error while updating configuration: ${reason.stderr.split("\n")[1]}`
92 | });
93 | })
94 | })
95 | }
96 | const nginxConfigurationFileOnChangeHandler = (event: SelectChangeEvent) => {
97 | setCF(event.target.value as string);
98 | setFileName(event.target.value as string);
99 | instanceService.getConfigurationFileContent(event.target.value as string, props.nginxInstance.id).then((data: any) => {
100 | setOldConfiguration(data.stdout)
101 | setCFContent(data.stdout);
102 | }).catch((error: any) => console.error())
103 | };
104 | const undoChanges: any = () => {
105 | setCFContent(oldConfiguration)
106 | const content = Base64.encode(oldConfiguration)
107 | instanceService.sendConfigurationToFile(fileName, props.nginxInstance.id, content).then((data: any) => {
108 | //error handling here.
109 | instanceService.reloadNGINX(props.nginxInstance.id).then((data: any) => {
110 | instanceService.displaySuccessMessage("Configuration rollback successful");
111 | setErrorClasses({
112 | bannerBackground: "nginx-banner-neutral",
113 | backToDashboardDisabled: false,
114 | undoChangesButtonDisabled: true,
115 | bannerErrorMessage: ""
116 | });
117 | }).catch((reason: any) => {
118 | instanceService.displayErrorMessage("Error while rolling back configuration! Contact Support!");
119 | setErrorClasses({
120 | bannerBackground: "nginx-banner-error",
121 | backToDashboardDisabled: true,
122 | undoChangesButtonDisabled: false,
123 | bannerErrorMessage: `Error while updating configuration: ${reason.stderr.split("\n")[1]}`
124 | });
125 | })
126 | })
127 | }
128 |
129 | const handleNewConfigurationFileSlide = () => {
130 | setNewConfigurationFileSlide((prev) => !prev);
131 | };
132 |
133 | const content = (
134 |
146 |
156 |
157 |
158 |
159 |
160 | );
161 |
162 | const handleExportConfigurationFile = async () => {
163 | let ddClient = createDockerDesktopClient();
164 |
165 | const result: any = await ddClient.desktopUI.dialog.showOpenDialog({
166 | properties: ["openDirectory"],
167 | });
168 | }
169 |
170 | return (
171 |
172 |
173 | {content}
174 |
175 |
176 |
177 | Configuration File
178 |
190 |
191 |
192 | {!configurationFileContent ? (
193 |
194 |
195 |
196 |
197 |
198 | Please select a configuration file
199 |
200 |
201 |
205 |
206 |
207 | ) : (
208 |
209 |
210 |
211 | {fileName}
212 |
213 |
215 |
218 | {/**/}
222 |
228 |
229 |
230 | Configuration Editor
231 |
233 |
234 |
235 | )}
236 |
237 | )
238 | }
239 |
--------------------------------------------------------------------------------
/ui/src/instances/NginxInstances.tsx:
--------------------------------------------------------------------------------
1 | import React, {MouseEventHandler, useEffect, useState} from 'react';
2 | import {InstancesService} from "./InstancesService";
3 | import {
4 | Box,
5 | Grid,
6 | IconButton,
7 | Tab,
8 | Tabs,
9 | Tooltip,
10 | ThemeProvider,
11 | Typography,
12 | createTheme, Button,
13 | } from "@mui/material";
14 | import "./Instance.css";
15 |
16 | import {
17 | ArrowBackIosNewOutlined
18 | } from "@mui/icons-material";
19 |
20 | import DnsIcon from '@mui/icons-material/Dns';
21 | import BorderColorIcon from '@mui/icons-material/BorderColor';
22 | import TabContext from '@mui/lab/TabContext';
23 | import TabPanel from '@mui/lab/TabPanel';
24 | import {ConfigurationUi} from "../configurationUI/ConfigurationUi";
25 | import {ConfigurationEditor} from "../configurationEditor/ConfigurationEditor";
26 | import {TemplateStore} from "../templateStore/TemplateStore";
27 |
28 |
29 | interface NginxInstances {
30 | id: string,
31 | name: string,
32 | mounts: Array,
33 | networks: Array
34 | }
35 |
36 | export function NginxInstance() {
37 | //Refactoring - Make the state more inclusive
38 | // - (merge ContainerId, ConfigurationFile and ConfigurationFileContent) in a single state property.
39 | //
40 | const [instances, setResponse] = useState([]);
41 | const [containerId, setContainerId] = useState(undefined);
42 | const [loading, setLoading] = useState(true);
43 |
44 | const [errorClasses, setErrorClasses] = useState({
45 | bannerBackground: "nginx-banner-neutral",
46 | bannerErrorMessage: "",
47 | backToDashboardDisabled: false,
48 | undoChangesButtonDisabled: true
49 | });
50 |
51 | //new State Object - old stuff has to be refactored!
52 | const [nginxInstance, setNginxInstance] = useState({id: "", name: "", mounts: [], networks: []})
53 | // Holds the "original" Configuration before modifying to be able to role-back in case of errors.
54 |
55 | const instanceService: InstancesService = new InstancesService()
56 |
57 | useEffect(() => {
58 | const instancePromise = async () => {
59 | instanceService.getInstances().then((data: any) => {
60 | const instancesArray: Array = []
61 | data.map(async (inst: any, index: number) => {
62 | const container = await Promise.resolve(inst.promise).catch((reason: any) => {
63 | })
64 | if (container != undefined && !container.code) {
65 | instancesArray.push({
66 | id: inst.container,
67 | out: container.stderr,
68 | ports: inst.ports,
69 | networks: inst.networks,
70 | mounts: inst.mounts,
71 | status: inst.status,
72 | name: inst.name.replace("/", "")
73 | })
74 | }
75 | });
76 | setResponse(instancesArray)
77 | setLoading(false)
78 | console.log(instancesArray)
79 | });
80 | }
81 |
82 | instancePromise().catch(console.error)
83 | }, []);
84 |
85 | const nginxInstanceOnClickHandler: MouseEventHandler | any = (containerId: string, name: string) => (event: MouseEventHandler) => {
86 | instanceService.getConfigurations(containerId).then((data: any) => {
87 | const mounts = instances.find(({id}: any) => id === containerId).mounts || []
88 | const networks = instances.find(({id}: any) => id === containerId).networks || []
89 |
90 | setNginxInstance({id: containerId, name: name, mounts: mounts, networks: networks})
91 | })
92 | }
93 |
94 | //Refactoring! Move this into a separate component
95 | const [tabValue, setTabValue] = useState('1');
96 | const handleTabChange = (event: React.SyntheticEvent, newValue: string) => {
97 | setTabValue(newValue);
98 | };
99 |
100 | const containerNetwork: any = (port: any, key: number) => {
101 | if (port.PrivatePort && port.PublicPort) {
102 | return (
103 |
104 | {`${port.PublicPort}:${port.PrivatePort} (${port.Type})`}
105 |
106 | )
107 | }
108 | if (port.PrivatePort && !port.PublicPort) {
109 | return (
110 |
111 | {`unbound:${port.PrivatePort} (${port.Type})`}
112 |
113 | )
114 | }
115 | }
116 |
117 | const renderErrorMessageIfAny = () => {
118 | if (errorClasses.undoChangesButtonDisabled === false) {
119 | return (
120 |
121 | {errorClasses.bannerErrorMessage}. Click "Undo Changes"!
122 |
123 | )
124 | }
125 | }
126 |
127 | return (
128 |
129 | {!loading ? (
130 | !nginxInstance.id ? (
131 | instances == 0 ? (
132 |
133 | There are no active NGINX containers! Start a container to get started!
134 | {/* @ts-expect-error not typed yet! */}
135 | docker run -d -P
136 | nginx:latest
137 | ) : (
138 |
139 | Active containers running NGINX
140 | {
141 | instances.map((inst: any, key: number) => (
142 |
143 |
148 | {inst.name}
149 | Container ID:
150 | {inst.id.substring(0, 12)}
152 |
153 | Status:
154 | {inst.status.toLowerCase()}
156 |
157 |
158 | NGINX
159 | Version:
160 |
162 | {inst.out.substring(15, inst.out.length)}
163 |
164 |
165 |
166 | Network:
167 | {inst.networks.map((network: any, key: number) => (
168 | {network[0]} - {network[1]['IPAddress']}
170 | ))}
171 |
172 |
173 | Open Ports
174 | (Host:Container):
175 | {inst.ports.map((port: any, key: number) => containerNetwork(port, key))}
176 |
177 | {inst.mounts.length > 0 ? (
178 |
179 | Number of Mounted
180 | Volumes:
181 | {inst.mounts.length}
183 |
184 | ) : ("")}
185 |
186 |
187 | ))}
188 |
189 |
190 | )
191 | ) : (
192 |
193 |
194 |
195 |
196 | {
197 | setContainerId(undefined)
198 | setNginxInstance({id: "", name: "", mounts: [], networks: []})
199 | }} disabled={errorClasses.backToDashboardDisabled}>
200 |
201 |
202 |
203 | {nginxInstance.name}
204 |
205 |
206 | Container ID: {nginxInstance.id.substring(0, 12)}
207 |
208 | {renderErrorMessageIfAny()}
209 |
210 |
211 |
212 |
213 |
214 | } label="Servers" value={"1"}/>
215 | } label="Configuration Editor" value={"2"}/>
216 | {/*} label="Templates Store" value={"3"}/>*/}
217 | {/*} label="Export Configuration" value={"4"}/>*/}
218 |
219 |
220 |
221 |
222 |
223 |
224 |
225 |
226 |
227 |
228 |
229 |
230 | <>Exports
231 |
232 |
233 |
234 | )
235 | ) : (Loading...)}
236 |
237 | );
238 | }
239 |
--------------------------------------------------------------------------------