You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-17Lines changed: 23 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ Insomnia Mockbin is maintained by [Kong](https://github.com/Kong), who also main
31
31
- allows for HTTP Method Override using the header `X-HTTP-Method-Override` or through query string parameter: `_method`
32
32
- create custom bins for experimenting log collection
33
33
34
-
## Installation
34
+
## Local Development
35
35
36
36
### Requirements
37
37
@@ -66,28 +66,34 @@ npm run dev
66
66
DEBUG=mockbin npm run dev
67
67
```
68
68
69
-
## Running with Docker Compose
69
+
###Running with Docker Compose
70
70
71
71
```shell
72
72
docker compose up
73
73
```
74
74
75
-
## Documentation
76
-
77
-
### API Docs
78
-
79
-
Read the full API documentation, please review the [API Docs](https://github.com/Kong/mockbin/tree/master/docs).
80
-
81
-
## Releasing
75
+
### Releasing
82
76
83
77
Run the following command and push the newly created commit into your PR.
84
78
This will bump commit and tag, you will need to push this to the remote, which trigger the release action upon merging the PR.
85
79
80
+
Please note that separate branches are currently maintained for cloud mocks and self hosted mocks. Merging to the default branch or creating a tag on a commit on the default branch will result in the cloud mock server image being published. Merging to the `self-hosted` branch of creating a tag on a commit on the `self-hosted` branch (please use the format v.x.x.x-self-hosted in this case) will result in the self-hosted mock server image being published.
81
+
86
82
```sh
87
83
npm version patch
88
84
git push origin tag <tag_name>
89
85
```
90
86
87
+
## Documentation
88
+
89
+
### API Docs
90
+
91
+
Read the full API documentation, please review the [API Docs](https://github.com/Kong/mockbin/tree/master/docs).
92
+
93
+
### Deployment
94
+
95
+
See [https://developer.konghq.com/insomnia/mock-servers/](https://developer.konghq.com/insomnia/mock-servers/) for the available options for deploying mockbin.
96
+
91
97
### Software Bill of materials
92
98
93
99
Kong Insomnia Mockbin produces SBOMs for the below categories:
@@ -102,15 +108,15 @@ The SBOMs are available to download at:
102
108
103
109
### Verify a container image signature
104
110
105
-
Docker container images are now signed using cosign with signatures published to a [Github Container registry](https://ghcr.io) with `insomnia-mockbin` repository.
111
+
Docker container images are now signed using cosign with signatures published to a [Github Container registry](https://ghcr.io) with `insomnia-mockbin` repository. Separate images are published for cloud hosted mocks ([ghcr.io/kong/insomnia-mockbin-cloud](https://developer.konghq.com/how-to/create-a-cloud-hosted-mock-server/)) and self-hosted mocks ([ghcr.io/kong/insomnia-mockbin-self-hosted](https://developer.konghq.com/insomnia/self-hosted-mocks/)). Modify the examples below if you need to verify the image for self-hosted mocks.
106
112
107
113
Steps to verify signatures for signed Kong Insomnia Mockbin Docker container images in two different ways:
108
114
109
115
A minimal example, used to verify an image without leveraging any annotations. For the minimal example, you only need Docker details, a GitHub repo name, and a GitHub workflow filename.
2. A minimal example, used to verify an image without leveraging any annotations. For the minimal example, you only need Docker Image manifest, a GitHub repo name.
0 commit comments