Commit 9f7617d5 authored by schrieveslaach's avatar schrieveslaach

Improve documentation

parent 2cdf43fe
# PREvant Demo Use Cases
This repository contains an example configuration and demonstration how you could use PREvant in your development
work-flows. Therefore, the repository contains compose setup, running PREvant with the local Docker socket and a
work-flows. Therefore, the repository contains compose setup, running [PREvant][1] with the local Docker socket and a
private Docker registry with the necessary PKI.
## Download
It is required to use [repo](https://source.android.com/setup/develop/repo) to manage the git repositories
of this demonstration. Make sure to install it ([AUR package](https://www.archlinux.org/packages/community/any/repo/) or
[Android Instructions](https://source.android.com/setup/build/downloading#installing-repo)). Then, you can pull all
required source repository:
```bash
mkdir some-name
cd some-name
repo init -u https://gitlab.com/schrieveslaach/prevant-demo.git
repo sync
```
## Preparation
In order to demonstrate PREvant the PKI has to be created:
......@@ -13,6 +27,22 @@ cd certs
./build-a-pki.sh
```
Additionally, it is required to use [repo](https://source.android.com/setup/develop/repo) to manage the git repositories
of this demonstration. Make sure to install it ([AUR package](https://www.archlinux.org/packages/community/any/repo/) or
[Android Instructions](https://source.android.com/setup/build/downloading#installing-repo)).
Additionally, it is required that you create a hostname entry for `registry.example.com`. For example, you could add
following line to `/etc/hosts` on Linux:
```
127.0.0.1 registry.example.com
```
Furthermore, copy `certs/ca.cert` to `/etc/docker/certs.d/registry.example.com/ca.crt` to accept the self signed pki.
Otherwise you won't be able to push images to the Docker registry. See
[registry documentation](https://docs.docker.com/registry/insecure/#use-self-signed-certificates) for more details
## Start PREvant Setuo
```bash
cd demo
docker-compose up -d
```
[1]: https://github.com/aixigo/PREvant
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment