README.md 1.46 KB
Newer Older
lukas.burgey's avatar
lukas.burgey committed
1 2 3 4

[![pipeline status](https://git.scc.kit.edu/feudal/feudalBackend/badges/master/pipeline.svg)](https://git.scc.kit.edu/feudal/feudalBackend/-/commits/master)
[![coverage report](https://git.scc.kit.edu/feudal/feudalBackend/badges/master/coverage.svg)](https://git.scc.kit.edu/feudal/feudalBackend/-/commits/master)

Lukas Burgey's avatar
Lukas Burgey committed
5
# FEderated User Credential Deployment PortAL (FEUDAL)
ubedv's avatar
ubedv committed
6 7
- User interface: [Webpage](https://git.scc.kit.edu/feudal/feudalWebpage)
- Component at the sites: [Client](https://git.scc.kit.edu/feudal/feudalClient)
Lukas Burgey's avatar
Lukas Burgey committed
8

Lukas Burgey's avatar
Lukas Burgey committed
9
## Installation
lukas.burgey's avatar
lukas.burgey committed
10
- Needs Python 3.6
Lukas Burgey's avatar
Lukas Burgey committed
11 12 13
- For debian 9: see debian/README.md
- A puppet setup is could be made available.

Lukas Burgey's avatar
Lukas Burgey committed
14

Lukas Burgey's avatar
Lukas Burgey committed
15
## Starting the backend
Lukas Burgey's avatar
Lukas Burgey committed
16 17
  - systemctl start nginx rabbitmq-server (as root)
  - systemctl --user start uwsgi
ubedv's avatar
ubedv committed
18

Lukas Burgey's avatar
Lukas Burgey committed
19
## Runtime Configuration
ubedv's avatar
ubedv committed
20
- For runtime configuration we use the django inbuilt admin interface.
Lukas Burgey's avatar
Lukas Burgey committed
21
	- Default path of the django admin: `/backend/admin`
ubedv's avatar
ubedv committed
22 23 24 25 26 27 28 29 30
	- The credentials for the admin were entered by you during the run of the `install` script
- Your OpenId Connect clients are configured in `Home > Backend > Oidc configs`
	- The default redirect URI is: `/backend/auth/v1/callback`
	- `scopes` is a list of strings (JSON)
- Users *and* FEUDAL Clients are managed in `Home > Backend > Users`
	- You can manually add FEUDAL Clients
	- You can specify admin users
- You need to configure the `sites`, which provide services to your users in `Home > Backend > Sites`
- Configure your RabbitMQ instance in `Home > Backend > Rabbit mq instances`