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.

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

Add docs for connecting mathesar to local db #2819

Merged
merged 2 commits into from Apr 17, 2023
Merged

Conversation

Anish9901
Copy link
Member

Fixes #2571

Documentation about how to connect Mathesar to a Postgres DB running locally on a host machine (i.e. DB outside the docker container).

There doesn't seem to be an elegant approach we can take for connecting Mathesar to a host db without fiddling around with a bunch of internal Postgres files on the host system namely the postgresql.conf & pg_hba.conf. If someone really wants to connect Mathesar to their local db the steps are clearly documented in this PR.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@Anish9901 Anish9901 added the pr-status: review A PR awaiting review label Apr 15, 2023
@Anish9901 Anish9901 added this to the v0.1.2 milestone Apr 15, 2023
Copy link
Contributor

@mathemancer mathemancer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The steps are clear enough, and worked for me. I think this makes some dubious assumptions, however, and it's oddly placed in the overall documentation.

  • If someone is just following the install script, they will get blocked up before making it to a running system (if they want to connect)
  • I'm not sure about the placement in the navigation on the left.

I think this needs to be linked from the main install via docker compose page with some kind of 'note' or 'warning' style, as some kind of optional prerequisites specific to this type of installation. Will it be possible to figure out the network settings before running the installer? If not, that makes things even more difficult.

@rajatvijay rajatvijay assigned Anish9901 and unassigned mathemancer Apr 17, 2023
@rajatvijay rajatvijay added pr-status: revision A PR awaiting follow-up work from its author after review and removed pr-status: review A PR awaiting review labels Apr 17, 2023
Copy link
Contributor

@mathemancer mathemancer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this looks good. Thank you!

@mathemancer mathemancer added this pull request to the merge queue Apr 17, 2023
Merged via the queue into develop with commit 35da619 Apr 17, 2023
13 checks passed
@mathemancer mathemancer deleted the connecting-local-db branch April 17, 2023 13:40
@seancolsen
Copy link
Contributor

I happened to notice that this new docs page is in in the guide but not in the guide's nav menu. @Anish9901 can you edit docs/mkdocs.yml and add a link to this new page somewhere within nav? @mathemancer It would be good to check for this when reviewing PRs too.

@Anish9901
Copy link
Member Author

Anish9901 commented Apr 20, 2023

@seancolsen it was actually @mathemancer suggestion to not put the guide in the nav menu as it might confuse users and might lead them to not be able to complete the installation process using the install script which is a requirement for following the steps suggested in this guide.

@seancolsen
Copy link
Contributor

seancolsen commented Apr 20, 2023

Oh sorry -- I should have read his comment before making mine. Interesting. Having a page in the guide which is not in the nav menu feels very weird to me. Like, if you navigate to that page, you should be able to use the nav menu to understand your current context within the rest of the documentation and to navigate back to other pages. Publishing it outside the nav turns the page into a sort of dead end. It also makes the page harder for readers to find.

Having read Brent's comment a few times, I still don't understand the reason for not putting this in the nav -- I think maybe because I don't understand the docs content well enough. @mathemancer could we address your concerns by placing some sort of disclaimer at the top of this page?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-status: revision A PR awaiting follow-up work from its author after review
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Make Deployment Type 2 work with DBs on localhost
4 participants