Allow user to configure more variables for IRC server connection (e.g. port, SSL certs, etc.) #113
Comments
|
I mean the variables you can see in |
|
@alcir Currently there is not a way to specify these things in Teleirc. This is a good candidate issue for v1.4. We'll review issues for the next sprint once v1.3 is released. |
jwflory
changed the title
jwflory
added
improvement
|
Discussed in 2019-03-02 developer meeting. This ticket was accepted for the v1.4 sprint. We agreed this is a high-priority feature because it makes the bot more useful for more people. The implementation should be straightforward. I plan to work on this during the March sprint. |
|
Uhh, actually @Tjzabel meant to close issue 112 with that commit, not this PR. Reopening. |
|
@jwflory thanks for the catch! |
|
Discussed in 2019-03-30 Teleirc developer meeting. I plan to do research this week for this ticket. I hope to have an idea of what to include and change for this by the next developer meeting on April 6th. I hope to have a final implementation by April 13th. I left the final week open in case of delays before the end of the v1.4 window on April 20th. |
|
Discussed during 2019-04-06 developer meeting. I have no major updates yet. Still planning to get this done in the next week. |
|
I'm caught up in some of our other work for our new logo and planning our presence at the Imagine RIT festival this month. I suspect I will not have time to work on this before the end of the Spring 2019 semester, but I will try to do what I can. |
|
@Tjzabel No worries. I am equally guilty of doing the same at times too. 😂 |
jwflory
added
IRC
|
@RITlug/teleirc-developers-commit-access Any thoughts on this from a v2.0.0 perspective? |
|
@jwflory I think having feature parity with where we currently stand is good enough. What other specific IRC features are part of the closing criteria? If they don't take a lot of time to implement, I am okay with adding this to the v2.0 release |
|
|
Discussed in 2020-10-11 meeting. I'm going to work on this one for this sprint. This will be my first code contribution to the v2 branch, and first time really getting into Go… so let's see where this goes. 😉 |
This commit reworks the IRC-side configuration options to support new parameters and configuration options: * **IRC_BOT_NAME**: IRC bot nick. Already existed, but now better documentation alongside other confusingly-named variables. * **IRC_BOT_REALNAME**: `REALNAME` field support. Allows freeform text. Added bot advertisement as a default option if left unset. * **IRC_BOT_IDENT**: Seldom used, but occasionally useful ident field. Overridden if NickServ credentials provided. * **IRC_NICKSERV_USER**: Explicitly set a NickServ username for a bot. Previously used the `IRC_BOT_NAME`, but those are not always identical in all situations. This commit also reworks the `env.example` file to better organize all IRC options, in addition to adding the new ones. I also expanded and reworked the config file glossary in the docs. This Pull Request does not implement tests, but I would like to ask to follow up on this in a subsequent Pull Request, preferably during the upcoming testing sprint. Fixes RITlug#113. cc: @alcir Signed-off-by: Justin W. Flory (he/him) <[email protected]>
This commit reworks the IRC-side configuration options to support new parameters and configuration options: * **IRC_BOT_NAME**: IRC bot nick. Already existed, but now better documentation alongside other confusingly-named variables. * **IRC_BOT_REALNAME**: `REALNAME` field support. Allows freeform text. Added bot advertisement as a default option if left unset. * **IRC_BOT_IDENT**: Seldom used, but occasionally useful ident field. Overridden if NickServ credentials provided. * **IRC_NICKSERV_USER**: Explicitly set a NickServ username for a bot. Previously used the `IRC_BOT_NAME`, but those are not always identical in all situations. This commit also reworks the `env.example` file to better organize all IRC options, in addition to adding the new ones. I also expanded and reworked the config file glossary in the docs. This Pull Request does not implement tests, but I would like to ask to follow up on this in a subsequent Pull Request, preferably during the upcoming testing sprint. Fixes RITlug#113. cc: @alcir Signed-off-by: Justin W. Flory (he/him) <[email protected]>
|
Fixed in Pull Request #355. |
|
@alcir Keep an eye out for this feature in v2.1.0 coming within the next week. |
Summary
Allow user to configure more parts of the IRC server connection (e.g. server port, using self-signed TLS certs, etc.)
Background
IRC servers are a wild world. Everyone can do things a little bit differently or deploy their network in a different way. Most of the current developers run the bot on Freenode, so we haven't thought about other bots as much. However, to make the bot more useful for more people, more options should be opened up for configuration for those who need it.
Details
Implementation should be straightforward. New env variables should be created for the following:
These env variables should be used when negotiating the connection to the IRC server, instead of using hard-coded defaults. For our purposes, we can ship the Freenode defaults in our
env.examplefile.Outcome
More people can use the bot on a range of different IRC networks, outside of only Freenode
Original comment:
There is a way to specify IRC server port as well as SSL self signed certificate or turning on debug in the .env file or as environment variables?
The text was updated successfully, but these errors were encountered: