Skip to content

Commit

Permalink
CI/CD Added specific Docker Description and README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
kairoaraujo committed Jan 11, 2021
1 parent 9055a90 commit 9676a5b
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 36 deletions.
8 changes: 8 additions & 0 deletions .github/workflows/goca-rest-api-docker-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,11 @@ jobs:
with:
push: true
tags: kairoaraujo/goca:dev

- name: Update repo description
uses: peter-evans/dockerhub-description@v2
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_PASSWORD }}
repository: kairoaraujo/goca
readme-filepath: ./DOCKER_README.md
9 changes: 0 additions & 9 deletions .github/workflows/goca-rest-api-docker-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,6 @@ jobs:
- name: Check out code into the Go module directory
uses: actions/checkout@v2

- name: Push to GitHub Packages
uses: docker/build-push-action@v2
with:
username: ${{ github.actor }}
password: ${{ secrets.GPR_TOKEN }}
registry: docker.pkg.github.com
repository: kairoaraujo/goca/goca-rest-api
tag_with_ref: true

- name: Set up QEMU
uses: docker/setup-qemu-action@v1

Expand Down
37 changes: 10 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,33 +21,6 @@ Certificates Request List (CRL).
- [GoCA Package](#GoCA-Package)
- [GoCA HTTP REST API package](#GoCA-HTTP-REST-API)

## GoCA Docker Container

GoCA Docker is HTTP Rest API that uses mainly crypto/x509 to manage Certificate Authorities and Certificates such
as a simple PKI Service.

> NOTE: Do not expose the GoCA HTTP REST API service directly. Use it behind to some
Authentication/Authorization service.

### Docker Container
```
$ docker run -p 80:80 kairoaraujo/goca:tag
```

The API Documentation is online available at http://kairoaraujo.github.io/goca/.

### Where store the data

> The GoCA data (certificate, keys, etc.) is in ``/goca/data``; make sure you have a protected volume for this data.
Create a data directory on a suitable volume on your host system, e.g. /my/own/datadir.

Start your GoCA container like this:

````
$ docker run -p 80:80 -v /my/own/datadir:/goca/data kairoaraujo/goca:tag
````

## GoCA Package

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

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

## GoCA Docker Container

GoCA Docker ready to use HTTP Rest API that uses mainly crypto/x509 to manage Certificate Authorities and Certificates such
as a simple PKI Service.

The API Documentation is online available at http://kairoaraujo.github.io/goca/.

More details in [Docker README](DOCKER_README.md).

GoCA Docker Image is available at https://hub.docker.com/r/kairoaraujo/goca/

0 comments on commit 9676a5b

Please sign in to comment.