local mount, profiles and new docs #152

MdreW · 2024-08-23T14:08:47Z

This is an example for a docker compose without static volumes, has only example scope

static mount are removed
added directory Docker-compose/satosa for satosa container application
added directory Docker-compose/djangosaml2_sp/* for django container application
added directory Docker-compose/mongo/db/* for mongo container db
updated .gitignore for exclude production data
removed rm-persistent-volumes.sh script
Updated run-docker-compose.sh
- Create if no exists required folder
- Added -f option for clean old dp/application data and reinitialize the sistem
- Added -h option for print help

$ run-docker-compose.sh

### run-docker-compose.sh ###

initialize and start Satosa-Saml2Spid

Option
-f Force clean and reinitialize data for Satosa, MongoDB and Djangosaml2_SP
-h Print this help

…e passed

gitguardian · 2024-08-23T14:08:51Z

⚠️ GitGuardian has uncovered 9 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
3369235	Triggered	Generic High Entropy Secret	`3c4c1d6`	Docker-compose/mongo/db/.mongodb/mongosh/66c8648753e2f14983a26a12_log	View secret
3369235	Triggered	Generic High Entropy Secret	`3c4c1d6`	Docker-compose/mongo/db/.mongodb/mongosh/66c8776831e5574dd75e739b_log	View secret
3369235	Triggered	Generic High Entropy Secret	`6c693af`	Docker-compose/mongo/db/.mongodb/mongosh/66c8648753e2f14983a26a12_log	View secret
3369235	Triggered	Generic High Entropy Secret	`6c693af`	Docker-compose/mongo/db/.mongodb/mongosh/66c8776831e5574dd75e739b_log	View secret
5632966	Triggered	Username Password	`87c7f90`	Docker-compose/docker-compose.yml	View secret
5632967	Triggered	Generic High Entropy Secret	`3c4c1d6`	Docker-compose/mongo/db/.mongodb/mongosh/66c8776831e5574dd75e739b_log	View secret
5632967	Triggered	Generic High Entropy Secret	`3c4c1d6`	Docker-compose/mongo/db/.mongodb/mongosh/66c8648753e2f14983a26a12_log	View secret
5632967	Triggered	Generic High Entropy Secret	`6c693af`	Docker-compose/mongo/db/.mongodb/mongosh/66c8776831e5574dd75e739b_log	View secret
5632967	Triggered	Generic High Entropy Secret	`6c693af`	Docker-compose/mongo/db/.mongodb/mongosh/66c8648753e2f14983a26a12_log	View secret

🛠 Guidelines to remediate hardcoded secrets

Understand the implications of revoking this secret by investigating where it is used in your code.
Replace and store your secrets safely. Learn here the best practices.
Revoke and rotate these secrets.
If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

following these best practices for managing and storing secrets including API keys and other credentials
install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}

Docker-compose/docker-compose.yml

peppelinux · 2024-08-27T10:07:43Z

Docker-compose/docker-compose.yml

@@ -110,8 +108,7 @@ services:
    ports:
      - "10000:10000"
    volumes:
-       - /usr/share/zoneinfo/Europe/Rome:/etc/localtime:ro
-       - ../docker-example:/satosa_proxy:rw
+       - ./satosa:/satosa_proxy:rw


satosa -> project?

I agree that docker-example is too much related to the demo purposes, while satosa is too much generic and might confuse the software/application name with the local configuration, I suppose that project or any other similar alternative might better explain the purpose of that folder

… environment

MdreW · 2024-08-28T14:45:39Z

Added TZ in docker compose, update satosa Dockerfile to support this.
a little optimization of Dockerfile RUN

[ranaldi@andrea-ranaldi-p Satosa-Saml2Spid]$ docker run -tie TZ=Europe/Berlin satosa bash
126b80233e9b:/satosa_proxy# date
Wed Aug 28 17:05:22 CEST 2024

[ranaldi@andrea-ranaldi-p Satosa-Saml2Spid]$ docker run -tie TZ=Australia/Melbourne satosa bash
7c1efed81ada:/satosa_proxy# date
Thu Aug 29 01:05:39 AEST 2024

MdreW · 2024-09-08T13:26:10Z

I have added profiles demo to start all services and dataentry for add mongo-express service.
Nginx, satosa and mongo are every started for production.

I have update update run-docker-compose.sh to start demo profile as default, dataentry and production profiles are optional. I have added also an option to skip docker image update and compile -s.

### run-docker-compose.sh ###

initialize check update and start Satosa-Saml2Spid

Option
-f Force clean and reinitialize data for Satosa, MongoDB and Djangosaml2_SP
-h Print this help
-p Set production profile: start satosa, nginx, mongo
-s Skip docker image update
-d Set data entry profile: start satosa, nginx, mongo, mongo-express
   if isn't set -d or -p defatult demo profile is started
   default demo profile start: satosa, nginx, mongo, mongo-express, django-sp, spid-saml-check

At last I have update ./stop-docker-compose.sh to stop all profiles and remove orphan containers, but we can add an option to stop also only specific profiles.

@Zicchio you can try this on windows?

peppelinux · 2024-09-08T13:33:47Z

Docker-compose/docker-compose.yml

    ports:
      - 8082:8081
+    depends_on:
+      - satosa-mongo
    environment:
      ME_CONFIG_BASICAUTH_USERNAME: satosauser


Wouldnt be mettere to have them in ENV?

For instances with only spid-saml backend? I can try 👍

Hi @peppelinux ,

I have tried and I can't use an Environment to enable mongo dependence on compose because depends_on don't accept "null" as value:
service "satosa-saml2spid" depends on undefined service "": invalid

I can propose a new docker compose profile for MongoDB? The profiles can be:

default (without profile):

satosa-sa,l2spid (without mongo dependancy)

satosa-nginx

db:

*default

satosa-mongo

dataentry:

*default

*db

satosa-mongoexpress

dev:

*default

django-sp

spid-samlcheck

demo:

default*

*db

*dataentry

*dev

If I use an external MongoDB, is sufficient don't start the db profile (only default) or use dev profile for a full system without mongo.
What do you think?

peppelinux · 2024-09-12T09:26:27Z

Docker-compose/docker-compose.yml

@@ -110,8 +113,8 @@ services:
    ports:
      - "10000:10000"
    volumes:
-       - /usr/share/zoneinfo/Europe/Rome:/etc/localtime:ro
-       - ../docker-example:/satosa_proxy:rw
+      - ./satosa:/satosa_proxy:rw


Suggested change

- ./satosa:/satosa_proxy:rw

- ./satosa-project:/satosa_proxy:rw

MdreW · 2024-09-15T20:52:02Z

Fix #156 with 01fbf8d

MdreW · 2024-09-16T12:26:10Z

Migrate to #160

MdreW added 5 commits August 23, 2024 14:20

example: docker compose witout static volumes

3c4c1d6

removed unrequested files

6c693af

added .gitkeep

aeda522

added docker production directory

7390040

ensure that initialize_satosa and start are executed if no options ar…

9c517fc

…e passed

MdreW mentioned this pull request Aug 23, 2024

The provided Docker-compose and helper script do not work on a Windows machine #145

Open

merge from master

a719af3

peppelinux reviewed Aug 23, 2024

View reviewed changes

Docker-compose/docker-compose.yml Show resolved Hide resolved

peppelinux reviewed Aug 27, 2024

View reviewed changes

MdreW added 2 commits August 28, 2024 16:41

Added tz environment for configure timezone

99d0683

Optimized RUN and added tzdata package to configure timezione with TZ…

5299dc8

… environment

MdreW added 2 commits August 29, 2024 14:45

add comments and example for static volumes

b27bbeb

fix static files position to new path

6b624ef

MdreW self-assigned this Aug 29, 2024

Added profile demo and dataentry, removed not required "restart: always"

87c7f90

peppelinux reviewed Sep 8, 2024

View reviewed changes

Update nginx service

aa3e1db

peppelinux reviewed Sep 12, 2024

View reviewed changes

MdreW added 5 commits September 13, 2024 13:43

profiles updated and added run-docker-compose.sh istruction

fed7447

update doc

d61b374

added "docker compose profiles"

b7a8977

fix link

1e07ee0

removed ".env" from repository, only .env.example is present

01fbf8d

MdreW changed the title ~~example with only local mount~~ local mount, profiles and new docs Sep 15, 2024

MdreW mentioned this pull request Sep 15, 2024

.env in .gitignore #156

Closed

MdreW mentioned this pull request Sep 15, 2024

nginx folder from Docker-compose to docker-example #158

Closed

fix #155

6451264

MdreW closed this Sep 16, 2024

MdreW deleted the local_mount branch October 7, 2024 19:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

local mount, profiles and new docs #152

local mount, profiles and new docs #152

MdreW commented Aug 23, 2024

gitguardian bot commented Aug 23, 2024 •

edited

Loading

peppelinux Aug 27, 2024

MdreW commented Aug 28, 2024 •

edited

Loading

MdreW commented Sep 8, 2024

peppelinux Sep 8, 2024

MdreW Sep 8, 2024

MdreW Sep 9, 2024 •

edited

Loading

peppelinux Sep 12, 2024

MdreW commented Sep 15, 2024 •

edited

Loading

MdreW commented Sep 16, 2024

	- ./satosa:/satosa_proxy:rw
	- ./satosa-project:/satosa_proxy:rw

local mount, profiles and new docs #152

local mount, profiles and new docs #152

Conversation

MdreW commented Aug 23, 2024

gitguardian bot commented Aug 23, 2024 • edited Loading

⚠️ GitGuardian has uncovered 9 secrets following the scan of your pull request.

peppelinux Aug 27, 2024

Choose a reason for hiding this comment

MdreW commented Aug 28, 2024 • edited Loading

MdreW commented Sep 8, 2024

peppelinux Sep 8, 2024

Choose a reason for hiding this comment

MdreW Sep 8, 2024

Choose a reason for hiding this comment

MdreW Sep 9, 2024 • edited Loading

Choose a reason for hiding this comment

peppelinux Sep 12, 2024

Choose a reason for hiding this comment

MdreW commented Sep 15, 2024 • edited Loading

MdreW commented Sep 16, 2024

gitguardian bot commented Aug 23, 2024 •

edited

Loading

MdreW commented Aug 28, 2024 •

edited

Loading

MdreW Sep 9, 2024 •

edited

Loading

MdreW commented Sep 15, 2024 •

edited

Loading