Skip to content

Commit 9676a5b

Browse files
committed
CI/CD Added specific Docker Description and README updates
1 parent 9055a90 commit 9676a5b

File tree

3 files changed

+18
-36
lines changed

3 files changed

+18
-36
lines changed

.github/workflows/goca-rest-api-docker-dev.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,11 @@ jobs:
4545
with:
4646
push: true
4747
tags: kairoaraujo/goca:dev
48+
49+
- name: Update repo description
50+
uses: peter-evans/dockerhub-description@v2
51+
with:
52+
username: ${{ secrets.DOCKERHUB_USERNAME }}
53+
password: ${{ secrets.DOCKERHUB_PASSWORD }}
54+
repository: kairoaraujo/goca
55+
readme-filepath: ./DOCKER_README.md

.github/workflows/goca-rest-api-docker-release.yml

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,6 @@ jobs:
2222
- name: Check out code into the Go module directory
2323
uses: actions/checkout@v2
2424

25-
- name: Push to GitHub Packages
26-
uses: docker/build-push-action@v2
27-
with:
28-
username: ${{ github.actor }}
29-
password: ${{ secrets.GPR_TOKEN }}
30-
registry: docker.pkg.github.com
31-
repository: kairoaraujo/goca/goca-rest-api
32-
tag_with_ref: true
33-
3425
- name: Set up QEMU
3526
uses: docker/setup-qemu-action@v1
3627

README.md

Lines changed: 10 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -21,33 +21,6 @@ Certificates Request List (CRL).
2121
- [GoCA Package](#GoCA-Package)
2222
- [GoCA HTTP REST API package](#GoCA-HTTP-REST-API)
2323

24-
## GoCA Docker Container
25-
26-
GoCA Docker is HTTP Rest API that uses mainly crypto/x509 to manage Certificate Authorities and Certificates such
27-
as a simple PKI Service.
28-
29-
> NOTE: Do not expose the GoCA HTTP REST API service directly. Use it behind to some
30-
Authentication/Authorization service.
31-
32-
### Docker Container
33-
```
34-
$ docker run -p 80:80 kairoaraujo/goca:tag
35-
```
36-
37-
The API Documentation is online available at http://kairoaraujo.github.io/goca/.
38-
39-
### Where store the data
40-
41-
> The GoCA data (certificate, keys, etc.) is in ``/goca/data``; make sure you have a protected volume for this data.
42-
43-
Create a data directory on a suitable volume on your host system, e.g. /my/own/datadir.
44-
45-
Start your GoCA container like this:
46-
47-
````
48-
$ docker run -p 80:80 -v /my/own/datadir:/goca/data kairoaraujo/goca:tag
49-
````
50-
5124
## GoCA Package
5225

5326
```shell
@@ -150,3 +123,13 @@ GoCA also provides an implementation using HTTP REST API.
150123

151124
This is available in [``rest-api``](rest-api/) folder.
152125

126+
## GoCA Docker Container
127+
128+
GoCA Docker ready to use HTTP Rest API that uses mainly crypto/x509 to manage Certificate Authorities and Certificates such
129+
as a simple PKI Service.
130+
131+
The API Documentation is online available at http://kairoaraujo.github.io/goca/.
132+
133+
More details in [Docker README](DOCKER_README.md).
134+
135+
GoCA Docker Image is available at https://hub.docker.com/r/kairoaraujo/goca/

0 commit comments

Comments
 (0)