Skip to content

Commit 2563890

Browse files
dmvtclaude
andcommitted
docs: add tutorial README with ordered table of contents
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 7c81f0e commit 2563890

1 file changed

Lines changed: 79 additions & 0 deletions

File tree

docs/tutorials/README.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Self-Host Tutorials
2+
3+
Step-by-step guides for deploying dstack on your own TDX hardware. These
4+
tutorials walk through the entire process from bare-metal host setup to
5+
running your first confidential application.
6+
7+
## Tutorial Order
8+
9+
### 1. Host Setup
10+
11+
| Step | Tutorial | File |
12+
|------|----------|------|
13+
| 1 | TDX Hardware Verification | [tdx-hardware-verification.md](tdx-hardware-verification.md) |
14+
| 2 | TDX & SGX BIOS Configuration | [tdx-bios-configuration.md](tdx-bios-configuration.md) |
15+
| 3 | TDX Software Installation | [tdx-software-installation.md](tdx-software-installation.md) |
16+
| 4 | TDX & SGX Verification | [tdx-sgx-verification.md](tdx-sgx-verification.md) |
17+
18+
### 2. Prerequisites
19+
20+
| Step | Tutorial | File |
21+
|------|----------|------|
22+
| 1 | DNS Configuration | [dns-configuration.md](dns-configuration.md) |
23+
| 2 | SSL Certificate Setup | [ssl-certificate-setup.md](ssl-certificate-setup.md) |
24+
| 3 | Docker Setup | [docker-setup.md](docker-setup.md) |
25+
| 3 | HAProxy Setup | [haproxy-setup.md](haproxy-setup.md) |
26+
| 4 | Gramine Key Provider | [gramine-key-provider.md](gramine-key-provider.md) |
27+
| 4 | Local Docker Registry | [local-docker-registry.md](local-docker-registry.md) |
28+
| 5 | Blockchain Wallet Setup | [blockchain-setup.md](blockchain-setup.md) |
29+
30+
> Steps 3–4 contain parallel tracks. Docker Setup and HAProxy Setup are
31+
> both step 3; Gramine Key Provider and Local Docker Registry are both
32+
> step 4. Complete both within each step number.
33+
34+
### 3. dstack Installation
35+
36+
| Step | Tutorial | File |
37+
|------|----------|------|
38+
| 1 | System Baseline & Dependencies | [system-baseline-dependencies.md](system-baseline-dependencies.md) |
39+
| 2 | Rust Toolchain Installation | [rust-toolchain-installation.md](rust-toolchain-installation.md) |
40+
| 3 | Clone & Build dstack-vmm | [clone-build-dstack-vmm.md](clone-build-dstack-vmm.md) |
41+
| 4 | VMM Configuration | [vmm-configuration.md](vmm-configuration.md) |
42+
| 5 | VMM Service Setup | [vmm-service-setup.md](vmm-service-setup.md) |
43+
| 6 | Management Interface Setup | [management-interface-setup.md](management-interface-setup.md) |
44+
| 7 | Guest OS Image Setup | [guest-image-setup.md](guest-image-setup.md) |
45+
46+
### 4. KMS Deployment
47+
48+
| Step | Tutorial | File |
49+
|------|----------|------|
50+
| 1 | Contract Deployment | [contract-deployment.md](contract-deployment.md) |
51+
| 2 | KMS Build & Configuration | [kms-build-configuration.md](kms-build-configuration.md) |
52+
| 3 | KMS CVM Deployment | [kms-cvm-deployment.md](kms-cvm-deployment.md) |
53+
54+
### 5. Gateway Deployment
55+
56+
| Step | Tutorial | File |
57+
|------|----------|------|
58+
| 1 | Gateway CVM Preparation | [gateway-build-configuration.md](gateway-build-configuration.md) |
59+
| 2 | Gateway CVM Deployment | [gateway-service-setup.md](gateway-service-setup.md) |
60+
61+
### 6. First Application
62+
63+
| Step | Tutorial | File |
64+
|------|----------|------|
65+
| 1 | Hello World Application | [hello-world-app.md](hello-world-app.md) |
66+
| 2 | Attestation Verification | [attestation-verification.md](attestation-verification.md) |
67+
68+
### Troubleshooting
69+
70+
These guides are not part of the main flow. Refer to them as needed.
71+
72+
| Tutorial | File |
73+
|----------|------|
74+
| Troubleshooting: Prerequisites | [troubleshooting-prerequisites.md](troubleshooting-prerequisites.md) |
75+
| Troubleshooting: Host Setup | [troubleshooting-host-setup.md](troubleshooting-host-setup.md) |
76+
| Troubleshooting: dstack Installation | [troubleshooting-dstack-installation.md](troubleshooting-dstack-installation.md) |
77+
| Troubleshooting: KMS Deployment | [troubleshooting-kms-deployment.md](troubleshooting-kms-deployment.md) |
78+
| Troubleshooting: Gateway Deployment | [troubleshooting-gateway-deployment.md](troubleshooting-gateway-deployment.md) |
79+
| Troubleshooting: First Application | [troubleshooting-first-application.md](troubleshooting-first-application.md) |

0 commit comments

Comments
 (0)