Commit 80afc604 authored by René Jochum's avatar René Jochum

More docs

parent 1903d087
# minAdmin
## Clone this repo
## The components of minAdmin
| Component | Description |
|-----------|-------------|
| [minadmin_main](https://git.webmeisterei.com/minadmin/minadmin_main) | The "main" entrypoint for clients - its the Webserver and hosts .well-known/minadmin-configuration. |
| [minadmin_auth](https://git.webmeisterei.com/minadmin/minadmin_auth) | The IDP for Hydra |
| [minadmin_auth_srv_xorm](https://git.webmeisterei.com/minadmin/minadmin_auth_srv_xorm) | Currently the only available backend for "minadmin_auth" above |
| [minadmin_init](https://git.webmeisterei.com/minadmin/minadmin_init) | Creates the "root" user and the minAdmin hydra client |
| [minadmin](https://git.webmeisterei.com/minadmin/minadmin) | Contains the shared golang Package for all other components |
| [agent_zimbra](https://git.webmeisterei.com/minadmin/agent_zimbra) | The first minAdmin agent, for Zimbra |
## External Components used here
| Component | Description |
|-----------|-------------|
| [consul](https://www.consul.io/) | Connects everything together |
| [vault](https://www.vault.io) | Secret Storage - not in use yet |
| [traefik](https://traefik.io/) | The HTTP Router in use |
| [hydra](https://www.ory.sh/docs/guides/master/hydra/) | Hydra is used as OpenID Connect Provider |
| [micro](https://micro.mu/) | Our microframework to connected each piece together |
| [postgresql](https://www.postgresql.org/) | The World's Most Advanced Open Source Relational Database |
## Installation
### Clone this repo
```
git clone --recurse-submodules -j8 https://git.webmeisterei.com/minadmin/dev.git
```
## Setup
### Setup
- Install go 1.11
......
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