Skip to content

Commit fec8e56

Browse files
committed
Update README
1 parent 9932b8e commit fec8e56

File tree

1 file changed

+54
-11
lines changed

1 file changed

+54
-11
lines changed

README.md

Lines changed: 54 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,21 +37,64 @@ go run cmd/hypeman/main.go
3737
# Pull an image
3838
hypeman pull nginx:alpine
3939

40-
# Run an instance (auto-pulls image if needed)
41-
hypeman run nginx:alpine
42-
hypeman run --name my-app -e PORT=3000 nginx:alpine
40+
# Boot a VM (auto-pulls image if needed)
41+
hypeman run --name my-app nginx:alpine
4342

44-
# List running instances
43+
# List running VMs
4544
hypeman ps
46-
hypeman ps -a # show all instances
45+
# show all VMs
46+
hypeman ps -a
4747

48-
# View logs
49-
hypeman logs <instance-id>
50-
hypeman logs -f <instance-id> # follow logs
48+
# View logs of your app
49+
# All commands support using VM name, ID, or partial ID
50+
hypeman logs my-app
51+
hypeman logs -f my-app
5152

52-
# Execute a command in a running instance
53-
hypeman exec <instance-id> -- /bin/sh
54-
hypeman exec -it <instance-id> # interactive shell
53+
# Execute a command in a running VM
54+
hypeman exec my-app whoami
55+
# Shell into the VM
56+
hypeman exec -it my-app /bin/sh
57+
58+
# Create a reverse proxy ("ingress") from the host to your VM
59+
hypeman ingress create --name my-ingress my-app --hostname my-nginx-app --port 80 --host-port 8081
60+
61+
# List ingresses
62+
hypeman ingress list
63+
64+
# Curl nginx through your ingress
65+
curl --header "Host: my-nginx-app" http://127.0.0.1:8081
66+
67+
# Delete an ingress
68+
hypeman ingress delete my-ingress
69+
70+
# Delete all VMs
71+
hypeman rm --force --all
72+
```
73+
74+
More ingress features:
75+
- Automatic certs
76+
- Subdomain-based routing
77+
78+
```bash
79+
# This requires configuring the Hypeman server with DNS credentials
80+
hypeman ingress create --name my-tls-ingress my-app --hostname example.com -p 80 --host-port 7443 --tls
81+
82+
# OR... Ingress also supports subdomain-based routing
83+
hypeman ingress create --name my-tls-subdomain-ingress '{instance}' --hostname '{instance}.example.com' -p 80 --host-port 8443 --tls
84+
85+
# Curling through the subdomain-based routing
86+
curl --header "Host: my-app.example.com" https://127.0.0.1:8443
87+
```
88+
89+
More logging features:
90+
- Cloud Hypervisor logs
91+
- Hypeman operational logs
92+
93+
```bash
94+
# View Cloud Hypervisor logs for your VM
95+
hypeman logs --source vmm my-app
96+
# View Hypeman logs for your VM
97+
hypeman logs --source hypeman my-app
5598
```
5699

57100
For details about specific commands, use the `--help` flag.

0 commit comments

Comments
 (0)