Skip to content

Commit

Permalink
Update readme - second release
Browse files Browse the repository at this point in the history
  • Loading branch information
davidelongo-ey committed Nov 30, 2023
1 parent be3d82b commit ad60f98
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 23 deletions.
9 changes: 7 additions & 2 deletions README-Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,13 @@ pip install -r requirements.txt

## Configure the Proxy

- Create certificates for SPID see [psmiraglia](https://github.com/italia/spid-compliant-certificates)
(For more details please see also the [Python native solution](https://github.com/italia/spid-compliant-certificates-python))
- Create certificates for SPID.

To do that, you can use one of the following solution to create X.509 certificates:
> [psmiraglia](https://github.com/italia/spid-compliant-certificates)
> [Python native solution](https://github.com/italia/spid-compliant-certificates-python)

- Copy `repository/example/*` contents (`cp -R repository/example/* .`) and **edit the files below**

Expand Down
21 changes: 1 addition & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,44 +80,28 @@ To get redirection to these pages, or redirection to third-party services, it is

## How to start the environment



The average time to set up the environment is about 1 hour. This time may vary depending on the machine's resources and the type of network connection.





> Make sure that in your environment is correcly installed:
> - a version of Python 3.9 or higher
> - a version of Python 3.10 or higher
> - Git
> - Docker



#### STEP 1 - Setup
please review the following documentation in order to install, configure and run Satosa-Saml2spid
[README-SETUP.md](README-Setup.md)



#### STEP 2 - Docker Compose


please review the following documentation [Docker-compose](Docker-compose/README.md) in order to create the volumes:
- satosa-saml2spid_mongodata
- satosa-saml2spid_nginx_certs



Satosa-Saml2Spid image is built with production ready logic.
The docker compose may use the [enviroment variables](#configuration-by-environment-variables)
to configure Satosa-Saml2Spid.




<img src="gallery/docker-design.svg" width="512">

The official Satosa-Saml2SPID docker image is available at
Expand All @@ -129,13 +113,10 @@ Below some quick commands:
- Build locally the image, execute the following command: `docker build -t satosa-saml2spid .`.
- Inspect the image content: `docker run -it -v $(pwd)/example:/satosa_proxy --entrypoint sh satosa-saml2spid`.



#### STEP 3 - Install and Run Djangosaml2

please review the following documentation [Djangosaml2](example_sp/djangosaml2_sp/README.md)


<hr>

## For Developers
Expand Down
4 changes: 3 additions & 1 deletion example_sp/djangosaml2_sp/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Demo Setup

### Pre-requirements

Before starting, make sure that the following Docker containers are up and running
Expand All @@ -11,7 +13,7 @@ Before starting, make sure that the following Docker containers are up and runni


if everithings is ok, go to the path `/{your path}/Satosa-Saml2Spid/example_sp` and execute the following commands
if everythings is ok, go to the path `/{your path}/Satosa-Saml2Spid/example_sp` and execute the following commands


### djangosaml2-sp (SP server)
Expand Down

0 comments on commit ad60f98

Please sign in to comment.