README.md 1.14 KB
Newer Older
Lukas Burgey's avatar
Lukas Burgey committed
1
# FEderated User Credential Deployment PortAL (FEUDAL)
ubedv's avatar
ubedv committed
2 3
- 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
4

Lukas Burgey's avatar
Lukas Burgey committed
5 6 7
## Installation
- Needs Python 3.6 or higher
- `pip install git+https://git.scc.kit.edu/feudal/feudalBackend`
Lukas Burgey's avatar
Lukas Burgey committed
8

Lukas Burgey's avatar
Lukas Burgey committed
9
## Starting the backend
Lukas Burgey's avatar
Lukas Burgey committed
10 11
  - systemctl start nginx rabbitmq-server (as root)
  - systemctl --user start uwsgi
ubedv's avatar
ubedv committed
12

Lukas Burgey's avatar
Lukas Burgey committed
13
## Runtime Configuration
ubedv's avatar
ubedv committed
14
- For runtime configuration we use the django inbuilt admin interface.
Lukas Burgey's avatar
Lukas Burgey committed
15
	- Default path of the django admin: `/backend/admin`
ubedv's avatar
ubedv committed
16 17 18 19 20 21 22 23 24
	- 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`