Skip to content

Commit 8780cc5

Browse files
committed
Update
1 parent ff8bd96 commit 8780cc5

File tree

6 files changed

+32
-39
lines changed

6 files changed

+32
-39
lines changed

docs/api-reference.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,8 @@ Servers:
99
- `http://localhost:8081` - Main database and authentication server
1010
- `http://localhost:8083` - SSH tunnel management server
1111
- `http://localhost:8084` - SSH file manager server
12-
- `http://localhost:8085` - Server statistics and monitoring server
12+
- `http://localhost:8085` - Server statistics and monitoring server
13+
14+
## Support
15+
16+
If you need help with Termix, you can join the [Discord](https://discord.gg/jVQGdvHDrf) server and visit the support channel. You can also open an issue or open a pull request on the [GitHub](https://github.com/LukeGus/Termix/issues) repo.

docs/contributing.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,8 @@ This will start the backend and the frontend Vite server. You can access Termix
5353
- Follow the existing code style. Use Tailwind CSS with shadcn components.
5454
- Place all API routes in the `main-axios.ts` file. Updating the `openapi.json` is unneeded.
5555
- Include meaningful commit messages.
56-
- Link related issues when applicable.
56+
- Link related issues when applicable.
57+
58+
## Support
59+
60+
If you need help with Termix, you can join the [Discord](https://discord.gg/jVQGdvHDrf) server and visit the support channel. You can also open an issue or open a pull request on the [GitHub](https://github.com/LukeGus/Termix/issues) repo.

docs/json-import.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,8 @@ Use this guide to create JSON files for bulk importing SSH hosts. All examples a
6565

6666
- Maximum 100 hosts per import
6767
- File should contain a "hosts" array or be an array of host objects
68-
- Use the Download Sample button in the Host Manager to get a complete example file
68+
- Use the Download Sample button in the Host Manager to get a complete example file
69+
70+
## Support
71+
72+
If you need help with Termix, you can join the [Discord](https://discord.gg/jVQGdvHDrf) server and visit the support channel. You can also open an issue or open a pull request on the [GitHub](https://github.com/LukeGus/Termix/issues) repo.

docs/oidc.md

Lines changed: 7 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,10 @@ Before configuring OIDC, you need:
7171
- `groups`: Access to user group memberships (if supported)
7272
- **Example**: `openid email profile groups`
7373

74+
### 9. Override User Info URL
75+
- **Purpose**: Override the auto-generated User Info URL if you get a `Failed to get user information`
76+
- **Common values**: `https://your-provider.com/application/o/userinfo/`
77+
7478
## Step-by-Step Configuration
7579

7680
### Step 1: Register Your Application
@@ -140,41 +144,10 @@ Before configuring OIDC, you need:
140144
- Verify the Issuer URL matches your provider's issuer identifier
141145
- Check for protocol mismatches (http vs https)
142146

143-
### Debug Steps
144-
145-
1. Check the browser's developer console for error messages
146-
2. Verify all URLs are accessible from your network
147-
3. Test the OIDC provider's discovery endpoint
148-
4. Ensure your provider supports the OIDC standard
147+
5. **"Failed to get user information" error**
148+
- Use the `Override User Info URL` field in OIDC configs within Termix. You can find this URL within your providers' config.
149149

150150
## Advanced Configuration
151151

152-
### Custom Claims Mapping
153-
If your OIDC provider uses custom claim names, you can map them using the identifier and name path fields:
154-
155-
```json
156-
// Example ID token with custom claims
157-
{
158-
"sub": "user123",
159-
"custom_user_id": "12345",
160-
"custom_display_name": "John Doe"
161-
}
162-
163-
// Configuration
164-
Identifier Path: custom_user_id
165-
Display Name Path: custom_display_name
166-
```
167-
168152
### Multiple OIDC Providers
169-
Currently, Termix supports one OIDC provider at a time. To switch providers, update the configuration with the new provider's details.
170-
171-
## Support
172-
173-
If you encounter issues with OIDC configuration:
174-
175-
1. Check this guide for common solutions
176-
2. Verify your OIDC provider's documentation
177-
3. Ensure all URLs and credentials are correct
178-
4. Test with a simple OIDC client first to verify provider configuration
179-
180-
Remember that OIDC configuration is provider-specific, so always refer to your specific provider's documentation for the most accurate information.
153+
Currently, Termix supports one OIDC provider at a time. To switch providers, update the configuration with the new provider's details.

docs/totp.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,4 +105,8 @@ Backup codes are one-time use codes that allow you to access your account if you
105105
### Using Backup Codes
106106

107107
1. During login, when prompted for a TOTP code
108-
2. Enter one of your backup codes instead of a regular TOTP code
108+
2. Enter one of your backup codes instead of a regular TOTP code
109+
110+
## Support
111+
112+
If you need help with Termix, you can join the [Discord](https://discord.gg/jVQGdvHDrf) server and visit the support channel. You can also open an issue or open a pull request on the [GitHub](https://github.com/LukeGus/Termix/issues) repo.

docs/tunnels.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,4 +212,8 @@ Each tunnel connection has the following configuration fields:
212212
4. **Test Port Forwarding Manually**
213213
```bash
214214
ssh -R source-port:endpoint-host:endpoint-port username@source-host
215-
```
215+
```
216+
217+
## Support
218+
219+
If you need help with Termix, you can join the [Discord](https://discord.gg/jVQGdvHDrf) server and visit the support channel. You can also open an issue or open a pull request on the [GitHub](https://github.com/LukeGus/Termix/issues) repo.

0 commit comments

Comments
 (0)