Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
biboumi
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
88
Issues
88
List
Boards
Labels
Service Desk
Milestones
Merge Requests
7
Merge Requests
7
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Operations
Operations
Incidents
Environments
Packages & Registries
Packages & Registries
Container Registry
Analytics
Analytics
CI / CD
Repository
Value Stream
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
louiz’
biboumi
Commits
06d5a5a3
Commit
06d5a5a3
authored
Aug 11, 2016
by
louiz’
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Document the new behaviour to address nicknames, and add to changelog
parent
0d2dd71d
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
32 additions
and
36 deletions
+32
-36
CHANGELOG.rst
CHANGELOG.rst
+7
-0
doc/biboumi.1.rst
doc/biboumi.1.rst
+25
-36
No files found.
CHANGELOG.rst
View file @
06d5a5a3
Version 4.0
Version 4.0
===========
===========
- The separator between the IRC nickname and the IRC server is now '%'
instead of '!'. This makes things simpler (only one separator to
remember). The distinction between a JID refering to a channel and a JID
refering to a nickname is based on the first character (# or & by
default, but this can be customized by the server with the ISUPPORT
extension)
Version 3.0 - 2016-08-03
Version 3.0 - 2016-08-03
========================
========================
...
...
doc/biboumi.1.rst
View file @
06d5a5a3
...
@@ -86,16 +86,13 @@ irc.example.org), then biboumi will enforce the connexion to that IRC
...
@@ -86,16 +86,13 @@ irc.example.org), then biboumi will enforce the connexion to that IRC
server only. This means that a JID like "#chan@biboumi.example.com" must
server only. This means that a JID like "#chan@biboumi.example.com" must
be used instead of "#chan%irc.example.org@biboumi.example.com". In that
be used instead of "#chan%irc.example.org@biboumi.example.com". In that
mode, the virtual channel (see `Connect to an IRC server`_) is not
mode, the virtual channel (see `Connect to an IRC server`_) is not
available and you still need to use the ! separator to send message to an
available. The '%' character loses any meaning in the JIDs. It can appear
IRC user (for example "foo!@biboumi.example.com" to send a message to
in the JID but will not be interpreted as a separator (thus the JID
foo), although the in-room JID still work as expected
"#channel%hello@biboumi.example.com" points to the channel named
("#channel@biboumi.example.com/Nick"). On the other hand, the '%' lose
"#channel%hello" on the configured IRC server) This option can for example
any meaning. It can appear in the JID but will not be interpreted as a
be used by an administrator that just wants to let their users join their own
separator (thus the JID "#channel%hello@biboumi.example.com" points to the
IRC server using an XMPP client, while forbidding access to any other IRC
channel named "#channel%hello" on the configured IRC server) This option
server.
can for example be used by an administrator that just wants to let their
users join their own IRC server using an XMPP client, while forbidding
access to any other IRC server.
realname_customization
realname_customization
----------------------
----------------------
...
@@ -201,26 +198,21 @@ the domain served by biboumi (the part after the ``@``, biboumi.example.com in
...
@@ -201,26 +198,21 @@ the domain served by biboumi (the part after the ``@``, biboumi.example.com in
the examples), and the local part (the part before the ``@``) depends on the
the examples), and the local part (the part before the ``@``) depends on the
concerned entity.
concerned entity.
IRC channels have a local part formed like this:
IRC channels
and IRC users
have a local part formed like this:
``
channel_
name`` % ``irc_server``.
``name`` % ``irc_server``.
If the IRC channel you want to adress starts with the ``'#'`` character (or an
``name`` can be a channel name or an user nickname. The distinction between
other character, announced by the IRC server, like ``'&'``, ``'+'`` or ``'!'``),
the two is based on the first character: by default, if the name starts with
then you must include it in the JID. Some other gateway implementations, as
``'#'`` or ``'&'`` (but this can be overridden by the server, using the
well as some IRC clients, do not require them to be started by one of these
ISUPPORT extension) then it’s a channel name, otherwise this is a nickname.
characters, adding an implicit ``'#'`` in that case. Biboumi does not do that
because this gets confusing when trying to understand the difference between
the channels *#foo*, and *##foo*. Note that biboumi does not use the
presence of these special characters to identify an IRC channel, only the
presence of the separator `%` is used for that.
The channel name can also be empty (for example ``%irc.example.com``), in that
As a special case, the channel name can also be empty (for example
case this represents the virtual channel provided by biboumi. See *Connect
``%irc.example.com``), in that case this represents the virtual channel
to an IRC server* for more details.
provided by biboumi. See *Connect
to an IRC server* for more details.
There is two ways to address an IRC user, using a local part like this:
There is two ways to address an IRC user, using a local part like this:
``nickname``
! ``irc_server``
``nickname``
% ``irc_server`` or by using the in-room address of the
or by using the in-room address of the
participant, like this:
participant, like this:
``channel_name`` % ``irc_server`` @ ``biboumi.example.com`` / ``Nickname``
``channel_name`` % ``irc_server`` @ ``biboumi.example.com`` / ``Nickname``
The second JID is available only to be compatible with XMPP clients when the
The second JID is available only to be compatible with XMPP clients when the
...
@@ -232,11 +224,11 @@ IRC nicknames are case-insensitive, this means that the nicknames toto,
...
@@ -232,11 +224,11 @@ IRC nicknames are case-insensitive, this means that the nicknames toto,
Toto, tOtO and TOTO all represent the same IRC user. This means you can
Toto, tOtO and TOTO all represent the same IRC user. This means you can
talk to the user toto, and this will work.
talk to the user toto, and this will work.
Also note that some IRC nicknames
may contain characters that are not
Also note that some IRC nicknames
or channels may contain characters that are
allowed in the local part of a JID (for example '@'). If you need to send a
not
allowed in the local part of a JID (for example '@'). If you need to send a
message to a nick containing such a character, you
have to
use a jid like
message to a nick containing such a character, you
can
use a jid like
``%irc.example.com@biboumi.example.com/AnnoyingNickn@me``, because the JID
``%irc.example.com@biboumi.example.com/AnnoyingNickn@me``, because the JID
``AnnoyingNickn@me
!
irc.example.com@biboumi.example.com`` would not work.
``AnnoyingNickn@me
%
irc.example.com@biboumi.example.com`` would not work.
Examples:
Examples:
...
@@ -244,7 +236,7 @@ Examples:
...
@@ -244,7 +236,7 @@ Examples:
irc.example.com IRC server, and this is served by the biboumi instance on
irc.example.com IRC server, and this is served by the biboumi instance on
biboumi.example.com
biboumi.example.com
* ``toto
!
irc.example.com@biboumi.example.com`` is the IRC user named toto, or
* ``toto
%
irc.example.com@biboumi.example.com`` is the IRC user named toto, or
TotO, etc.
TotO, etc.
* ``irc.example.com@biboumi.example.com`` is the IRC server irc.example.com.
* ``irc.example.com@biboumi.example.com`` is the IRC server irc.example.com.
...
@@ -255,9 +247,6 @@ Examples:
...
@@ -255,9 +247,6 @@ Examples:
Note: Some JIDs are valid but make no sense in the context of
Note: Some JIDs are valid but make no sense in the context of
biboumi:
biboumi:
* ``!irc.example.com@biboumi.example.com`` is the empty-string nick on the
irc.example.com server. It makes no sense to try to send messages to it.
* ``#test%@biboumi.example.com``, or any other JID that does not contain an
* ``#test%@biboumi.example.com``, or any other JID that does not contain an
IRC server is invalid. Any message to that kind of JID will trigger an
IRC server is invalid. Any message to that kind of JID will trigger an
error, or will be ignored.
error, or will be ignored.
...
@@ -286,7 +275,7 @@ channel ``#foo`` on the server ``irc.example.com``, but you need to authenticate
...
@@ -286,7 +275,7 @@ channel ``#foo`` on the server ``irc.example.com``, but you need to authenticate
to a bot of the server before you’re allowed to join it, you can first join
to a bot of the server before you’re allowed to join it, you can first join
the room ``%irc.example.com@biboumi.example.com`` (this will effectively
the room ``%irc.example.com@biboumi.example.com`` (this will effectively
connect you to the IRC server without joining any room), then send your
connect you to the IRC server without joining any room), then send your
authentication message to the user ``bot
!
irc.example.com@biboumi.example.com``
authentication message to the user ``bot
%
irc.example.com@biboumi.example.com``
and finally join the room ``#foo%irc.example.com@biboumi.example.com``.
and finally join the room ``#foo%irc.example.com@biboumi.example.com``.
Channel messages
Channel messages
...
@@ -333,7 +322,7 @@ Private messages are handled differently on IRC and on XMPP. On IRC, you
...
@@ -333,7 +322,7 @@ Private messages are handled differently on IRC and on XMPP. On IRC, you
talk directly to one server-user: toto on the channel #foo is the same user
talk directly to one server-user: toto on the channel #foo is the same user
as toto on the channel #bar (as long as these two channels are on the same
as toto on the channel #bar (as long as these two channels are on the same
IRC server). By default you will receive private messages from the “global”
IRC server). By default you will receive private messages from the “global”
user (aka nickname
!
irc.example.com@biboumi.example.com), unless you
user (aka nickname
%
irc.example.com@biboumi.example.com), unless you
previously sent a message to an in-room participant (something like
previously sent a message to an in-room participant (something like
\#test%irc.example.com@biboumi.example.com/nickname), in which case future
\#test%irc.example.com@biboumi.example.com/nickname), in which case future
messages from that same user will be received from that same “in-room” JID.
messages from that same user will be received from that same “in-room” JID.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment