Skip to content
This repository was archived by the owner on Dec 3, 2024. It is now read-only.

Commit 047b563

Browse files
committed
Update README with GH Packages instructions
1 parent 42ff24a commit 047b563

File tree

1 file changed

+8
-25
lines changed

1 file changed

+8
-25
lines changed

README.md

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Dockerized Epsilon Playground
22

3-
This is a dockerized version of the [Epsilon Playground](https://eclipse.org/epsilon/playground).
3+
This is a Dockerized version of the [Epsilon Playground](https://eclipse.org/epsilon/playground).
44

5-
## Fetch and Run the Docker Hub Image
5+
## Fetch and Run the Image
66

7-
Use this command to fetch the latest version of the Epsilon Playground image from Docker Hub and run it in a container:
7+
Use this command to fetch the latest version of the Epsilon Playground image from Github Packages and run it in a container:
88

99
```shell
10-
docker run -p 8000:80 eclipseepsilon/playground:latest
10+
docker run --rm -p 8000:80 ghcr.io/epsilonlabs/playground-docker:micronaut
1111
```
1212

1313
## Build and Run the Docker Image
@@ -46,13 +46,13 @@ You can now clone the repository and use this command to build the image:
4646
Use this command to run the image in a container:
4747

4848
```shell
49-
docker run -p 8000:80 playground:micronaut
49+
docker run -p 8000:80 playground-docker:micronaut
5050
```
5151

5252
Should you need to customise the port that `nginx` runs on, you can do so through the `PORT` environment variable (as required by Google Cloud Build):
5353

5454
```shell
55-
docker run --env PORT=8020 -p 8000:8020 playground:micronaut
55+
docker run --env PORT=8020 -p 8000:8020 playground-docker:micronaut
5656
```
5757

5858
## Access the Epsilon Playground
@@ -64,7 +64,7 @@ Once the container is up, go to http://localhost:8000 in your browser to access
6464
The dockerized version of the playground comes with the same set of examples as the [online version](https://eclipse.org/epsilon/playground). To start an instance with your own examples on the left hand side, use the following command, replacing `<examples-folder-absolute-path>` with the **absolute** path of your `examples` folder.
6565

6666
```shell
67-
docker run -p 8000:80 -v <examples-folder-absolute-path>:/etc/nginx/html/examples playground:latest
67+
docker run -p 8000:80 -v <examples-folder-absolute-path>:/etc/nginx/html/examples playground-docker:micronaut
6868
```
6969

7070
Your `examples` folder should contain an `examples.json` file with at least one example. A sample `examples` folder with a single example is provided [in this repository](examples) and more examples are available in the `examples` folder of [Epsilon's website repository](https://github.com/eclipse-epsilon/epsilon-website/tree/main/mkdocs/docs/playground/examples).
@@ -74,25 +74,8 @@ Your `examples` folder should contain an `examples.json` file with at least one
7474
If you would like to use only the backend services and replace the front-end altogether, you can start an instance using the following command, replacing `<front-end-folder-absolute-path>` with the **absolute** path of your custom front-end folder.
7575

7676
```shell
77-
docker run -p 8000:80 -v <front-end-folder-absolute-path>:/etc/nginx/html playground:latest
77+
docker run -p 8000:80 -v <front-end-folder-absolute-path>:/etc/nginx/html playground-docker:micronaut
7878
```
7979
Your front-end folder should contain an `index.html` file. A minimal alternative front-end that you can use as a starting point for developing your custom front-end is available in the `miniground` folder of [this repository](miniground).
8080

8181
Alternatively, you may want to use the [Docker image for the Micronaut-based backend](https://github.com/epsilonlabs/playground-micronaut/pkgs/container/playground-micronaut) directly, without using this image.
82-
83-
## Publish to Docker Hub
84-
85-
Run the following command to build a `linux/amd64` image (replace `x.y.z` with the actual version you wish to release)
86-
87-
```
88-
docker buildx build --no-cache --platform linux/amd64 -t eclipseepsilon/playground:x.y.z .
89-
docker tag eclipseepsilon/playground:x.y.z eclipseepsilon/playground:latest
90-
```
91-
92-
And then push it to Docker Hub
93-
94-
```
95-
docker push eclipseepsilon/playground:x.y.z
96-
docker push eclipseepsilon/playground:latest
97-
```
98-

0 commit comments

Comments
 (0)