Documentation for self-hosting with docker compose

[unteem]

Purpose

Make self hosting of Docs easier with an example of a deployment procedure with docker compose and document how to configure Docs.

While #583 propose an easy way to deploy Docs with docker and Make, here we describe more in details the various steps and requirements to deploy Docs.

Proposal

• example to deploy and configure keycloak
• example to deploy and configure minio
• example to configure proxy and certs
• example to deploy and configure Docs

Improvements

• Rephrase description of environment variables and categorize
• Use template for nginx conf

Fixes #561
Supersedes #583

A one liner quick start could be a nice addition:

• merge all services in a single compose
• scripts to generate secrets

[lunika]

you commits does not have a description. It is useful to add it to explain why you made the modification about the env.md file for example.

[mustafa0x]

This commit will make docs more accessible to a huge number of teams. Eagerly waiting to see it committed!

[unteem]

Thanks for the reviews, should be good now.

@lunika I removed the commits that change env.md and will make another PR of those changes make sense. I think its better to split it.

[virgile-dev]

How about we keep an installation.md at the root of the /docs folder where we can list the different deployment option (K8S, Compose and NIX) ?

[virgile-dev]

Let's merge this and make documentation for different deployment solution more homogeneous in a next PR.

[virgile-dev]

@unteem can you make the last test pass so we can merge this please ?

[AbdelRahmanAlTamimi]

@unteem
Hi, I've noticed that the curl commands provided in the docs/installation/compose.md and other files are currently resulting in a 404: Not Found error. Could you please investigate and update the documentation accordingly? Thanks!

[z3ntu]

These two variables seem to have been renamed? https://github.com/suitenumerique/docs/blob/d952815/src/backend/core/authentication/backends.py#L17-L28

[z3ntu]

This should be clarified imo, it took me a while until I made the connection of currently root user & password credentials being the ones for

AWS_S3_ACCESS_KEY_ID=<s3 access key>
AWS_S3_SECRET_ACCESS_KEY=<s3 secret key>

Also maybe at least link to outside docs that explain how to set up a user? I imagine most (including me) are not familiar with how one usually sets up minio.

I'm currently trying to set that up, from my understanding I need to create a new user, https://min.io/docs/minio/linux/administration/identity-access-management/minio-user-management.html#id1 and then it sounds like I shouldn't use the user credentials directly but create an accesskey to put into the config? https://min.io/docs/minio/linux/reference/minio-mc-admin/mc-admin-accesskey-create.html#command-mc.admin.accesskey.create

[unteem]

Initially I added an example but I eventually dropped it. The intention here is more to provide a quick start example than a thorough process to go to production. I don't know if we want to go that deep in details, like creating a user with the correct permissions.

Docs requires some "complex" parts like an IDP and Object Storage, I think its important for those who want to self host those parts to read the upstream doc and understand by themselves all the implications.

In this context I think skipping user and policy creation and using the minio root user is good enough as an example.

In this case to create the user it would look like this:

1. Create policy for the bucket

cat > readwritedocs.json << EOF
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:*"
            ],
            "Resource": [
                "arn:aws:s3:::<your-bucket-name>/*"
            ]
        }
    ]
}
EOF

mc admin policy create myminio readwritedocs readwritedocs.json

2. Create user

mc admin user add myminio <username> <password>

4. Assign policy to user

mc admin policy attach myminio getonly --user=<your-user>

[unteem]

curious to have your thoughts on this @virgile-dev
should I add this part in the example ?