Skip to content

Commit c044074

Browse files
committed
Update README and enable GHA workflow
1 parent caaa4b1 commit c044074

File tree

2 files changed

+15
-38
lines changed

2 files changed

+15
-38
lines changed

.github/workflows/publish-labspace.yaml.temp renamed to .github/workflows/publish-labspace.yaml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Package and deploy Labspace
22

33
env:
4-
DOCKERHUB_REPO: your-dockerhub-username/labspace-name
4+
DOCKERHUB_REPO: dockersamples/labspace-scout-overview
55

66
on:
77
push:
@@ -31,5 +31,3 @@ jobs:
3131
- name: Publish Compose file
3232
run: |
3333
docker compose -f oci://dockersamples/labspace -f .labspace/compose.override.yaml publish ${DOCKERHUB_REPO} --with-env -y
34-
env:
35-
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}

README.md

Lines changed: 14 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,27 @@
1-
# Labspace starter
1+
# Labspace - Scout Overview
22

3-
This repository is intended to server as a template to help bootstrap a new Labspace.
3+
Once you've learned to build images, the next question is "Did you build a good image?" Is it secure? Is it following best practices?
44

5-
## Instructions
5+
In this Labspace, you'll learn how to use Docker Scout to build more secure images.
66

7-
1. Create a new repository using this repo as the template ([docs here](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)).
87

9-
**NOTE:** After creating the repo, a GHA workflow will run to do some additional bootstrapping. The bootstrapping workflow file will be removed during bootstrapping.
108

11-
2. Clone your newly created repo to your local machine
9+
## Learning objectives
1210

13-
3. Start the local development mode:
11+
By the end of this Labspace, you will have learned the following:
1412

15-
```bash
16-
# On Mac/Linux
17-
CONTENT_PATH=$PWD docker compose -f oci://dockersamples/labspace-content-dev -f .labspace/compose.override.yaml up
13+
TBD
1814

19-
# On Windows with PowerShell
20-
$Env:CONTENT_PATH = (Get-Location).Path; docker compose -f oci://dockersamples/labspace-content-dev -f .labspace/compose.override.yaml up
21-
```
15+
## Launch the Labspace
2216

23-
4. Update the `labspace.yaml` with your Labspace's title and description
17+
To launch the Labspace, run the following command:
2418

25-
5. Write your Labspace! Being in dev mode, your changes should be visible in the interface without a restart. Feel free to edit either on your host machine or in the Labspace itself!
19+
```bash
20+
docker compose -f oci://dockersamples/labspace-scout-overview up -d
21+
```
2622

27-
Add any supporting application files or resources directly into the Labspace. This repo will be cloned into the Labspace at startup.
23+
And then open your browser to http://localhost:3030.
2824

29-
Be sure to check out the [docs](https://github.com/dockersamples/labspace-infra/tree/main/docs) for additional information and guidelines.
25+
### Using the Docker Desktop extension
3026

31-
32-
33-
### Setting up the deployment pipeline
34-
35-
The template repo contains a workflow file to make it easy to publish your Labspace.
36-
37-
1. Add GitHub Action Secrets in your new repo for the following:
38-
39-
- `DOCKERHUB_USERNAME` - the username to authenticate to Docker Hub with
40-
- `DOCKERHUB_TOKEN` - a personal or organization access token to use for authentication
41-
42-
2. In the `.github/workflows/publish-labspace.yaml.temp` file, update the `DOCKERHUB_REPO` with the name of the Docker Hub repo you want to publish to.
43-
44-
3. Rename the workflow file to remove the `.temp` extension.
45-
46-
```bash
47-
mv .github/workflows/publish-labspace.yaml.temp .github/workflows/publish-labspace.yaml
48-
```
27+
If you have the Labspace extension installed (`docker extension install dockersamples/labspace-extension` if not), you can also [click this link](https://open.docker.com/dashboard/extension-tab?extensionId=dockersamples/labspace-extension&location=dockersamples/labspace-scout-overview&title=Scout%20overview) to launch the Labspace.

0 commit comments

Comments
 (0)