|
1 | | - name: "Modem Support Request" |
2 | | - description: "Request support for a new cable modem model" |
3 | | - labels: |
4 | | - - "modem support" |
5 | | - - "help wanted" |
6 | | - |
7 | | - body: |
8 | | - - type: markdown |
9 | | - attributes: |
10 | | - value: | |
11 | | - Thanks for requesting support for a new modem! Before filling out this form, please follow the [Requesting Modem Support](https://github.com/itsDNNS/docsight/wiki/Requesting-Modem-Support) guide to |
12 | | - collect the data we need (HAR file, screenshot, firmware version). |
13 | | - |
14 | | - For modems with login-protected web UIs, the HAR file must include the actual login exchange, not only requests made after you are already logged in. |
15 | | - |
16 | | - GitHub may block direct `.har` uploads. Please upload the capture as `.har.txt` or `.zip` if needed. |
17 | | - |
18 | | - - type: input |
19 | | - id: manufacturer |
20 | | - attributes: |
21 | | - label: "Manufacturer" |
22 | | - description: "Who makes the modem?" |
23 | | - placeholder: "e.g., Arris, Technicolor, Netgear, Motorola" |
24 | | - validations: |
25 | | - required: true |
26 | | - |
27 | | - - type: input |
28 | | - id: model |
29 | | - attributes: |
30 | | - label: "Model Number" |
31 | | - description: "Full model number (check the label on the device)" |
32 | | - placeholder: "e.g., Arris TG3442DE, Netgear CM1000" |
33 | | - validations: |
34 | | - required: true |
35 | | - |
36 | | - - type: input |
37 | | - id: firmware |
38 | | - attributes: |
39 | | - label: "Firmware Version" |
40 | | - description: "Current firmware version (usually shown in the web interface)" |
41 | | - placeholder: "e.g., 01.05.063.13.EURO.PC20" |
42 | | - validations: |
43 | | - required: true |
44 | | - |
45 | | - - type: input |
46 | | - id: isp |
47 | | - attributes: |
48 | | - label: "Internet Provider" |
49 | | - description: "Which ISP provides this modem?" |
50 | | - placeholder: "e.g., Vodafone Kabel, PYUR, Comcast" |
51 | | - |
52 | | - - type: dropdown |
53 | | - id: docsis |
54 | | - attributes: |
55 | | - label: "DOCSIS Version" |
56 | | - description: "Which DOCSIS standard does the modem support?" |
57 | | - options: |
58 | | - - "DOCSIS 3.0" |
59 | | - - "DOCSIS 3.1" |
60 | | - - "Don't know" |
61 | | - validations: |
62 | | - required: true |
63 | | - |
64 | | - - type: input |
65 | | - id: web_url |
66 | | - attributes: |
67 | | - label: "Modem Web Interface URL" |
68 | | - description: "What URL do you use to access the modem settings?" |
69 | | - placeholder: "e.g., http://192.168.0.1 or http://192.168.100.1" |
70 | | - validations: |
71 | | - required: true |
72 | | - |
73 | | - - type: dropdown |
74 | | - id: authentication |
75 | | - attributes: |
76 | | - label: "Authentication" |
77 | | - description: "Does the web interface require login?" |
78 | | - options: |
79 | | - - "Yes (username + password)" |
80 | | - - "Yes (password only)" |
81 | | - - "No authentication required" |
82 | | - validations: |
83 | | - required: true |
84 | | - |
85 | | - - type: textarea |
86 | | - id: screenshot |
87 | | - attributes: |
88 | | - label: "DOCSIS Status Page Screenshot" |
89 | | - description: | |
90 | | - Upload a screenshot of the DOCSIS status page showing downstream/upstream channels. |
91 | | - Redact any sensitive information (MAC address, IP, serial number). |
92 | | - placeholder: "Drag and drop a screenshot here" |
93 | | - validations: |
94 | | - required: true |
95 | | - |
96 | | - - type: textarea |
97 | | - id: har_file |
98 | | - attributes: |
99 | | - label: "HAR File (Network Capture)" |
100 | | - description: | |
101 | | - We need a HAR file to understand how your modem's web interface fetches data. Without this, we can't build a driver because every modem and ISP firmware variant uses different API endpoints and |
102 | | - authentication flows. |
103 | | - |
104 | | - How to capture: |
105 | | - 1. Close any already-open modem web UI tabs first |
106 | | - 2. Open Chrome or Firefox and open Developer Tools (F12) -> Network tab |
107 | | - 3. Start recording before opening the modem web interface |
108 | | - 4. Open the modem web interface and log in from a clean browser tab |
109 | | - 5. Navigate to the DOCSIS status page |
110 | | - 6. Right-click in the Network tab and choose "Save all as HAR" |
111 | | - 7. Verify that the HAR includes the actual login request and response flow, not only post-login data requests |
112 | | - 8. Remove passwords, MAC addresses, or serial numbers before uploading |
113 | | - 9. If GitHub rejects raw `.har` uploads, rename the file to `.har.txt` or upload it as a `.zip` archive |
114 | | - 10. Upload the capture here |
115 | | - |
116 | | - Please make sure the capture includes: |
117 | | - - The first request to the modem web UI |
118 | | - - The login request itself, if authentication is required |
119 | | - - The first successful requests that load modem or channel data |
120 | | - placeholder: "Drag and drop .har.txt or .zip file here" |
121 | | - validations: |
122 | | - required: true |
123 | | - |
124 | | - - type: textarea |
125 | | - id: session_behavior |
126 | | - attributes: |
127 | | - label: "Login / Session Behavior" |
128 | | - description: | |
129 | | - Describe when the problem occurs and whether browser access affects it. |
130 | | - placeholder: | |
131 | | - Example: |
132 | | - - Works on first login, fails on second test |
133 | | - - Only fails after a poll cycle |
134 | | - - Fails if the modem UI is open in a browser at the same time |
135 | | - - Browser and DOCSight seem to kick each other out |
136 | | -
|
137 | | - - type: textarea |
138 | | - id: debug_logs |
139 | | - attributes: |
140 | | - label: "Debug Logs (if login or polling fails)" |
141 | | - description: | |
142 | | - If the modem requires authentication or the issue involves failed logins, session expiry, or empty data, please also attach DOCSight debug logs from the same test window as the HAR capture. |
143 | | -
|
144 | | - Example: |
145 | | - - Docker: set `LOG_LEVEL=DEBUG` |
146 | | - - Docker Compose: set `LOG_LEVEL=DEBUG` in the container environment |
147 | | - placeholder: "Paste relevant debug logs here or attach a .txt file" |
148 | | - |
149 | | - - type: textarea |
150 | | - id: capture_conditions |
151 | | - attributes: |
152 | | - label: "Capture Conditions" |
153 | | - description: | |
154 | | - Tell us how the HAR and logs were captured so we can reason about session state correctly. |
155 | | - placeholder: | |
156 | | - Example: |
157 | | - - Modem was freshly rebooted |
158 | | - - No browser tabs to the modem UI were open |
159 | | - - Browser login was done while DOCSight was polling |
160 | | - - Captured on the first login after reboot |
161 | | -
|
162 | | - - type: checkboxes |
163 | | - id: contribution |
164 | | - attributes: |
165 | | - label: "I am willing to help" |
166 | | - description: "Can you help with testing once we have a driver?" |
167 | | - options: |
168 | | - - label: "I can test the driver with my modem" |
169 | | - required: false |
170 | | - - label: "I can provide additional debug logs if needed" |
171 | | - required: false |
172 | | - |
173 | | - - type: textarea |
174 | | - id: additional |
175 | | - attributes: |
176 | | - label: "Additional Information" |
177 | | - description: "Any other details that might help, such as quirks or alternative access methods" |
178 | | - placeholder: "This modem also supports SNMP..." |
| 1 | +name: "Modem Support Request" |
| 2 | +description: "Request support for a new cable modem model" |
| 3 | +labels: |
| 4 | + - "modem support" |
| 5 | + - "help wanted" |
| 6 | +body: |
| 7 | + - type: markdown |
| 8 | + attributes: |
| 9 | + value: | |
| 10 | + Thanks for requesting support for a new modem! Before filling out this form, please follow the [Requesting Modem Support](https://github.com/itsDNNS/docsight/wiki/Requesting-Modem-Support) guide to collect the data we need (HAR file, screenshot, firmware version). |
| 11 | +
|
| 12 | + For modems with login-protected web UIs, the HAR file must include the actual login exchange, not only requests made after you are already logged in. |
| 13 | +
|
| 14 | + GitHub may block direct `.har` uploads. Please upload the capture as `.har.txt` or `.zip` if needed. |
| 15 | +
|
| 16 | + - type: input |
| 17 | + id: manufacturer |
| 18 | + attributes: |
| 19 | + label: "Manufacturer" |
| 20 | + description: "Who makes the modem?" |
| 21 | + placeholder: "e.g., Arris, Technicolor, Netgear, Motorola" |
| 22 | + validations: |
| 23 | + required: true |
| 24 | + |
| 25 | + - type: input |
| 26 | + id: model |
| 27 | + attributes: |
| 28 | + label: "Model Number" |
| 29 | + description: "Full model number (check the label on the device)" |
| 30 | + placeholder: "e.g., Arris TG3442DE, Netgear CM1000" |
| 31 | + validations: |
| 32 | + required: true |
| 33 | + |
| 34 | + - type: input |
| 35 | + id: firmware |
| 36 | + attributes: |
| 37 | + label: "Firmware Version" |
| 38 | + description: "Current firmware version (usually shown in the web interface)" |
| 39 | + placeholder: "e.g., 01.05.063.13.EURO.PC20" |
| 40 | + validations: |
| 41 | + required: true |
| 42 | + |
| 43 | + - type: input |
| 44 | + id: isp |
| 45 | + attributes: |
| 46 | + label: "Internet Provider" |
| 47 | + description: "Which ISP provides this modem?" |
| 48 | + placeholder: "e.g., Vodafone Kabel, PYUR, Comcast" |
| 49 | + |
| 50 | + - type: dropdown |
| 51 | + id: docsis |
| 52 | + attributes: |
| 53 | + label: "DOCSIS Version" |
| 54 | + description: "Which DOCSIS standard does the modem support?" |
| 55 | + options: |
| 56 | + - "DOCSIS 3.0" |
| 57 | + - "DOCSIS 3.1" |
| 58 | + - "Don't know" |
| 59 | + validations: |
| 60 | + required: true |
| 61 | + |
| 62 | + - type: input |
| 63 | + id: web_url |
| 64 | + attributes: |
| 65 | + label: "Modem Web Interface URL" |
| 66 | + description: "What URL do you use to access the modem settings?" |
| 67 | + placeholder: "e.g., http://192.168.0.1 or http://192.168.100.1" |
| 68 | + validations: |
| 69 | + required: true |
| 70 | + |
| 71 | + - type: dropdown |
| 72 | + id: authentication |
| 73 | + attributes: |
| 74 | + label: "Authentication" |
| 75 | + description: "Does the web interface require login?" |
| 76 | + options: |
| 77 | + - "Yes (username + password)" |
| 78 | + - "Yes (password only)" |
| 79 | + - "No authentication required" |
| 80 | + validations: |
| 81 | + required: true |
| 82 | + |
| 83 | + - type: textarea |
| 84 | + id: screenshot |
| 85 | + attributes: |
| 86 | + label: "DOCSIS Status Page Screenshot" |
| 87 | + description: | |
| 88 | + Upload a screenshot of the DOCSIS status page showing downstream/upstream channels. |
| 89 | + Redact any sensitive information (MAC address, IP, serial number). |
| 90 | + placeholder: "Drag and drop a screenshot here" |
| 91 | + validations: |
| 92 | + required: true |
| 93 | + |
| 94 | + - type: textarea |
| 95 | + id: har_file |
| 96 | + attributes: |
| 97 | + label: "HAR File (Network Capture)" |
| 98 | + description: | |
| 99 | + We need a HAR file to understand how your modem's web interface fetches data. Without this, we can't build a driver because every modem and ISP firmware variant uses different API endpoints and authentication flows. |
| 100 | +
|
| 101 | + How to capture: |
| 102 | + 1. Close any already-open modem web UI tabs first |
| 103 | + 2. Open Chrome or Firefox and open Developer Tools (F12) -> Network tab |
| 104 | + 3. Start recording before opening the modem web interface |
| 105 | + 4. Open the modem web interface and log in from a clean browser tab |
| 106 | + 5. Navigate to the DOCSIS status page |
| 107 | + 6. Right-click in the Network tab and choose "Save all as HAR" |
| 108 | + 7. Verify that the HAR includes the actual login request and response flow, not only post-login data requests |
| 109 | + 8. Remove passwords, MAC addresses, or serial numbers before uploading |
| 110 | + 9. If GitHub rejects raw `.har` uploads, rename the file to `.har.txt` or upload it as a `.zip` archive |
| 111 | + 10. Upload the capture here |
| 112 | +
|
| 113 | + Please make sure the capture includes: |
| 114 | + - The first request to the modem web UI |
| 115 | + - The login request itself, if authentication is required |
| 116 | + - The first successful requests that load modem or channel data |
| 117 | + placeholder: "Drag and drop .har.txt or .zip file here" |
| 118 | + validations: |
| 119 | + required: true |
| 120 | + |
| 121 | + - type: textarea |
| 122 | + id: session_behavior |
| 123 | + attributes: |
| 124 | + label: "Login / Session Behavior" |
| 125 | + description: | |
| 126 | + Describe when the problem occurs and whether browser access affects it. |
| 127 | + placeholder: | |
| 128 | + Example: |
| 129 | + - Works on first login, fails on second test |
| 130 | + - Only fails after a poll cycle |
| 131 | + - Fails if the modem UI is open in a browser at the same time |
| 132 | + - Browser and DOCSight seem to kick each other out |
| 133 | +
|
| 134 | + - type: textarea |
| 135 | + id: debug_logs |
| 136 | + attributes: |
| 137 | + label: "Debug Logs (if login or polling fails)" |
| 138 | + description: | |
| 139 | + If the modem requires authentication or the issue involves failed logins, session expiry, or empty data, please also attach DOCSight debug logs from the same test window as the HAR capture. |
| 140 | +
|
| 141 | + Example: |
| 142 | + - Docker: set `LOG_LEVEL=DEBUG` |
| 143 | + - Docker Compose: set `LOG_LEVEL=DEBUG` in the container environment |
| 144 | + placeholder: "Paste relevant debug logs here or attach a .txt file" |
| 145 | + |
| 146 | + - type: textarea |
| 147 | + id: capture_conditions |
| 148 | + attributes: |
| 149 | + label: "Capture Conditions" |
| 150 | + description: | |
| 151 | + Tell us how the HAR and logs were captured so we can reason about session state correctly. |
| 152 | + placeholder: | |
| 153 | + Example: |
| 154 | + - Modem was freshly rebooted |
| 155 | + - No browser tabs to the modem UI were open |
| 156 | + - Browser login was done while DOCSight was polling |
| 157 | + - Captured on the first login after reboot |
| 158 | +
|
| 159 | + - type: checkboxes |
| 160 | + id: contribution |
| 161 | + attributes: |
| 162 | + label: "I am willing to help" |
| 163 | + description: "Can you help with testing once we have a driver?" |
| 164 | + options: |
| 165 | + - label: "I can test the driver with my modem" |
| 166 | + required: false |
| 167 | + - label: "I can provide additional debug logs if needed" |
| 168 | + required: false |
| 169 | + |
| 170 | + - type: textarea |
| 171 | + id: additional |
| 172 | + attributes: |
| 173 | + label: "Additional Information" |
| 174 | + description: "Any other details that might help, such as quirks or alternative access methods" |
| 175 | + placeholder: "This modem also supports SNMP..." |
0 commit comments