Skip to content

Commit 2a96564

Browse files
committed
Add new deployment troubleshooting steps
1 parent 33f02f6 commit 2a96564

File tree

1 file changed

+31
-8
lines changed

1 file changed

+31
-8
lines changed

mie-opensource-landing/docs/users/proxmox-launchpad/getting-started.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,24 @@ Add these secrets in your repository's **Settings > Secrets and variables > Acti
2222

2323
## Action Inputs
2424

25-
| Input | Required | Description |
26-
|-------|----------|-------------|
27-
| `api_key` | Yes | Bearer token for authenticating with the create-a-container API |
28-
| `api_url` | Yes | Base URL of the create-a-container server |
29-
| `template_name` | No | Docker/OCI image reference to deploy (e.g., `ghcr.io/org/app:tag`) |
25+
| Input | Required | Default | Description |
26+
|-------|----------|---------|-------------|
27+
| `api_key` | Yes || Bearer token for authenticating with the create-a-container API |
28+
| `api_url` | Yes || Base URL of the create-a-container server |
29+
| `template_name` | No || Docker/OCI image reference to deploy (e.g., `ghcr.io/org/app:tag`). Omit to delete the container. |
30+
| `container_env_vars` | No || Environment variables to set inside the container (JSON string, e.g., `'{"NODE_ENV": "production"}'`) |
31+
| `services` | No || Services configuration (JSON array) |
32+
| `site_id` | No | `1` | Site ID for the container management system |
33+
34+
## Supported Workflow Events
35+
36+
| Event | Action |
37+
|-------|--------|
38+
| `push` | Creates or locates the container for the branch |
39+
| `create` | Creates a container for the new branch |
40+
| `pull_request` (opened/synchronize/reopened) | Creates or locates the container for the PR head branch |
41+
| `pull_request` (closed) | Deletes the container |
42+
| `delete` | Deletes the container for the deleted branch |
3043

3144
## Basic Usage
3245

@@ -166,10 +179,11 @@ ssh -p <port> <username>@<hostname>.os.mieweb.org
166179

167180
## Docker Image Requirements
168181

169-
Your Docker image should:
182+
Your Docker image must:
170183

171-
1. **EXPOSE ports** — Declare which ports your application listens on
172-
2. **Use the `org.mieweb.opensource-server.services.http.default-port` label** — Specify the primary HTTP port for reverse proxy configuration
184+
1. **Be publicly accessible** — The create-a-container server pulls images anonymously. If your image is on GHCR, go to **Package settings > Danger Zone > Change visibility > Public**.
185+
2. **EXPOSE ports** — Declare which ports your application listens on
186+
3. **Use the `org.mieweb.opensource-server.services.http.default-port` label** — Specify the primary HTTP port for reverse proxy configuration
173187

174188
```dockerfile
175189
EXPOSE 3000
@@ -184,11 +198,20 @@ The create-a-container server reads these from the image metadata to configure n
184198
- Verify `LAUNCHPAD_API_KEY` secret is set correctly
185199
- Confirm the API key hasn't been revoked
186200

201+
**Deploy step runs but skips container creation:**
202+
- Check the workflow output for the "Create or Locate Container" step — if it's missing, the action version may not support your event type
203+
- Ensure you're using the latest version of `mieweb/launchpad@main`
204+
- Verify the workflow includes the correct `on:` triggers for your use case
205+
187206
**Container not accessible after deploy:**
188207
- Wait 1-2 minutes for background provisioning to complete
189208
- Verify your Docker image exposes the correct port
190209
- Check that the `default-port` label matches your application's listen port
191210

211+
**Container creation fails with `HTTP 401: authentication required`:**
212+
- The Docker image is private. The server pulls images without credentials, so the package must be public.
213+
- On GHCR: go to `https://github.com/users/<owner>/packages/container/<image>/settings` → **Danger Zone** → **Change visibility** → **Public**
214+
192215
**Image not found:**
193216
- Ensure the Docker image was pushed successfully before the deploy step
194217
- Verify the image tag matches between the build and deploy jobs

0 commit comments

Comments
 (0)