The last time this section was updated (or that someone remembered to update
the date her) is: **28 Feb 2020**. The current ZNC admin is pastly. Find him on
IRC or at pastly@torproject.org if you need help.
You need:
- your ZNC username. e.g. `jacob`. For simplicity, the ZNC admin should have
made sure this is the same as your IRC nick
- your existing ZNC password. e.g. `VTGdtSgsQYgJ`
- a new password
### Changing your ZNC password
If you know your existing one, you can do this yourself without the ZNC admin.
Given the assumptions baked into the rest of this document, the correct URL to
visit in a browser is `https://ircbouncer.torproject.org:2001/`.
- log in with your ZNC username and password
- click *Your Settings* in the right column menu
- enter your password in the two boxes at the top of the page labeled
*Password* and *Confirm Password*
- scroll all the way down and click *Save*
Done. You will now need to remember this new password instead of the old one.
### Connecting to ZNC from an IRC client
Every IRC client is a little different. This section is going to tell you the
information you need to know as opposed to exactly what you need to do with it.
- For a nick, use your desired nick. The assumption in this document is
`jacob`. Leave alternate nicks blank, or if you must, add an increasing
number of underscores to your desired nick for them: `jacob_`, `jacob__` ...
- For the server or hostname, the assumption in this document is
`ircbouncer.torproject.org`.
- Server port is 2001 based on the assumption blah blah blah
- Use SSL/TLS
- For a server password or simply password (**not a nickserv password**: that's
different and unnecessary) use `jacob/oftc:VTGdtSgsQYgJ`.
That should be everything you need to know. If you have trouble, ask your ZNC
admin for help or find someone who knows IRC. The ZNC admin is probably the
better first stop.
# Howto
We do not operate the OFTC network. The public support channel for
...
...
@@ -36,116 +83,7 @@ The new IRC server has been setup with the `roles::ircbox` by weasel
machine. This role simply sets up the machine as a "shell server"
(`roles::shell`) and installs `irssi`.
## SLA
No specific SLA has been set for this service
## Design
Just a regular Debian server with users from LDAP.
## Issues
No specific project has been created to track issues.
# Discussion
This page was originally created to discuss the implementation of
"bouncer" services for other staff. While many people run IRC clients
on the server over an SSH connexion, this is inconvenient for people
less familiar with the commandline.
It was therefore suggested we evaluate other systems to allow users to
have more "persistence" online without having to overcome the
"commandline" hurdle.
## Goals
### Must have
* user-friendly way to stay connected to IRC
### Nice to have
* web interface?
* LDAP integration?
### Non-Goals
* replacing IRC (let's not go there please)
## Approvals required
Maybe checking with TPA before setting up a new service, if any.
## Proposed Solution
Not decided yet. Possible options:
* status quo: "everyone for themselves" on the shell server, znc ran
by pastly on their own infra
* services admin: pastly runs the znc service for tpo people inside
tpo infra
* TPA runs znc bouncer
* alternative clients (weechat, lounge, kiwiirc)
* irccloud
## Cost
Staff. Existing hardware resources can be reused.
## Alternatives considered
* [irssi](https://irssi.org/) in some terminal multiplexer like [tmux](https://github.com/tmux/tmux) [screen](https://www.gnu.org/software/screen/)
or [dtach](https://irssi.org/)
* [weechat](https://weechat.org/) in the same or with another [interface](https://weechat.org/about/interfaces/) like
[web (Glowbear)](https://www.glowing-bear.org/), [Android](https://github.com/ubergeek42/weechat-android) or [iOS](https://github.com/mhoran/weechatRN)
* [lounge](https://thelounge.chat/) webchat (nodejs, not packaged in Debian)
* [ZNC][], a [bouncer](http://en.wikipedia.org/wiki/BNC_%28software%29#IRC), currently ran by @pastly on their own
infrastructure for some tpo people
* a Matrix gateway like [Riot.IM](https://about.riot.im/)
* [KiwiIRC](https://kiwiirc.com/), both a service and a web app we could run
[ZNC]: https://wiki.znc.in/ZNC
### Discarded alternatives
Most other alternatives have been discarded because they do not work
with IRC and we do not wish to move away from that platform just
yet. Other projects (like [qwebirc](https://thelounge.chat/)) were discarded because they do
The sysadmin hasn't opened any ports for us yet and we haven't configured ZNC
to use TLS yet. Luckily we can still access the web interface securely with a
...
...
@@ -416,7 +354,7 @@ from my laptop to chives over which it will forward all traffic to
So now I can visit in a browser on my laptop `http://127.0.0.1:2000` and gain
access to ZNC's web interface securely.
### Add TLS listener for ZNC
#### Add TLS listener for ZNC
Log in to the web interface using the username and password you created during
the initial ZNC config creation.
...
...
@@ -432,7 +370,7 @@ For listen ports, add:
Click *Add* and ZNC will open a TLS listener on 2001.
### Make ZNC reachable without tricks
#### Make ZNC reachable without tricks
- Ask your friendly neighborhood Tor sysadmin to allow inbound 2001 in the
firewall.
...
...
@@ -546,49 +484,112 @@ identifying
If there is no problem, the ZNC admin is done.
# Using ZNC as a User
## SLA
The last time this section was updated (or that someone remembered to update
the date her) is: **28 Feb 2020**. The current ZNC admin is pastly. Find him on
IRC or at pastly@torproject.org if you need help.
No specific SLA has been set for this service
You need:
## Design
- your ZNC username. e.g. `jacob`. For simplicity, the ZNC admin should have
made sure this is the same as your IRC nick
- your existing ZNC password. e.g. `VTGdtSgsQYgJ`
- a new password
Just a regular Debian server with users from LDAP.
## Changing your ZNC password
## Issues
If you know your existing one, you can do this yourself without the ZNC admin.
No specific project has been created to track issues.
Given the assumptions baked into the rest of this document, the correct URL to
visit in a browser is `https://ircbouncer.torproject.org:2001/`.
# Discussion
- log in with your ZNC username and password
- click *Your Settings* in the right column menu
- enter your password in the two boxes at the top of the page labeled
*Password* and *Confirm Password*
- scroll all the way down and click *Save*
This page was originally created to discuss the implementation of
"bouncer" services for other staff. While many people run IRC clients
on the server over an SSH connexion, this is inconvenient for people
less familiar with the commandline.
Done. You will now need to remember this new password instead of the old one.
It was therefore suggested we evaluate other systems to allow users to
have more "persistence" online without having to overcome the
"commandline" hurdle.
## Connecting to ZNC from an IRC client
## Goals
Every IRC client is a little different. This section is going to tell you the
information you need to know as opposed to exactly what you need to do with it.
### Must have
- For a nick, use your desired nick. The assumption in this document is
`jacob`. Leave alternate nicks blank, or if you must, add an increasing
number of underscores to your desired nick for them: `jacob_`, `jacob__` ...
- For the server or hostname, the assumption in this document is
`ircbouncer.torproject.org`.
- Server port is 2001 based on the assumption blah blah blah
- Use SSL/TLS
- For a server password or simply password (**not a nickserv password**: that's
different and unnecessary) use `jacob/oftc:VTGdtSgsQYgJ`.
* user-friendly way to stay connected to IRC
### Nice to have
* web interface?
* LDAP integration?
### Non-Goals
* replacing IRC (let's not go there please)
## Approvals required
Maybe checking with TPA before setting up a new service, if any.
## Proposed Solution
Not decided yet. Possible options:
* status quo: "everyone for themselves" on the shell server, znc ran
by pastly on their own infra
* services admin: pastly runs the znc service for tpo people inside
tpo infra
* TPA runs znc bouncer
* alternative clients (weechat, lounge, kiwiirc)
* irccloud
## Cost
Staff. Existing hardware resources can be reused.
## Alternatives considered
* [irssi](https://irssi.org/) in some terminal multiplexer like [tmux](https://github.com/tmux/tmux) [screen](https://www.gnu.org/software/screen/)
or [dtach](https://irssi.org/)
* [weechat](https://weechat.org/) in the same or with another [interface](https://weechat.org/about/interfaces/) like
[web (Glowbear)](https://www.glowing-bear.org/), [Android](https://github.com/ubergeek42/weechat-android) or [iOS](https://github.com/mhoran/weechatRN)
* [lounge](https://thelounge.chat/) webchat (nodejs, not packaged in Debian)
* [ZNC][], a [bouncer](http://en.wikipedia.org/wiki/BNC_%28software%29#IRC), currently ran by @pastly on their own
infrastructure for some tpo people
* a Matrix gateway like [Riot.IM](https://about.riot.im/)
* [KiwiIRC](https://kiwiirc.com/), both a service and a web app we could run
[ZNC]: https://wiki.znc.in/ZNC
### Discarded alternatives
Most other alternatives have been discarded because they do not work
with IRC and we do not wish to move away from that platform just
yet. Other projects (like [qwebirc](https://thelounge.chat/)) were discarded because they do
