Skip to content

Commit 3e107ce

Browse files
LukeGusLukeGus
authored
v1.11.1 (#11)
* feat: update docs * feat: update docs * feat: add opkssh docs * feat: improve opkssh docs * feat: improve opkssh docs * feat: update docs * feat: update docs * feat: update docs * feat: update docs
1 parent 628326e commit 3e107ce

14 files changed

+621
-6
lines changed

‎docs/api/delete-opkssh-token-for-a-host.api.mdx‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
id: delete-opkssh-token-for-a-host
3+
title: "Delete OPKSSH token for a host"
4+
description: "Delete OPKSSH token for a host"
5+
sidebar_label: "Delete OPKSSH token for a host"
6+
hide_title: true
7+
hide_table_of_contents: true
8+
api: eJyNVE1v2zAM/SsCTxsgNN66boBvHdKh2QdWNBl2CHxgbCYWYkuuRBcNDP33gbbbtXWw5STLeHwkn8jXAeMuQLqG5fIaMg2B8tYbPkC67mBD6MlftlxCus5ipqFBjzUx+dADLNYEKZQu8KIADcZCCg1yCRo83bXGUwEp+5Y0hLykGiHtgA+NRBnLtCMPUUNBIfemYeOE4NoFVos5SEJPoXE2UJDA90kix0v0yu3JqoIqYipUaPOcQti2VXUQ5otjIQvL5C1WKpC/J6/Ie+chTgqZ96Tq58235fJacZ9o67xCJR2Dhpq4dAWkMKQHPTSfwiyEcuaavRx93KwbRIogGkvWQcHWVyIgc5POZpXLsRJcep4kyTt4Xc8PNFYVyLjBQAptobDlkiybHAUy9gNR/5P4fELct9daS5Wq0eKOarJ8ItuHo2xbU9HI5U8kupgSDc8TGNkENnnoe66dNey8sbsTiT9OiOcYyo1DX5zI8GnK4PI9+WNqPVuipYz8MLrPV+lpAyQXjJsh9wEEevz44nyNDCl8/b3qp9PYrevDDVeCX5GvzYO6vFmABhmpobbkLDlLJhWP4M+Y78kWEqRuaUuebE6yKY0LXKMV/nGt/zv+LxI8dcX0wLOmQmOFtle1G/diDSGINwybARp6UtCQjhaS6d5MBNl1MuW/fBWj/L5ryYsrZRru0RvciALrDgoT5LuAdItVoElRubNMVlR8czs60lv16DD6eM3jT7QH0RWrVm6gYU+Hv24Xs/jMAOZX369WV6ABXz7xqyftSz5K33UDorezGJ+yDQrFLMb4B0T37RI=
9+
sidebar_class_name: "delete api-method"
10+
info_path: api/termix-api
11+
custom_edit_url: null
12+
---
13+
14+
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
15+
import ParamsDetails from "@theme/ParamsDetails";
16+
import RequestSchema from "@theme/RequestSchema";
17+
import StatusCodes from "@theme/StatusCodes";
18+
import OperationTabs from "@theme/OperationTabs";
19+
import TabItem from "@theme/TabItem";
20+
import Heading from "@theme/Heading";
21+
22+
<Heading
23+
as={"h1"}
24+
className={"openapi__heading"}
25+
children={"Delete OPKSSH token for a host"}
26+
>
27+
</Heading>
28+
29+
<MethodEndpoint
30+
method={"delete"}
31+
path={"/ssh/opkssh/token/{hostId}"}
32+
context={"endpoint"}
33+
>
34+
35+
</MethodEndpoint>
36+
37+
38+
39+
Delete OPKSSH token for a host
40+
41+
<Heading
42+
id={"request"}
43+
as={"h2"}
44+
className={"openapi-tabs__heading"}
45+
children={"Request"}
46+
>
47+
</Heading>
48+
49+
<ParamsDetails
50+
parameters={[{"name":"hostId","in":"path","required":true,"schema":{"type":"integer"},"description":"Host ID"}]}
51+
>
52+
53+
</ParamsDetails>
54+
55+
<RequestSchema
56+
title={"Body"}
57+
body={undefined}
58+
>
59+
60+
</RequestSchema>
61+
62+
<StatusCodes
63+
id={undefined}
64+
label={undefined}
65+
responses={{"200":{"description":"Token deleted successfully"},"500":{"description":"Internal server error"}}}
66+
>
67+
68+
</StatusCodes>
69+
70+
71+

‎docs/api/get-opkssh-token-status-for-a-host.api.mdx‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
id: get-opkssh-token-status-for-a-host
3+
title: "Get OPKSSH token status for a host"
4+
description: "Get OPKSSH token status for a host"
5+
sidebar_label: "Get OPKSSH token status for a host"
6+
hide_title: true
7+
hide_table_of_contents: true
8+
api: eJyNVU2P20YM/SsDnlpgGjvJpgV022bbrFO0CWIHORg+0BJtTSzNKBzK2IWg/15wpLh2ZBT2RR9+fPyYx6cOBPcRsjUsl4+wsRApb9nJM2TrDraETHzfSgnZetNvLDTIWJMQxwTwWBNkUIYoiwIsOA8ZNCglWGD61jqmAjLhlizEvKQaIetAnhuNcl5oTwy9hYJizq4RF5TgMUQxiwfQhEyxCT5S1MBX87leLtGrcCBvoqC00TAJOzpSYWKb5xTjrq2qZ7CQBy/kRcOxaSqXo4bPvkbl6KbFhe1XygUsNBwaYnFDBfTkosQz3DaEitDDjz18KUlKYoPmiJUrjKQqx/DeAj01jineyxlXFHZ+DxZ2gWsUyKBAoV/E1TThX418jePUiVFUFKybxF6jq64xX5J8jsQmYc2OQ20+LB7eGleQF1VAn34W7uZ306n/Ey4a24XWF5r5zbUjWngh9liZSHzUlMyBoZ8c/DsS8+HjX8vl40g7nuou6CBVZWChJilDARnsKZ2Pqi2DWYzlLDQHvaTYWTeosgcVtaYdJNtypYoVabLZrAo5VorLXs/n85eTAf2NzpsCBbcYyaAvDLZS6nwG/YwNQW//l/j1hDi12HpPlanR455q8nIj291Vtp2raOTiG4neTImG89Gxuyguj6nnOngnQRV0I/GvE+IHjOU2IBc3Mvw2ZQj5gfjatM5ca6lrPGzquXed9kBzwWhFaXsTCOx48+f3vXv/ZZXk6fwupHAnleJXxLV7MvcfF2BBJTXUNn8xfzGfrugA/h3zA/lCg8wn2hGTz0lXpQlRakz2M/roTfq/SHLqTOhJZk2Fzit1mmw37sYaYlRDHrYDLCRusJCNvr2xycEV2XWq9M9c9b2+/tYS66dgY+GI7HCrU1h3ULio9wVkO6wiTYo6uS389Gn8DPxsvtu6vV7z+BK92vURq1afwMKBnv/7xPSb3kJJWBCnQoY/7/OcGjkLm1i8iuRkHO/+WIEFvJTGD1JI7FdL6roBkRy4708VDlPtN33f/wv1ToKi
9+
sidebar_class_name: "get api-method"
10+
info_path: api/termix-api
11+
custom_edit_url: null
12+
---
13+
14+
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
15+
import ParamsDetails from "@theme/ParamsDetails";
16+
import RequestSchema from "@theme/RequestSchema";
17+
import StatusCodes from "@theme/StatusCodes";
18+
import OperationTabs from "@theme/OperationTabs";
19+
import TabItem from "@theme/TabItem";
20+
import Heading from "@theme/Heading";
21+
22+
<Heading
23+
as={"h1"}
24+
className={"openapi__heading"}
25+
children={"Get OPKSSH token status for a host"}
26+
>
27+
</Heading>
28+
29+
<MethodEndpoint
30+
method={"get"}
31+
path={"/ssh/opkssh/token/{hostId}"}
32+
context={"endpoint"}
33+
>
34+
35+
</MethodEndpoint>
36+
37+
38+
39+
Get OPKSSH token status for a host
40+
41+
<Heading
42+
id={"request"}
43+
as={"h2"}
44+
className={"openapi-tabs__heading"}
45+
children={"Request"}
46+
>
47+
</Heading>
48+
49+
<ParamsDetails
50+
parameters={[{"name":"hostId","in":"path","required":true,"schema":{"type":"integer"},"description":"Host ID"}]}
51+
>
52+
53+
</ParamsDetails>
54+
55+
<RequestSchema
56+
title={"Body"}
57+
body={undefined}
58+
>
59+
60+
</RequestSchema>
61+
62+
<StatusCodes
63+
id={undefined}
64+
label={undefined}
65+
responses={{"200":{"description":"Token status retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"exists":{"type":"boolean","description":"Whether a valid token exists"},"expiresAt":{"type":"string","format":"date-time","description":"Token expiration timestamp"},"email":{"type":"string","description":"User email from OIDC identity"}}}}}},"404":{"description":"No valid token found"},"500":{"description":"Internal server error"}}}
66+
>
67+
68+
</StatusCodes>
69+
70+
71+

‎docs/api/o-auth-callback-from-oidc-provider-for-opkssh-authentication-handles-all-sub-paths.api.mdx‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
id: o-auth-callback-from-oidc-provider-for-opkssh-authentication-handles-all-sub-paths
3+
title: "OAuth callback from OIDC provider for OPKSSH authentication (handles all sub-paths)"
4+
description: "OAuth callback from OIDC provider for OPKSSH authentication (handles all sub-paths)"
5+
sidebar_label: "OAuth callback from OIDC provider for OPKSSH authentication (handles all sub-paths)"
6+
hide_title: true
7+
hide_table_of_contents: true
8+
api: eJy1VE1v2zAM/SsCTy2gNt7aboBvXbut2TC0aDrsEOTAyHQsRJZcSQ4aGP7vAx2na+JsyGUnSzT5+PH02EDERYB0CpPJHcwkVOixpEiejQ1YLAlS8PRcU4jjDCRoCylUGAuQnV17yiCNviYJQRVUIqQNxHXFgSF6bRfQSsgoKK+rqB3HX9exIBu1QjaIHl+Mb6GdMWyonA0UGOl9kvBnN/4GjZmjWorKO0UhUCZCrfiU18asOeFlcjmMG9sVGp0J3M0fKAR2aCVcHUq3V26O2lAG7aCte3YUaltc7l0p7se3N1zmSmfkRe68uH/4Ppnc7ddwUqDNDAWBxohQz894xuEUJJQUC5dBCguKIDezT2HkqmUIxdk226h5ZakFCYH8asti7Q2kUMRYpaORcQpN4UJML5IkeQf7PfxAbUWGEecYSKA9MCxGhlb+E/hiAMw9x9paMqJEiwsqycYj0S4PouXaUI/ljwS6GgJ1cSJEjDpErULXc+msjo4f75HAHwbAtxiKuUOfHYnwcYjg1JL8oWnNmGBVex3XHcNzQk+eXx+k09nb3xOW5EZJb51eFcqlQK9cvm+cQPaHL86XGCGFb7+eugevbe66cB0N+z+RL/WLuH4YgwR+cZvSk/PkPBk01Dt/QrUkm3GQeKScPFlFLL7KhViiZfx+8/wfRe1U9TqKSC9xVBnU3SLomGp6tU1hT20gIf2zFWcSmEb2axrWzU9v2pbNzzV5pmgmYYVe45yHNm0g04HPGaQ5mkCDkpSzkSwP/uSxX7Kn4u9bUx7uoTeiXTM5aGq+gYQlrXe2ejtr36yZr5+Z6t/vIxp6
9+
sidebar_class_name: "get api-method"
10+
info_path: api/termix-api
11+
custom_edit_url: null
12+
---
13+
14+
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
15+
import ParamsDetails from "@theme/ParamsDetails";
16+
import RequestSchema from "@theme/RequestSchema";
17+
import StatusCodes from "@theme/StatusCodes";
18+
import OperationTabs from "@theme/OperationTabs";
19+
import TabItem from "@theme/TabItem";
20+
import Heading from "@theme/Heading";
21+
22+
<Heading
23+
as={"h1"}
24+
className={"openapi__heading"}
25+
children={"OAuth callback from OIDC provider for OPKSSH authentication (handles all sub-paths)"}
26+
>
27+
</Heading>
28+
29+
<MethodEndpoint
30+
method={"get"}
31+
path={"/opkssh-callback/{requestId}"}
32+
context={"endpoint"}
33+
>
34+
35+
</MethodEndpoint>
36+
37+
38+
39+
OAuth callback from OIDC provider for OPKSSH authentication (handles all sub-paths)
40+
41+
<Heading
42+
id={"request"}
43+
as={"h2"}
44+
className={"openapi-tabs__heading"}
45+
children={"Request"}
46+
>
47+
</Heading>
48+
49+
<ParamsDetails
50+
parameters={[{"name":"requestId","in":"path","required":true,"schema":{"type":"string"},"description":"Authentication request ID"}]}
51+
>
52+
53+
</ParamsDetails>
54+
55+
<RequestSchema
56+
title={"Body"}
57+
body={undefined}
58+
>
59+
60+
</RequestSchema>
61+
62+
<StatusCodes
63+
id={undefined}
64+
label={undefined}
65+
responses={{"200":{"description":"Callback processed successfully"},"404":{"description":"Invalid authentication session"},"500":{"description":"Authentication failed"}}}
66+
>
67+
68+
</StatusCodes>
69+
70+
71+

‎docs/api/proxy-opkssh-provider-chooser-page-and-all-related-resources.api.mdx‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
id: proxy-opkssh-provider-chooser-page-and-all-related-resources
3+
title: "Proxy OPKSSH provider chooser page and all related resources"
4+
description: "Proxy OPKSSH provider chooser page and all related resources"
5+
sidebar_label: "Proxy OPKSSH provider chooser page and all related resources"
6+
hide_title: true
7+
hide_table_of_contents: true
8+
api: eJyllN9v00AMx/+Vk59AOtbANpDyNhiwgRDTOsRD1Qc3cZtTk7vM50yrovzvyGk2WlJQJZ6SOPbn/OO+bkFwFSGdwXR6BXMLNTJWJMRqbMFjRZAC031DUa5zsOA8pFCjFGB7u2PKIRVuyELMCqoQ0hZkU2tgFHZ+BZ2FnGLGrhYXNP6ikYK8uAzVYAa+ub6Ebq7YWAcfKSrpTZLoYz/+QxFCJDY1rshkwQt50VPOkrOx85Ri1FN8ELMMjc/V8/wQ9obD48YQc2DoRklv/36/+TqdXpmaw4PLiU22mwr63GBZGqYShXLDFEPDGUWwUJEUIYcUViRgty1MYRLqdYzFqwEzaZ973YGFSPzwNIuGS0ihEKnTyaQMGZZFiJKeJknyGv7M9Rs6b3IUXGAc0tpv+ZYMnf0n+HQE1tql8Z5KU6HHFVXk5Uja2UHa0pU0sPhI0PkY1MeZKCguistiX3MVvJOgV/BI8NsR+BJjsQjI+ZGEd2NCyNbEh7o11wFnDTvZ9BNeEDKxagPS2Xz391SFtdXDrtOzzjQVGPSn31snsMPLp8AVCqTw5eddf7GdX4Y+3Emp/nfElXs0FzfXYEFv3Db15CQ5SUYFDc7vMVuTzzXI3NKSmHxGKq06RKnQK3/YH/+pnL3jn2sWepRJXaLzemg/knZQ1Qz2VQUW0t87bG5Bx6Vubav6+MFl16n5viHWUcwtPCA7XGhzZi3kLup7DukSy0ijjJ42UAovboeV+NL8fcfZwyUMRvQbHQKWjX6BhTVt9nZwN+92tsnnjzrSXwyS/Vk=
9+
sidebar_class_name: "get api-method"
10+
info_path: api/termix-api
11+
custom_edit_url: null
12+
---
13+
14+
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
15+
import ParamsDetails from "@theme/ParamsDetails";
16+
import RequestSchema from "@theme/RequestSchema";
17+
import StatusCodes from "@theme/StatusCodes";
18+
import OperationTabs from "@theme/OperationTabs";
19+
import TabItem from "@theme/TabItem";
20+
import Heading from "@theme/Heading";
21+
22+
<Heading
23+
as={"h1"}
24+
className={"openapi__heading"}
25+
children={"Proxy OPKSSH provider chooser page and all related resources"}
26+
>
27+
</Heading>
28+
29+
<MethodEndpoint
30+
method={"get"}
31+
path={"/opkssh-chooser/{requestId}"}
32+
context={"endpoint"}
33+
>
34+
35+
</MethodEndpoint>
36+
37+
38+
39+
Proxy OPKSSH provider chooser page and all related resources
40+
41+
<Heading
42+
id={"request"}
43+
as={"h2"}
44+
className={"openapi-tabs__heading"}
45+
children={"Request"}
46+
>
47+
</Heading>
48+
49+
<ParamsDetails
50+
parameters={[{"name":"requestId","in":"path","required":true,"schema":{"type":"string"},"description":"Authentication request ID"}]}
51+
>
52+
53+
</ParamsDetails>
54+
55+
<RequestSchema
56+
title={"Body"}
57+
body={undefined}
58+
>
59+
60+
</RequestSchema>
61+
62+
<StatusCodes
63+
id={undefined}
64+
label={undefined}
65+
responses={{"200":{"description":"Chooser page content"},"404":{"description":"Session not found"},"500":{"description":"Proxy error"}}}
66+
>
67+
68+
</StatusCodes>
69+
70+
71+

‎docs/api/static-o-auth-callback-from-oidc-provider-for-opkssh-authentication.api.mdx‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
id: static-o-auth-callback-from-oidc-provider-for-opkssh-authentication
3+
title: "Static OAuth callback from OIDC provider for OPKSSH authentication"
4+
description: "Static OAuth callback from OIDC provider for OPKSSH authentication"
5+
sidebar_label: "Static OAuth callback from OIDC provider for OPKSSH authentication"
6+
hide_title: true
7+
hide_table_of_contents: true
8+
api: eJytk01v00AQhv/Kas6mMTQFybfSAi0IUuEiDpEPk/U4XmW9a3bHUSvL/x2Nm1ZpHKEcOHnlfefZd756YFxHyJaQ5zdQJBAott5FipD18C5N5VNS1MG0bLyDDK7Q2hXqjWqD1xQjlSp2Wk5VZ+0jDAnM0/k07odXqNlsSWHHNTk2GuVKRYpRvpXvXCnhF8eevXwdVKGxVMIwJAe6nJGNVgvRK/3stQq+UYvb6ytxvTUlBVX5oBZ33/L85sAQJNAQ176EDNbEkECLXEMGM99uYqzfPFMhgUhhS0EK2EMXLGRQM7fZbGa9Rlv7yNl5mqZv4dDmdzROlci4wkgKXTmtipBhSP4JPp+AJR/unCOrGnS4poYcn0ibH6VVxtKOFU4EXUxBY5yK0p3IRscx58Y7wz4Ytz4R/H4CvsZYrzyG8kTChynB6w2FY9UqpMG6C4Yfxw6vCAMFmSzIlsX+da5rap6WZl/UAz+2tLMi4zLKINuJINkdPvvQIEMGX3/fjzNtXOXHcMNW9PcUGvOgLu9uIQGZuCfr6Vl6lk4S2ok/ot6QKyVI/aSKAjlNsl+tj9ygE77D0c5/WZpXJl4yZ3rgWWvROHl6bEy/W6glHC5UkYA0Sq76XjbjV7DDIL//dBSkCUUCWwwGV1KWZTHs7eqXT1K7v6sZqGY=
9+
sidebar_class_name: "get api-method"
10+
info_path: api/termix-api
11+
custom_edit_url: null
12+
---
13+
14+
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
15+
import ParamsDetails from "@theme/ParamsDetails";
16+
import RequestSchema from "@theme/RequestSchema";
17+
import StatusCodes from "@theme/StatusCodes";
18+
import OperationTabs from "@theme/OperationTabs";
19+
import TabItem from "@theme/TabItem";
20+
import Heading from "@theme/Heading";
21+
22+
<Heading
23+
as={"h1"}
24+
className={"openapi__heading"}
25+
children={"Static OAuth callback from OIDC provider for OPKSSH authentication"}
26+
>
27+
</Heading>
28+
29+
<MethodEndpoint
30+
method={"get"}
31+
path={"/opkssh-callback"}
32+
context={"endpoint"}
33+
>
34+
35+
</MethodEndpoint>
36+
37+
38+
39+
Static OAuth callback from OIDC provider for OPKSSH authentication
40+
41+
<ParamsDetails
42+
parameters={undefined}
43+
>
44+
45+
</ParamsDetails>
46+
47+
<RequestSchema
48+
title={"Body"}
49+
body={undefined}
50+
>
51+
52+
</RequestSchema>
53+
54+
<StatusCodes
55+
id={undefined}
56+
label={undefined}
57+
responses={{"200":{"description":"Callback processed successfully"},"404":{"description":"No active authentication session found"},"500":{"description":"Authentication failed"}}}
58+
>
59+
60+
</StatusCodes>
61+
62+
63+

‎docs/environment-variables.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Environment Variables
2+
3+
| Config Name | Variable | Default | Note |
4+
|---------------|------------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------|
5+
| Port | `PORT` | `8080` | Port for the frontend web application. No additional ports should be exposed. Port must not fall within the restricted range `30001–30005`. |
6+
| Enable SSL | `Enable_SSL` | `false` | See [SSL](/ssl) for more information on how to enable SSL encryption. |
7+
| OIDC Client ID | `OIDC_CLIENT_ID` | `none` | See [OIDC](/oidc#environment-variables) for more information on how to override OIDC config with env variables. |
8+
| Vite Base Path | `VITE_BASE_PATH` | `/` | See [Reverse Proxy](/reverse-proxy#changing-base-path) for more information on how to change the base path of Termix. |
9+
| PUID/PGID | `PUID` / `PGID` | `1000` | Map the containers internal user to a user on the host machine |

‎docs/install/server/docker.md‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,7 @@ You can also replace `:latest` in your docker run/compose with `:version.x.x.x`
8888

8989
## Environment Variables
9090

91-
| Config Name | Variable | Default | Note |
92-
| ----------- | ------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
93-
| Port | `PORT` | 8080 | Port for the frontend web application. No additional ports should be exposed. Port must not fall within the restricted range `30001–30005`. |
94-
| Enable SSL | `Enable_SSL` | false | See [SSL](/ssl) for more information on how to enable SSL encryption. |
91+
See [docs](/environment-variables).
9592

9693
## Usage
9794

‎docs/install/server/manual.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,10 @@ volumes:
100100
docker-compose up -d
101101
```
102102

103+
## Environment Variables
104+
105+
See [docs](/environment-variables).
106+
103107
## Usage
104108

105109
Once compiled and running, Termix will be available at `http://localhost:8080` (or whichever port you configured).

0 commit comments

Comments
 (0)