Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation for database abstraction #11

Open
leenaars opened this issue Feb 28, 2018 · 6 comments
Open

Documentation for database abstraction #11

leenaars opened this issue Feb 28, 2018 · 6 comments
Assignees
@aszlig

Comments

@leenaars
Copy link
Contributor

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
Copy link
Collaborator

aszlig commented Mar 1, 2018

Does this help?

@aszlig aszlig self-assigned this Mar 1, 2018
@leenaars
Copy link
Contributor Author

leenaars commented Mar 2, 2018 •
edited
Loading

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
Copy link
Collaborator

aszlig commented Mar 2, 2018

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

aszlig added a commit that referenced this issue Mar 2, 2018
@aszlig
web/services/README: Move to documentation/
433ab9c 
My initial thought would be that developers would find this README in
the services directory and it's displayed directly when browsing that
directory on GitHub.

However, I think most users would probably look into documentation to
find these things and not browse the services directory on GitHub.

If we still want it to show up in services/, we could still do a symlink
I guess (not sure whether GitHub would display it correctly).

Signed-off-by: aszlig <aszlig@nix.build>
Issue: #11
@aszlig
Copy link
Collaborator

aszlig commented Mar 2, 2018

@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
Copy link
Member

qknight commented Mar 7, 2018

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

aszlig added a commit that referenced this issue Apr 10, 2018
@aszlig
doc: Mark SO_PEERCRED as a technical detail
894e69f 
As @Leenars writes in [1]:

> Some of the options might not really clear for implementers yet, e.g.
> what do they need to do with SO_PEERCRED, socketPath, etc.

[1]: #11 (comment)

Signed-off-by: aszlig <aszlig@nix.build>
@aszlig
Copy link
Collaborator

aszlig commented Apr 10, 2018

@leenaars: Improved the documentation a bit more, see 894e69f and ba8ae62.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aszlig aszlig

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@qknight @aszlig @leenaars