Docker install guide

[porcupinewine]

Hello,

I would be keen to install this using docker compose but I don't have any experience with Symfony applications. I went to the wiki and the section 'install with docker', but I wasn't sure what environment variables need to be customised in the compose file, clicking the link to the INSTALL.md file takes me to a page that seems like it's to do with Symfony applications.

Is there detailed, step-by-step guide to install with docker?

Thank you

[maelgangloff]

Hello,

You're right; the documentation is lacking in some areas, and I agree.

Currently, the INSTALL.md file provides instructions for installing the project without Docker, while the README contains some details on Docker installation.

If you want to install this project with Docker Compose, it is entirely possible. The docker-compose.yml file configures some services:

1. The Domain Watchdog server
2. A worker for async tasks (RDAP queries, emails, TLD updates, etc.)
3. A PostgreSQL database
4. (Optional) A KeyDB server (like Redis) for caching

To customize your setup, update the environment variables in the .env file (if using Docker).

If you run into issues, feel free to ask here

[YeapGuy]

What about SSO login? How do you configure that (is it possible)?

[maelgangloff]

There are two ways to authenticate users. I invite you to look at the environment variables in the .env file to better understand the configuration. If you don't understand what an environment variable is for, feel free to ask here.

1. Basic authentication (username + password). Self-registration can be enabled with the REGISTRATION_ENABLED variable. The REGISTRATION_VERIFY_EMAIL variable allows you to enable or disable verification of the user's email address upon registration.
2. External SSO authentication (via the OAuth 2.0 protocol). The variables to be configured are prefixed with OAUTH_.

If you are using Docker Compose, you can modify the docker-compose.yml file to include the variables you need. Only the variables defined in the .env file are currently recognized by the application.

Users are identified by their email address. This is the reconciliation field if multiple authentication methods are used.

I understand the difficulties encountered and I think I'll include a table in the README.md listing all the environment variables to avoid any confusion.

I hope this answers your questions.