Prerequisites
- An invitation to an Orchard organization (Orchard is currently in closed beta)
- A Docker image to deploy, or a GitHub repository with a Dockerfile
Step 1: Accept Your Organization Invitation
Orchard is currently in closed beta. To get started, you need to be invited to an organization.1
Check your email
Look for an invitation email from Orchard with a link to join an organization.
2
Click the invitation link
Click Accept Invitation in the email to join the organization.
3
Sign in or create account
If you don’t have an Orchard account yet, you’ll be prompted to create one using email OTP, passkey, or Hack Club OAuth.
Don’t have an invitation? Contact the @lfd if you want to try it.
Step 2: Create a Workspace
Workspaces help you organize projects. You might create separate workspaces for personal stuff and a team project.1
Open your organization
Click on your newly created organization from the dashboard.
2
Create a workspace
Click New Workspace and enter a name (e.g., “Daniel’s Deployments” or “Charles’ Cointainers”).
Step 3: Create a Project
Projects are where your deployments live. Each project gets its own Kubernetes namespace for isolation.1
Open your workspace
Click on the workspace you just created.
2
Create a project
Click New Project and provide a name for your project.
Step 4: Deploy Your Application
You can deploy from a Docker image or directly from a GitHub repository.- From Docker Image
- From GitHub
1
Create a new deployment
In your project, click New Deployment.
2
Select 'From Image'
Choose the Docker Image option.
3
Configure your deployment
- Name: A unique name for this deployment
- Image: The Docker image to deploy (e.g.,
ghcr.io/hackclub/midnight/lark-ui:1.19.0) - Port: The port your application listens on (e.g.,
3000) - Replicas: Number of instances to run (default: 1)
4
Deploy
Click Create Deployment to start your application.
Step 5: Expose Your Application
To make your application accessible from the internet, you need to create a service and optionally an ingress.1
Create a service
In your deployment’s Network tab, click Add Ingress
2
Configure Ingress
Select your deployment from the dropdown, click **Auto-Generate. **Finally click on Create Ingresses