Skip to content

Commit

Permalink
README.md edited online with Bitbucket
Browse files Browse the repository at this point in the history
  • Loading branch information
chasegawa committed Sep 8, 2022
1 parent 8c3a3c4 commit 64e4fdd
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions bulk-upload/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
This script can be used to bulk upload metadata files into the Shibboleth IdP UI

### requirements ###
The shibui must be configured without SAML authentication enabled. The API is currently only accessible using Basic auth.
If shibui is using SAML auth, you can temporarily disable it by setting pac4j-enabled: false in application.yml and restarting shibui.
Docker engine - the run script will launch a Docker container which will handle the process.
OR
Bash shell with Perl (and additional Perl libraries - see below).

The Shib-UI must be configured *without* SAML authentication enabled. The needed API is currently only accessible using Basic auth. If you are using SAML auth, you can return to using it after the bulk upload process is run.
If Shib-UI is using SAML auth, you can temporarily disable it by setting pac4j-enabled: false in application.yml and restarting shibui.
After uploading you can re-enable SAML auth by setting pac4j-enabled: true in application.yml and restarting shibui.

### usage ###
Expand Down Expand Up @@ -34,7 +38,7 @@ attr[0][Value] = false

### docker image ###
run.sh will pull the shibui-bulk-upload image from dockerhub and run the script within
If you need to build the image yourself, `cd docker-build;docker build -t unicon/shibui-bulk-upload .`
If you prefer to build the image yourself, `cd docker-build;docker build -t unicon/shibui-bulk-upload .`

### running without docker ###
The docker-build/shibui-md-upload.pl script can be run manually.
Expand Down

0 comments on commit 64e4fdd

Please sign in to comment.