Feature/docs/281 add documentation on advanced installation and configuration

[RabbITCybErSeC]

No description provided.

[github-actions]

Sigrid maintainability feedback

✅ You wrote maintainable code and achieved your objective of 3.8 stars

Show details

Sigrid compared your code against the baseline of 2024-12-12.

👍 What went well?

You fixed or improved 1 refactoring candidates.

Risk	System property	Location
🟡	Unit Size (Improved)	internal/controller/controller.go Initialize()

👎 What could be better?

Unfortunately, 1 refactoring candidates were introduced or got worse.

Risk	System property	Location
🟡	Unit Size (Introduced)	internal/controller/controller.go run(app *gin.Engine)

📚 Remaining technical debt

5 refactoring candidates didn't get better or worse, but are still present in the code you touched.

View this system in Sigrid** to explore your technical debt

⭐️ Sigrid ratings

System property	System on 2024-12-12	Before changes	New/changed code
Volume	5.4	N/A	N/A
Duplication	4.4	5.5	5.5
Unit Size	2.6	1.7	1.8
Unit Complexity	2.8	3.6	3.8
Unit Interfacing	2.9	5.5	5.5
Module Coupling	3.8	N/A	N/A
Component Independence	0.5	N/A	N/A
Component Entanglement	2.5	N/A	N/A
Maintainability	3.2	3.8	3.9

💬 Did you find this feedback helpful?

We would like to know your thoughts to make Sigrid better.
Your username will remain confidential throughout the process.

• ✅ Yes, these findings are useful
• 🔸 The findings are false positives
• 🔹 These findings are not important to me

---

View this system in Sigrid

[MaartendeKruijf]

Move the RBAC setup to a separate PR

[MaartendeKruijf]

Either point to a docker compose or provide one in deployment

[RabbITCybErSeC]

I will add this in a different pull request for now. ok?

[MaartendeKruijf]

we could use this style of init which I like better then the one we use now:
see: https://docs.opencti.io/latest/deployment/installation/#configure-the-environment

(cat << EOF
OPENCTI_ADMIN_EMAIL=admin@opencti.io
OPENCTI_ADMIN_PASSWORD=ChangeMePlease
OPENCTI_ADMIN_TOKEN=$(cat /proc/sys/kernel/random/uuid)
OPENCTI_BASE_URL=http://localhost:8080
MINIO_ROOT_USER=$(cat /proc/sys/kernel/random/uuid)
MINIO_ROOT_PASSWORD=$(cat /proc/sys/kernel/random/uuid)
RABBITMQ_DEFAULT_USER=guest
RABBITMQ_DEFAULT_PASS=guest
ELASTIC_MEMORY_SIZE=4G
CONNECTOR_HISTORY_ID=$(cat /proc/sys/kernel/random/uuid)
CONNECTOR_EXPORT_FILE_STIX_ID=$(cat /proc/sys/kernel/random/uuid)
CONNECTOR_EXPORT_FILE_CSV_ID=$(cat /proc/sys/kernel/random/uuid)
CONNECTOR_IMPORT_FILE_STIX_ID=$(cat /proc/sys/kernel/random/uuid)
CONNECTOR_EXPORT_FILE_TXT_ID=$(cat /proc/sys/kernel/random/uuid)
CONNECTOR_IMPORT_DOCUMENT_ID=$(cat /proc/sys/kernel/random/uuid)
SMTP_HOSTNAME=localhost
EOF
) > .env

and

export $(cat .env | grep -v "#" | xargs)

[MaartendeKruijf]

This is not correct

[RabbITCybErSeC]

@MaartendeKruijf what is correct then?