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

6
Installation (Debian 9.6)
Lukas Burgey's avatar
Lukas Burgey committed
7
----
Lukas Burgey's avatar
Lukas Burgey committed
8

9 10 11
- Add some dependency repositories
  - Add repository for Erlang 21 (e.g. from [here](https://www.rabbitmq.com/install-debian.html#bintray-apt-repo-erlang))
  - Add repository for node.js v10.x (e.g. from [nodesource](https://github.com/nodesource/distributions#debinstall))
12
- Add a user for the backend
13 14 15 16 17 18 19 20 21 22 23 24
	- `useradd -m $user`
  - login as $user
	- `git clone https://git.scc.kit.edu/feudal/feudalBackend $backend`
	- `cd $backend`
    - `cp config.env.default config.env`
      - Adjust the default values where needed
        - $backend needs to the directory this repo is cloned into
        - $domain is the domain of your host machine
    - Run `./install_privileged` as root
		- Run `./install` as $user

Starting the backend
25
----
26 27
  - systemctl start nginx rabbitmq-server (as root)
  - systemctl --user start uwsgi
ubedv's avatar
ubedv committed
28

29 30 31
Checking the status of the backend
----
 - `./status`
ubedv's avatar
ubedv committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48

		
Runtime Configuration
----

- For runtime configuration we use the django inbuilt admin interface.
 	- Default path of the django admin: `/backend/admin`	
	- 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`