nixcloud-webservices icon indicating copy to clipboard operation
nixcloud-webservices copied to clipboard

Documentation for database abstraction

Open leenaars opened this issue 6 years ago • 6 comments

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.

leenaars avatar Feb 28 '18 16:02 leenaars

Does this help?

aszlig avatar Mar 01 '18 03:03 aszlig

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).

leenaars avatar Mar 02 '18 09:03 leenaars

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

aszlig avatar Mar 02 '18 14:03 aszlig

@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.

aszlig avatar Mar 02 '18 14:03 aszlig

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

qknight avatar Mar 07 '18 02:03 qknight

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

aszlig avatar Apr 10 '18 08:04 aszlig