Skip to content

Commit

Permalink
bugfix - V4 table cols, DOCS update
Browse files Browse the repository at this point in the history
  • Loading branch information
jirivrany committed Jan 25, 2024
1 parent e86ac0f commit 6b020f1
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 6 deletions.
18 changes: 17 additions & 1 deletion docs/AUTH.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,32 @@ Since version 0.7.3, the application supports three different forms of user auth
### SSO
To use SSO, you need to set up Apache + Shiboleth in the usual way. Then set `SSO_AUTH = True` in the application configuration file **config.py**

In general the whole app should be protected by Shiboleth. However, there certain endpoints should be excluded from Shiboleth for the interaction with BGP. See configuration example bellow. The endpoints which are not protected by Shibboleth are protected by app itself. Either by @localhost_only decorator or by API key.

Shibboleth configuration example:

#### shibboleth config:
#### shibboleth config (shib.conf):
```
<Location />
AuthType shibboleth
ShibRequestSetting requireSession 1
require shib-session
</Location>
<LocationMatch /api/>
Satisfy Any
allow from All
</LocationMatch>
<LocationMatch /rules/announce_all>
Satisfy Any
allow from All
</LocationMatch>
<LocationMatch /rules/withdraw_expired>
Satisfy Any
allow from All
</LocationMatch>
```


Expand Down
8 changes: 4 additions & 4 deletions docs/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,18 +125,18 @@ Supervisord is used to run and manage application.

#### Final steps - as deploy user

Copy config.example.py to config.py and fill out the DB credetials.
1. Copy config.example.py to config.py and fill out the DB credetials.

Create and populate database tables.
2. Create and populate database tables.
```
cd ~/www
source venv/bin/activate
python db-init.py
```
DB-init script inserts default roles, actions, rule states and two organizations (TUL and Cesnet). But no users.

So before start, use your favorite mysql admin tool and insert some users into database.
The uuid of user should be set the eppn value provided by Shibboleth.
3. Before start, **use your favorite mysql admin tool and insert some users into database**.
The **uuid** of user should be set the **eppn** value provided by Shibboleth.

You can use following MYSQL commands to insert the user, give him role 'admin' and add him to the the organization 'Cesnet'.

Expand Down
2 changes: 1 addition & 1 deletion flowapp/instance_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ class InstanceConfig:
"macro_tbody": "build_ip_tbody",
"macro_thead": "build_rules_thead",
"table_colspan": 10,
"table_columns": RULES_COLUMNS_V6,
"table_columns": RULES_COLUMNS_V4,
},
"ipv6": {
"name": "IPv6",
Expand Down

0 comments on commit 6b020f1

Please sign in to comment.