Don't query default homeurl over the internet on first launch #210

Open
opened 2021-04-26 20:20:44 +00:00 by taowa · 2 comments

Hiya,

I noticed when I first installed and ran bombadillo that the user-guide is retreived over gopher. Since there's no default configuration that can be fiddled with by a user, that makes it difficult to not navigate to it by default. I don't have any overt objections to an online user-guide, but do think a user should either be asked first, or that the first thing they see should not make a request over the internet.

I've submitted a patch for Debian here, it just opens a local file that I created from snippets of the user-guide instead.

Thanks!
Taowa

Hiya, I noticed when I first installed and ran bombadillo that the user-guide is retreived over gopher. Since there's no default configuration that can be fiddled with by a user, that makes it difficult to not navigate to it by default. I don't have any overt objections to an online user-guide, but do think a user should either be asked first, or that the first thing they see should not make a request over the internet. I've submitted a patch for Debian [here](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=987628), it just opens a local file that I created from snippets of the user-guide instead. Thanks! Taowa
Owner

Hi Taowa,
Thanks for writing in (both to debian and myself). I 100% agree that this change is very much in-line with the goals of the project and should have been something I thought about earlier. The solution you provided is simple and should work well. Given that the net based documentation is hosted from my home on an rpi0 a switch to more reliable access is also a plus.

I took a look at the link. I'm not too familiar with debian's processes or how packaging works, but the change looks right. I did not see a change to the makefile. I assume that would be because the debian package goes about the build another way? If that is correct then I would likely just need to update the makefile to install the new file to the /usr/local/share/ space and get the new file under version control on my end.

There is something in the file that is not currently accurate: the part about client certificates. They were removed as a feature a few versions ago. Keeping up with best practices turned out to be a bigger load than I wanted to follow for a feature so rarely used. Since you sai dyou adapted the text from the website, that means I likely need to go update it there to remove that text (which I will try to do tonight).

I have another feature I am wanting to merge into a release soon, so I will likely combine these changes as a part of that release. Thanks again for your work on this!

Hi Taowa, Thanks for writing in (both to debian and myself). I 100% agree that this change is very much in-line with the goals of the project and should have been something I thought about earlier. The solution you provided is simple and should work well. Given that the net based documentation is hosted from my home on an rpi0 a switch to more reliable access is also a plus. I took a look at the link. I'm not too familiar with debian's processes or how packaging works, but the change looks right. I did not see a change to the makefile. I assume that would be because the debian package goes about the build another way? If that is correct then I would likely just need to update the makefile to install the new file to the `/usr/local/share/` space and get the new file under version control on my end. There is something in the file that is not currently accurate: the part about client certificates. They were removed as a feature a few versions ago. Keeping up with best practices turned out to be a bigger load than I wanted to follow for a feature so rarely used. Since you sai dyou adapted the text from the website, that means I likely need to go update it there to remove that text (which I will try to do tonight). I have another feature I am wanting to merge into a release soon, so I will likely combine these changes as a part of that release. Thanks again for your work on this!
Author

Hi,

So debian packaging is a bit odd sometimes, but what I'm doing is using the debian/install mechanism to tell it to copy an arbitary file to an arbitrary place on disk. In the next release I can suggest to the maintainer that they copy the updated manual verbatim so as to not confuse people re: client certs.

As for where to install it, /usr/share/doc is the right place for system installed documentation in debian, but that obviously doesn't carry to a user that's installing it themselves. I'm personally of the opinion that you should put it anywhere reasonable (/usr/local/share sounds perfectly reasonable to me), and that it's up to a package maintainer to sort it out themselves, but that's easy to say given that I don't maintain the package ;). I've linked the maintainer to this issue, though, and I figure that if they have anything to say they'll do so!

Thanks for your prompt reply and for all your work to create bombadillo!

Taowa

Hi, So debian packaging is a bit odd sometimes, but what I'm doing is using the debian/install mechanism to tell it to copy an arbitary file to an arbitrary place on disk. In the next release I can suggest to the maintainer that they copy the updated manual verbatim so as to not confuse people re: client certs. As for where to install it, /usr/share/doc is the right place for system installed documentation in debian, but that obviously doesn't carry to a user that's installing it themselves. I'm personally of the opinion that you should put it anywhere reasonable (/usr/local/share sounds perfectly reasonable to me), and that it's up to a package maintainer to sort it out themselves, but that's easy to say given that I don't maintain the package ;). I've linked the maintainer to this issue, though, and I figure that if they have anything to say they'll do so! Thanks for your prompt reply and for all your work to create bombadillo! Taowa
Sign in to join this conversation.
No Milestone
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: sloum/bombadillo#210
No description provided.