search

nixcloud / nixcloud-webservices

This nixpkgs extension, called nixcloud-webservices, focuses on ease of deployment of web-related technologies.
https://nixcloud.io
Other
182 stars 26 forks source link

Documentation for database abstraction #11

Open leenaars opened 6 years ago

leenaars commented 6 years ago

Documentation request

There is no documentation yet for the database abstraction. One may notice a database target and a db-server target for every service created with nixcloud, but it is not yet clear how to add anything to them.

aszlig commented 6 years ago

Does this help?

leenaars commented 6 years ago

Thanks @aszlig, that is already very helpful to get a basic understanding. Thanks! Some of the options might not really clear for implementers yet, e.g. what do they need to do with SO_PEERCRED, socketPath, etc. Will you be adding some examples how one would approach say a 'classic' LAMP application?

Note that a normal user like me would have looked for this in the documentation folder (/documentation).

aszlig commented 6 years ago

@leenaars: Hm, you're right, /documentation is probably better, I'll move it.

aszlig commented 6 years ago

@leenaars: The reference on SO_PEERCRED is because it's used for authenticating users on UNIX sockets, but I guess that's just a technical detail and it probably shouldn't be emphasized so much.

qknight commented 6 years ago

i've basically updated all documentations in https://github.com/nixcloud/nixcloud-webservices and i will finish with the database related parts soon.

aszlig commented 6 years ago

@leenaars: Improved the documentation a bit more, see 894e69fd22bf8be9cb2ae161a55b5a73c337e0a1 and ba8ae62dd78bf810a3d46fbd4c3bbab0f8b34a0b.