Enhance API with OIDC support, including login and callback endpoints. Update environment variables for OIDC configuration in .env.example. Add new features to the catalog service for listing software families, Minecraft versions, and deployment regions. Implement server management actions such as kill, delete, and update in the servers module. Integrate feature flags for maintenance mode in server operations. Update pnpm-lock.yaml with new dependencies and versions.
This commit is contained in:
TheOnlyMace
28
apps/docs/README.md
Normal file
28
apps/docs/README.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# HexaHost GameCloud — static docs site
|
||||
|
||||
Minimal static documentation hub with links to the live API docs and key product pages.
|
||||
|
||||
## Serve locally
|
||||
|
||||
From the repository root:
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
pnpm --filter @hexahost/docs dev
|
||||
```
|
||||
|
||||
Or from this directory:
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
The site is served at http://localhost:4000.
|
||||
|
||||
## Prerequisites for linked resources
|
||||
|
||||
- **Web app** (`http://localhost:3000`) — run `pnpm --filter @hexahost/web dev`
|
||||
- **API Swagger** (`http://localhost:3001/api/v1/docs`) — run `pnpm --filter @hexahost/api dev`
|
||||
|
||||
Repository markdown under `docs/` is referenced by path; open those files in your editor or on GitHub.
|
||||
130
apps/docs/index.html
Normal file
130
apps/docs/index.html
Normal file
@@ -0,0 +1,130 @@
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>HexaHost GameCloud Documentation</title>
|
||||
<style>
|
||||
:root {
|
||||
color-scheme: light dark;
|
||||
font-family: system-ui, -apple-system, sans-serif;
|
||||
line-height: 1.5;
|
||||
}
|
||||
|
||||
body {
|
||||
margin: 0;
|
||||
background: #fafafa;
|
||||
color: #18181b;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body {
|
||||
background: #09090b;
|
||||
color: #fafafa;
|
||||
}
|
||||
}
|
||||
|
||||
main {
|
||||
max-width: 48rem;
|
||||
margin: 0 auto;
|
||||
padding: 3rem 1.5rem;
|
||||
}
|
||||
|
||||
h1 {
|
||||
margin: 0 0 0.5rem;
|
||||
font-size: 2rem;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
p.lead {
|
||||
margin: 0 0 2rem;
|
||||
color: #52525b;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: dark) {
|
||||
p.lead {
|
||||
color: #a1a1aa;
|
||||
}
|
||||
}
|
||||
|
||||
section {
|
||||
margin-bottom: 2rem;
|
||||
}
|
||||
|
||||
h2 {
|
||||
margin: 0 0 0.75rem;
|
||||
font-size: 1.125rem;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
ul {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
li + li {
|
||||
margin-top: 0.5rem;
|
||||
}
|
||||
|
||||
a {
|
||||
color: #0284c7;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
code {
|
||||
font-family: ui-monospace, monospace;
|
||||
font-size: 0.875em;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<main>
|
||||
<h1>HexaHost GameCloud</h1>
|
||||
<p class="lead">Developer documentation hub for the GameCloud control plane.</p>
|
||||
|
||||
<section>
|
||||
<h2>API</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="http://localhost:3001/api/v1/docs">Interactive API docs (Swagger)</a>
|
||||
— OpenAPI UI when the API is running locally
|
||||
</li>
|
||||
<li>
|
||||
<a href="http://localhost:3001/api/v1/docs-json">OpenAPI JSON spec</a>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<h2>Key features</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="http://localhost:3000/features">Product features overview</a>
|
||||
— server control, nodes, security, billing, backups, WHMCS
|
||||
</li>
|
||||
<li>
|
||||
<a href="http://localhost:3000/pricing">Pricing</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="http://localhost:3000/status">Platform status</a>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<h2>Repository docs</h2>
|
||||
<ul>
|
||||
<li><code>docs/api/README.md</code> — API authentication and versioning</li>
|
||||
<li><code>docs/operations/</code> — backups, upgrades, node drain, disaster recovery</li>
|
||||
<li><code>docs/integrations/whmcs/</code> — WHMCS module installation and security</li>
|
||||
<li><code>docs/security/</code> — container isolation, secrets, data retention</li>
|
||||
</ul>
|
||||
</section>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
14
apps/docs/package.json
Normal file
14
apps/docs/package.json
Normal file
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"name": "@hexahost/docs",
|
||||
"version": "0.0.1",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"dev": "serve . -p 4000",
|
||||
"start": "serve . -p 4000",
|
||||
"lint": "node -e \"process.exit(0)\"",
|
||||
"typecheck": "node -e \"process.exit(0)\""
|
||||
},
|
||||
"devDependencies": {
|
||||
"serve": "^14.2.4"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user