document how to configure services

[danielo515]

Hello,

First of all, thank you very much for this project.
It is amazing to have so many services available to easily configure in Process Compose.
Thank you very much.

I would like to request that it be documented how to configure the different services, I mean, literal config options.

For a reference, this is all you see in the postgres docs:

# In `perSystem.process-compose.<name>`
{
  services.postgres."pg1".enable = true;
}

For example, today I had to browse the postgres service definition to see that it accepts a dictionary of values called Settings, where I can put the configuration I want. This is very convenient and I have been going around and making all kind of weird attempts in order to be able to try to configure it correctly when I could have done it from the beginning simply by providing this argset.
It would be amazing to have it documented upfront.
Thank you very much.
It will be useful even if this was to simply say you can put settings into settings key and then link to the official documentation of the options for this service.

[shivaraj-bh]

Apart from the examples in the documentation, there are ./nix/services/<service_name>_test.nix for a few more examples.

Coming to documentation, you are right, there is some work needed there for discoverability of per-service options. As first step, I would like to work on #158.

[shivaraj-bh]

If there isn’t any other requirement than being able to search through the options of every service, we can close this issue as a duplicate of #158

[danielo515]

Apart from the examples in the documentation, there are ./nix/services/<service_name>_test.nix for a few more examples.

I used those as reference first, but as far as I know, none of those include a settings. For example:

          services.postgres.pg1 = {
            enable = true;
            superuser = PG_USER;
            settings = {
              wal_level = "logical";
            };
            initialDatabases = [
              {
                name = PG_DB;
                schemas = [];
              }
            ];
          };

As far as I know, there is nothing like that in the tests either.

If there isn’t any other requirement than being able to search through the options of every service, we can close this issue as a duplicate of #158

It is more of giving a human touch to mention the ability to provide additional settings to the services that support it. It only needs to be a single sentence on each service that allows it, or all of them. Even if it feels a bit redundant or of low value, if you directly land on a single service page that will be of enormous help IMO.