Skip to content

Commit

Permalink
Adjust CI/CD and Documentation
Browse files Browse the repository at this point in the history
The README.md was updated adding the information about the Docker on
top.
The CI/CD is fixed
  • Loading branch information
kairoaraujo committed Jan 10, 2021
1 parent 38e2140 commit bc75f23
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 24 deletions.
8 changes: 0 additions & 8 deletions .github/workflows/goca-rest-api-docker-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,3 @@ jobs:
registry: docker.pkg.github.com
repository: kairoaraujo/goca/goca-rest-api
tag_with_ref: true

- name: Docker Hub Description
uses: peter-evans/dockerhub-description@v2
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_PASSWORD }}
repository: kairoaraujo/goca
readme-filepath: ./DOCKER-README.md
14 changes: 0 additions & 14 deletions DOCKER-README.md

This file was deleted.

34 changes: 32 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/kairoaraujo/goca)](https://goreportcard.com/report/github.com/kairoaraujo/goca)
[![Build Status](https://github.com/kairoaraujo/goca/workflows/tests/badge.svg)](https://github.com/kairoaraujo/goca/actions)
[![Go Reference](https://pkg.go.dev/badge/github.com/kairoaraujo/goca.svg)](https://pkg.go.dev/github.com/kairoaraujo/goca)
[![Docker Pulls](https://img.shields.io/docker/pulls/kairoaraujo/goca.svg?maxAge=604800)](https://hub.docker.com/r/kairoaraujo/goca/)

Package GocA provides a Certificate Authority (CA) framework managing, a Simple PKI.

GocA provides a Certificate Authority (CA) framework managing, a Simple PKI.

GoCA is a framework that uses mainly crypto/x509 to manage Certificate
Authorities.
Expand All @@ -15,9 +17,37 @@ Certificates Request List (CRL).

**Content**:

- [GoCA Docker](#GoCA-Docker-HTTP-REST-API)
- [GoCA Package](#GoCA-Package)
- [GoCA HTTP REST API](#GoCA-HTTP-REST-API)
- [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
#### Stable
```
$ 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

Expand Down

0 comments on commit bc75f23

Please sign in to comment.