CSCWiki - User contributions [en]

Club Hosting

2023-11-12T05:45:30Z

Lbahodi: his/her -> their

The Computer Science Club provides web hosting to other clubs free of charge. We host many club web sites. If you have a question about our hosting service, contact syscom at csclub dot uwaterloo dot ca or visit our office in MC 3036.

== Hosting Features ==

* 4 GB web space
* Scripting
** PHP (mod_fcgid)
** Perl (https://wiki.csclub.uwaterloo.ca/Web_Hosting#Dynamic_Sites)
** Python (https://wiki.csclub.uwaterloo.ca/Web_Hosting#Dynamic_Sites)
*** Django (https://wiki.csclub.uwaterloo.ca/Web_Hosting#Dynamic_Sites)
** Ruby (https://wiki.csclub.uwaterloo.ca/Web_Hosting#Dynamic_Sites)
* Databases
** [[MySQL]]

This is not an exhaustive list. Contact us if you want something not listed or installed.

== Getting Hosted ==

To get hosted, you need a '''club account''' and one '''user account''' for each person who will be updating the club's web site or other files.

The general process to get yourself an account on our systems to host your club website is:

1. Request a free club account on the CSC systems by emailing syscom@csclub.uwaterloo.ca from an official club email (an official club email is one that is posted on your website or Facebook page, for example). Something along the lines of "I am from the ActSci club and am the current webmaster. Can I be registered for a club account to access the ActSci website?" Include the WatIAM userids (Quest ID) of any club reps that should be authorized to manage the club account in your email.

2. For each club rep that needs access, an email needs to be sent to syscom with the following information, if they don't already have a CSC account:

* a scan or photograph copy of the rep's WatCard,
* their WatIAM userid, and
* their acknowledgement of having read, understood, and agreeing with our Machine Usage Agreement.

These can be sent in one email or separately.

3. Once syscom receives these, the users will be given permission to access your club website by adding you to your corresponding club group (for example, the actsci user group).

=== Club Account ===

Each club we host has a "club account" that owns and stores club resources. You can request a club account via email or in person. The club account:

* Is named after the club, possibly abbreviated.
* Has a home directory named /users/clubname, where club files are stored.
* Is not permitted to log in. You must use your own user account to login.

The Systems Committee will create club accounts when sent a request from the club's email address to syscom@csclub.uwaterloo.ca. Verification of the club's university affiliation may be required, for instance by contacting the Federation of Students or the club's faculty advisor.

=== User Accounts ===

Each user who needs access to the club account must have their own user account on our machines. There are two ways to get an account:

* Become a member of the Computer Science Club. Membership is $2.00 per term.
* Request a free "club representative" account. These accounts are to be used solely for managing the club account, and expire at the end of the term.

Club representatives can request renewal of their free accounts (for one or more terms) if they still need the account to manage the club account in future terms.

Your user account must also be authorized to change club files. Each club has a "club group" whose members may update the clubs files. We add (and remove) users to the group when we are asked to do so by the club exec. The exec must email the Systems Committee (syscom@csclub.uwaterloo.ca) from a club email address.

Any office staff member may create and renew both member and club representative accounts using [[ceo]]. Only Systems Committee members may modify club access lists.

== Accessing Club Resources ==

At this point, you have a user account and a club account, and need to get started with your web site. Before you can do anything, you need to log into our machines somehow.

=== Shell Access ===

To gain shell access to your site, you can:

* Log in using a terminal in the office
* Log in from anywhere using SSH. We discourage SSH'ing into our web server (caffeine), you should use a different general-use machine (like corn-syrup.csclub.uwaterloo.ca)

The club's files are stored in /users/clubname.

If you want, you can become the club user by typing "become_club clubname". This is not usually necessary, as the permissions should allow you to make changes as yourself.

=== SFTP File Access ===

You may access files stored on our servers, or upload new ones, via SFTP and SCP. If you are a Windows user you should use [http://winscp.net/ WinSCP] or a similar client with SFTP/SCP abilities. If you are using OS X you can use the sftp or scp Terminal commands, or you can install a graphical client such as [http://cyberduck.ch/ Cyberduck]. Similarly on GNU/Linux you can use the shell commands or a graphical client such as gftp.

== Services ==

=== Web Hosting ===

See [[Web Hosting]].

=== Databases ===

See [[MySQL]].

You can create a MySQL database yourself through [[ceo]] by following [[MySQL#Using_ceo|these instructions]].

== Some Clubs We Support ==

* Math Society
* Software Engineering Society
* WiCS (Women in Computer Science)
* UW Blockchain
* WARG (Waterloo Aerial Robotics Group)
* Rocketry
* Pure Math Club
* mathNEWS
* Badminton Club
* CSA (Chinese Students Association)
* HVZ (Humans vs. Zombies)
* Warriors Band
* WLSG (Waterloo Libre Software Group)
* Physics Club
* CSSA (Canadian Shooting Sports Association)
* CAPSI (Canadian Association of Pharmacy Students and Interns)
* CWC (Centre for Wireless Communications?)

[[Category:Services]]

How to IRC

2022-07-30T05:54:57Z

Lbahodi: Add section describing setup with emacs x erc.

Chat with us!

== The Lounge ==
We have a web UI for IRC at [https://chat.csclub.uwaterloo.ca The Lounge].
[[File:The_lounge_screenshot.png|alt=The Lounge screenshot of #csc channel|400px|thumbnail|A screen capture of the #csc channel, as seen from The Lounge web client]]
If you are a first-time IRC user, this is by far the easiest way to join.
The steps are (roughly):
<ol>
<li> Login using your CSC credentials. </li>
<li> Follow the prompts to join the Libera server (make sure TLS is enabled). </li>
<li> Type <code>/join #csc</code> </li>
<li> Say hi! </li>
</ol>

If you are a termcom member, you will need to join the #csc-termcom channel, which requires nick (nickname) registration. To do this, run the following commands in The Lounge (or any IRC client):
<pre>
/nick my_nickname
/msg NickServ REGISTER my_password my_email@example.com
</pre>
Fill in your nickname, password and email as appropriate. You will receive an email from Libera asking you to verify your email address.
Once you have done so, go back to The Lounge, go the Libera window, click on the three-dots button in the top right corner, and click "Edit this network". There, you can specify the nick and password which you just created.
== Mattermost ==
[[File:Mattermost-csc-sample.png|alt=Mattermost #csc screen capture, including a conversation between members of the channel|372x372px|right|thumbnail|A screen capture of the #csc channel, as seen from Mattermost desktop]]

[[File:Mattermost-phone-sample.jpg|alt=Mattermost android screenshot of #csc channel|362x362px|thumbnail|A screen capture of the #csc channel, as seen from Mattermost Android client]]
We self-host [https://mattermost.csclub.uwaterloo.ca/ Mattermost] now, it's easier to use if you're not familiar with IRC. If you know how to use IRC, we're #csc on libera.chat and there should be a #csc bridge that relays messages between #csc and our Mattermost instance.

Both #csc on libera.chat ([https://web.libera.chat/#csc Libera Webchat] or via IRC clients e.g. irssi, weechat) and ~csc on Mattermost are official channels to interact with CSC members!

=== Mattermost Setup ===

Make an account at [https://mattermost.csclub.uwaterloo.ca/signup_email our self-hosted Mattermost]. For username, you can put your questid (i.e. your CSC username), although you can always set your full name as it will appear in Mattermost.

The benefit of Mattermost over Slack and family is that Slack stores all your information on Slack's servers, wherever they are in the US. They do this so they can sell your data back to you (e.g. not allowing you to see old messages), but Slack is also closed-source even though it was derived from IRC. Mattermost is open-source and hosted on CSC servers.

For iOS users, Mattermost's mobile app is also a superior option if you wish to receive push notifications as it supports Apple's native push via iCloud/APN.

== Weechat ==

[[File:Glowing-bear-screencap.png|alt=glowing-bear screen capture of #csc IRC channel|right|thumbnail|450px|A screen capture of the #csc IRC channel, as seen from glowing-bear client]]

[[File:Weechat-Android-screenshot.png|alt=Weechat Android screen capture of #csc IRC channel|right|thumbnail|A screen capture of the #csc IRC channel, as seen from Weechat Android client]]

This method will establish a persistent IRC session that you can connect to with different clients. A [https://weechat.org/ weechat] server program running on a CSClub server will remain connected to IRC networks at all times, and simply connecting to your <code>weechat</code> server program will give you all the chat history upon connection.

To set up your <code>weechat</code> server program:
<ol>
<li>Log in to a CS Club general-use server, such as <code>neotame.csclub.uwaterloo.ca</code>, and run <code>weechat</code> in such a way that it will keep running after you log out.</li>

Replace ctdalek with your username:

<pre>
$ ssh ctdalek@neotame.csclub.uwaterloo.ca
$ screen -U weechat
</pre>

A "WeeChat" window should have opened up. Type the following commands into this window, replacing [yourpassword] with a password of your choice and [yourport] with a number in the range of [28100-28400]:

<pre>
/set relay.network.password [yourpassword]
/relay add weechat [yourport]
/save
</pre>

Once you have entered in all these commands, you don't need your terminal anymore. You can close your ssh window!

<li>Your personal WeeChat server is set up. Now connect to it using a pretty client:</li>

[http://www.glowing-bear.org/ glowing-bear] is a free and open source web-based weechat client. It works well as a desktop client, and on iOS. To connect using glowing-bear, fill in "Connection Settings" with <code>neotame.csclub.uwaterloo.ca</code>, <code>[yourport]</code>, and <code>[yourpassword]</code>. Make sure to use the <code>http</code> version of the website with this guide! <code>https</code> only works if you set up encryption. That's not covered here.

'''Recommended''': [https://play.google.com/store/apps/details?id=com.ubergeek42.WeechatAndroid Weechat Android] is a free and open source android <code>weechat</code> client. It gives notifications when your receive a direct message or your name is mentioned in one of the channels you are in. To connect using Weechat Android, fill in Settings > Connection with <code>neotame.csclub.uwaterloo.ca</code>, <code>[yourport]</code>, and <code>[yourpassword]</code>.

<li>Join the #csc IRC channel</li>

In your weechat client (e.g. glowing-bear or Weechat Android), switch to the 'Libera' tab and type:

<pre>
/server add libera irc.libera.chat/6697 -ssl -autoconnect
/set irc.server.libera.autojoin "#csc"
/save
/connect libera
</pre>

You're now connected to the main IRC network! Connected by an SSL connection, so you're super sneaky as well. Way to go.

Now, to join the CSC channel!

In your client, you'll now have two buffers that you can switch to. One is called "weechat" and the other is "libera".

Switch to the "libera" buffer and type:

/join #csc

Congratulations you win!

<li>Know some IRC commands</li>

Welcome to the channel! Go ahead and say something, like

<pre>
Good morning ctdalek http://www.total-knowledge.com/~ilya/mips/ugt.html
</pre>

If you want to privately message someone, use

<pre>
/q [nick] [optional message]
</pre>

which will open a new tab with that person. For example <code>/q pj2melan ping pong</code>.

If you want to join another channel, use
<pre> /join [channel]
</pre>

For example <code>/join #csc</code>.
</ol>
''Note about CSClub server restarts:'' If <code>neotame</code> or any server you're using to run the <code>weechat</code> program on is restarted for any reason (we'll email you if it does), Make sure to run <code>screen -U weechat</code> again to start your server. You won't have to reconfigure <code>weechat</code> (step 2) though.

=== Securing Glowing Bear - SSL/TLS Setup ===

With the default setup, when you log in to your <code>weechat</code> relay using a client such as glowing-bear or Weechat Android, ''your password is sent in the clear''. If you believe this to be a bad thing, follow these steps to enable SSL encryption between you and your <code>weechat</code> relay running on <code>neotame</code>.

<ol>
<li>Log in to <code>neotame.csclub.uwaterloo.ca</code> to generate an SSL certificate:

<pre>
$ ssh neotame.csclub.uwaterloo.ca
$ mkdir ~/.weechat/ssl
$ cd ~/.weechat/ssl
$ openssl req -nodes -newkey rsa:4096 -keyout relay.pem -x509 -days 365 -out relay.pem # Fill in the fields as it asks
$ exit
</pre>
</li>

<li>Tell <code>weechat</code> to use the new certificate you generated, and add a new relay with a different password (since your old password was likely compromised):

In your <code>weechat</code> client (glowing-bear, or Weechat Android), run

<pre>
/set relay.network.password [newpassword]
/relay sslcertkey
/relay del weechat
/relay add ssl.weechat [yourport]
</pre>
</li>

<li>Tell your client to connect to your relay using SSL:

For glowing-bear, refresh and simply check the "Encryption. Check settings for help." checkbox when logging in with your new password.

For Weechat Android, in Settings > Connection, change Connection type to WeeChat SSL and change your Relay password.
</li>

</ol>

Enjoy fully encrypted communication!

You might have warnings about untrusted certificates, but since you made the certificate yourself you can trust yourself and add required security exceptions.

== Quick SSH-based Setup ==

1. Open up an IRC client, i.e. <code>irssi</code>. Launch <code>irssi</code> in a screen session, which you
can return to later.

$ ssh neotame.csclub.uwaterloo.ca
$ screen -U irssi

2. In irssi, connect to the libera network and join our channel.

/server add -auto -net libera -ssl -ssl_verify irc.libera.chat 6697
/save
/connect libera
/join #csc

3. Please set your nickname to your Quest ID so we know who you are.

/nick $YOUR_QUEST_ID
/save

You can register your nickname on the libera network by messaging NickServ.

/msg NickServ REGISTER password email

4. Close your screen session, which you can return to later.

CTRL-A CTRL-D

5. Return to your screen session. You will have remained connected to the channel.

$ ssh neotame.csclub.uwaterloo.ca -t "screen -Urd"

== Emacs ==
If you are comfortable with Emacs, then you can also configure the editor to act as an IRC client via <code>erc</code>. For a quick introduction, you can run <code>M-x erc-tls</code>where you will be prompted for a server, a port (the defaults are correct), and a nickname. For a detailed overview of possible configuration options see the [https://www.emacswiki.org/emacs/ERC ERC Emacs Wiki]. To prettify the default display and for simiilar QOL changes, consider applying some of the configuration options from [https://systemcrafters.cc/live-streams/june-04-2021/ this guide] by System Crafters.

=== ZNC.el ===
To keep track of chat logs while your machine is powered down, consider setting up [[ZNC]] with the help of [https://www.emacswiki.org/emacs/ErcZNC ZNC.el].

= syscom =

To kick (and optionally ban) a user:

/cs op #<channel>
/mode #<channel> +b <nick_to_ban>
/kick <nick_to_kick>
/mode -o <your_nick>

If the user need not be banned you can skip the second line. If other accounts from the same user/host should be banned, replace <code>nick_to_ban/kick</code> with <code>nick!username@host</code>.

How to IRC

2022-07-30T05:17:00Z

Lbahodi: Restructure heading titles to group together client setups

= Overview of Clients =

== The Lounge ==
We have a web UI for IRC at [https://chat.csclub.uwaterloo.ca The Lounge].
[[File:The_lounge_screenshot.png|alt=The Lounge screenshot of #csc channel|400px|top|left|thumbnail|A screen capture of the #csc channel, as seen from The Lounge web client]]
If you are a first-time IRC user, this is by far the easiest way to join.
The steps are (roughly):
<ol>
<li> Login using your CSC credentials. </li>
<li> Follow the prompts to join the Libera server (make sure TLS is enabled). </li>
<li> Type <code>/join #csc</code> </li>
<li> Say hi! </li>
</ol>

If you are a termcom member, you will need to join the #csc-termcom channel, which requires nick (nickname) registration. To do this, run the following commands in The Lounge (or any IRC client):
<pre>
/nick my_nickname
/msg NickServ REGISTER my_password my_email@example.com
</pre>
Fill in your nickname, password and email as appropriate. You will receive an email from Libera asking you to verify your email address.
Once you have done so, go back to The Lounge, go the Libera window, click on the three-dots button in the top right corner, and click "Edit this network". There, you can specify the nick and password which you just created.
== Mattermost ==
We self-host [https://mattermost.csclub.uwaterloo.ca/ Mattermost] now, it's easier to use if you're not familiar with IRC. If you know how to use IRC, we're #csc on libera.chat and there should be a #csc bridge that relays messages between #csc and our Mattermost instance.

Both #csc on libera.chat ([https://web.libera.chat/#csc Libera Webchat] or via IRC clients e.g. irssi, weechat) and ~csc on Mattermost are official channels to interact with CSC members!

=== Mattermost Setup ===

[[File:Mattermost-phone-sample.jpg|alt=Mattermost android screenshot of #csc channel|362x362px|left|thumbnail|A screen capture of the #csc channel, as seen from Mattermost Android client]]
[[File:Mattermost-csc-sample.png|alt=Mattermost #csc screen capture, including a conversation between members of the channel|372x372px|right|thumbnail|A screen capture of the #csc channel, as seen from Mattermost desktop]]

Make an account at [https://mattermost.csclub.uwaterloo.ca/signup_email our self-hosted Mattermost]. For username, you can put your questid (i.e. your CSC username), although you can always set your full name as it will appear in Mattermost.

The benefit of Mattermost over Slack and family is that Slack stores all your information on Slack's servers, wherever they are in the US. They do this so they can sell your data back to you (e.g. not allowing you to see old messages), but Slack is also closed-source even though it was derived from IRC. Mattermost is open-source and hosted on CSC servers.

For iOS users, Mattermost's mobile app is also a superior option if you wish to receive push notifications as it supports Apple's native push via iCloud/APN.

== Weechat ==

[[File:Glowing-bear-screencap.png|alt=glowing-bear screen capture of #csc IRC channel|right|thumbnail|450px|A screen capture of the #csc IRC channel, as seen from glowing-bear client]]

[[File:Weechat-Android-screenshot.png|alt=Weechat Android screen capture of #csc IRC channel|right|thumbnail|A screen capture of the #csc IRC channel, as seen from Weechat Android client]]

This method will establish a persistent IRC session that you can connect to with different clients. A [https://weechat.org/ weechat] server program running on a CSClub server will remain connected to IRC networks at all times, and simply connecting to your <code>weechat</code> server program will give you all the chat history upon connection.

To set up your <code>weechat</code> server program:
<ol>
<li>Log in to a CS Club general-use server, such as <code>neotame.csclub.uwaterloo.ca</code>, and run <code>weechat</code> in such a way that it will keep running after you log out.</li>

Replace ctdalek with your username:

<pre>
$ ssh ctdalek@neotame.csclub.uwaterloo.ca
$ screen -U weechat
</pre>

A "WeeChat" window should have opened up. Type the following commands into this window, replacing [yourpassword] with a password of your choice and [yourport] with a number in the range of [28100-28400]:

<pre>
/set relay.network.password [yourpassword]
/relay add weechat [yourport]
/save
</pre>

Once you have entered in all these commands, you don't need your terminal anymore. You can close your ssh window!

<li>Your personal WeeChat server is set up. Now connect to it using a pretty client:</li>

[http://www.glowing-bear.org/ glowing-bear] is a free and open source web-based weechat client. It works well as a desktop client, and on iOS. To connect using glowing-bear, fill in "Connection Settings" with <code>neotame.csclub.uwaterloo.ca</code>, <code>[yourport]</code>, and <code>[yourpassword]</code>. Make sure to use the <code>http</code> version of the website with this guide! <code>https</code> only works if you set up encryption. That's not covered here.

'''Recommended''': [https://play.google.com/store/apps/details?id=com.ubergeek42.WeechatAndroid Weechat Android] is a free and open source android <code>weechat</code> client. It gives notifications when your receive a direct message or your name is mentioned in one of the channels you are in. To connect using Weechat Android, fill in Settings > Connection with <code>neotame.csclub.uwaterloo.ca</code>, <code>[yourport]</code>, and <code>[yourpassword]</code>.

<li>Join the #csc IRC channel</li>

In your weechat client (e.g. glowing-bear or Weechat Android), switch to the 'Libera' tab and type:

<pre>
/server add libera irc.libera.chat/6697 -ssl -autoconnect
/set irc.server.libera.autojoin "#csc"
/save
/connect libera
</pre>

You're now connected to the main IRC network! Connected by an SSL connection, so you're super sneaky as well. Way to go.

Now, to join the CSC channel!

In your client, you'll now have two buffers that you can switch to. One is called "weechat" and the other is "libera".

Switch to the "libera" buffer and type:

/join #csc

Congratulations you win!

<li>Know some IRC commands</li>

Welcome to the channel! Go ahead and say something, like

<pre>
Good morning ctdalek http://www.total-knowledge.com/~ilya/mips/ugt.html
</pre>

If you want to privately message someone, use

<pre>
/q [nick] [optional message]
</pre>

which will open a new tab with that person. For example <code>/q pj2melan ping pong</code>.

If you want to join another channel, use
<pre> /join [channel]
</pre>

For example <code>/join #csc</code>.
</ol>
''Note about CSClub server restarts:'' If <code>neotame</code> or any server you're using to run the <code>weechat</code> program on is restarted for any reason (we'll email you if it does), Make sure to run <code>screen -U weechat</code> again to start your server. You won't have to reconfigure <code>weechat</code> (step 2) though.

=== Securing Glowing Bear - SSL/TLS Setup ===

With the default setup, when you log in to your <code>weechat</code> relay using a client such as glowing-bear or Weechat Android, ''your password is sent in the clear''. If you believe this to be a bad thing, follow these steps to enable SSL encryption between you and your <code>weechat</code> relay running on <code>neotame</code>.

<ol>
<li>Log in to <code>neotame.csclub.uwaterloo.ca</code> to generate an SSL certificate:

<pre>
$ ssh neotame.csclub.uwaterloo.ca
$ mkdir ~/.weechat/ssl
$ cd ~/.weechat/ssl
$ openssl req -nodes -newkey rsa:4096 -keyout relay.pem -x509 -days 365 -out relay.pem # Fill in the fields as it asks
$ exit
</pre>
</li>

<li>Tell <code>weechat</code> to use the new certificate you generated, and add a new relay with a different password (since your old password was likely compromised):

In your <code>weechat</code> client (glowing-bear, or Weechat Android), run

<pre>
/set relay.network.password [newpassword]
/relay sslcertkey
/relay del weechat
/relay add ssl.weechat [yourport]
</pre>
</li>

<li>Tell your client to connect to your relay using SSL:

For glowing-bear, refresh and simply check the "Encryption. Check settings for help." checkbox when logging in with your new password.

For Weechat Android, in Settings > Connection, change Connection type to WeeChat SSL and change your Relay password.
</li>

</ol>

Enjoy fully encrypted communication!

You might have warnings about untrusted certificates, but since you made the certificate yourself you can trust yourself and add required security exceptions.

== Quick SSH-based Setup ==

1. Open up an IRC client, i.e. <code>irssi</code>. Launch <code>irssi</code> in a screen session, which you
can return to later.

$ ssh neotame.csclub.uwaterloo.ca
$ screen -U irssi

2. In irssi, connect to the libera network and join our channel.

/server add -auto -net libera -ssl -ssl_verify irc.libera.chat 6697
/save
/connect libera
/join #csc

3. Please set your nickname to your Quest ID so we know who you are.

/nick $YOUR_QUEST_ID
/save

You can register your nickname on the libera network by messaging NickServ.

/msg NickServ REGISTER password email

4. Close your screen session, which you can return to later.

CTRL-A CTRL-D

5. Return to your screen session. You will have remained connected to the channel.

$ ssh neotame.csclub.uwaterloo.ca -t "screen -Urd"

= syscom =

To kick (and optionally ban) a user:

/cs op #<channel>
/mode #<channel> +b <nick_to_ban>
/kick <nick_to_kick>
/mode -o <your_nick>

If the user need not be banned you can skip the second line. If other accounts from the same user/host should be banned, replace <code>nick_to_ban/kick</code> with <code>nick!username@host</code>.

How to IRC

2022-07-30T05:00:22Z

Lbahodi: /* IRC Setup */

= Chatting with us =

== The Lounge ==
We have a web UI for IRC at [https://chat.csclub.uwaterloo.ca The Lounge].
[[File:The_lounge_screenshot.png|alt=The Lounge screenshot of #csc channel|400px|top|left|thumbnail|A screen capture of the #csc channel, as seen from The Lounge web client]]
If you are a first-time IRC user, this is by far the easiest way to join.
The steps are (roughly):
<ol>
<li> Login using your CSC credentials. </li>
<li> Follow the prompts to join the Libera server (make sure TLS is enabled). </li>
<li> Type <code>/join #csc</code> </li>
<li> Say hi! </li>
</ol>

If you are a syscom member, you will need to join the #csc-syscom channel, which requires nick (nickname) registration. To do this, run the following commands in The Lounge (or any IRC client):
<pre>
/nick my_nickname
/msg NickServ REGISTER my_password my_email@example.com
</pre>
Fill in your nickname, password and email as appropriate. You will receive an email from Libera asking you to verify your email address.
Once you have done so, go back to The Lounge, go the Libera window, click on the three-dots button in the top right corner, and click "Edit this network". There, you can specify the nick and password which you just created.

== Mattermost ==
We self-host [https://mattermost.csclub.uwaterloo.ca/ Mattermost] now, it's easier to use if you're not familiar with IRC. If you know how to use IRC, we're #csc on libera.chat and there should be a #csc bridge that relays messages between #csc and our Mattermost instance.

Both #csc on libera.chat ([https://web.libera.chat/#csc Libera Webchat] or via IRC clients e.g. irssi, weechat) and ~csc on Mattermost are official channels to interact with CSC members!

= Mattermost Setup =

[[File:Mattermost-phone-sample.jpg|alt=Mattermost android screenshot of #csc channel|200px|top|left|thumbnail|A screen capture of the #csc channel, as seen from Mattermost Android client]]
[[File:Mattermost-csc-sample.png|alt=Mattermost #csc screen capture, including a conversation between members of the channel|200px|top|right|thumbnail|A screen capture of the #csc channel, as seen from Mattermost desktop]]

Make an account at [https://mattermost.csclub.uwaterloo.ca/signup_email our self-hosted Mattermost]. For username, you can put your questid (i.e. your CSC username), although you can always set your full name as it will appear in Mattermost.

The benefit of Mattermost over Slack and family is that Slack stores all your information on Slack's servers, wherever they are in the US. They do this so they can sell your data back to you (e.g. not allowing you to see old messages), but Slack is also closed-source even though it was derived from IRC. Mattermost is open-source and hosted on CSC servers.

For iOS users, Mattermost's mobile app is also a superior option if you wish to receive push notifications as it supports Apple's native push via iCloud/APN.

= IRC Setup =

[[File:Glowing-bear-screencap.png|alt=glowing-bear screen capture of #csc IRC channel|right|thumbnail|450px|A screen capture of the #csc IRC channel, as seen from glowing-bear client]]

[[File:Weechat-Android-screenshot.png|alt=Weechat Android screen capture of #csc IRC channel|right|thumbnail|A screen capture of the #csc IRC channel, as seen from Weechat Android client]]

This method will establish a persistent IRC session that you can connect to with different clients. A [https://weechat.org/ weechat] server program running on a CSClub server will remain connected to IRC networks at all times, and simply connecting to your <code>weechat</code> server program will give you all the chat history upon connection.

To set up your <code>weechat</code> server program:
<ol>
<li>Log in to a CS Club general-use server, such as <code>taurine.csclub.uwaterloo.ca</code>, and run <code>weechat</code> in such a way that it will keep running after you log out.</li>

Replace ctdalek with your username:

<pre>
$ ssh ctdalek@taurine.csclub.uwaterloo.ca
$ screen -U weechat
</pre>

A "WeeChat" window should have opened up. Type the following commands into this window, replacing [yourpassword] with a password of your choice and [yourport] with a number in the range of [28100-28400]:

<pre>
/set relay.network.password [yourpassword]
/relay add weechat [yourport]
/save
</pre>

Once you have entered in all these commands, you don't need your terminal anymore. You can close your ssh window!

<li>Your personal WeeChat server is set up. Now connect to it using a pretty client:</li>

[http://www.glowing-bear.org/ glowing-bear] is a free and open source web-based weechat client. It works well as a desktop client, and on iOS. To connect using glowing-bear, fill in "Connection Settings" with `neotame.csclub.uwaterloo.ca`, `[yourport]`, and `[yourpassword]`. Make sure to use the http version of the website with this guide! HTTPS only works if you set up encryption. That's not covered here.

'''Recommended''': [https://play.google.com/store/apps/details?id=com.ubergeek42.WeechatAndroid Weechat Android] is a free and open source android weechat client. It gives notifications when your receive a direct message or your name is mentioned in one of the channels you are in. To connect using Weechat Android, fill in Settings > Connection with `neotame.csclub.uwaterloo.ca`, `[yourport]`, and `[yourpassword]`.

<li>Join the #csc IRC channel</li>

In your weechat client (e.g. glowing-bear or Weechat Android), switch to the 'Libera' tab and type:

<pre>
/server add libera irc.libera.chat/6697 -ssl -autoconnect
/set irc.server.libera.autojoin "#csc"
/save
/connect libera
</pre>

You're now connected to the main IRC network! Connected by an SSL connection, so you're super sneaky as well. Way to go.

Now, to join the CSC channel!

In your client, you'll now have two buffers that you can switch to. One is called "weechat" and the other is "libera".

Switch to the "libera" buffer and type:

> /join #csc

Congratulations you win!

<li>Know some IRC commands</li>

Welcome to the channel! Go ahead and say something, like

<pre>
Good morning ctdalek http://www.total-knowledge.com/~ilya/mips/ugt.html
</pre>

If you want to privately message someone, use

<pre>
/q [nick] [optional message]
</pre>

which will open a new tab with that person. For example <code>/q pj2melan ping pong</code>.

If you want to join another channel, use
<pre>
/join [channel]
</pre>

For example `/join #csc`.
</ol>
''Note about CSClub server restarts:'' If `neotame` or any server you're using to run the weechat program on is restarted for any reason (we'll email you if it does), Make sure to run `screen -U weechat` again to start your server. You won't have to reconfigure weechat (step 2) though.

== Securing Glowing Bear - SSL/TLS Setup ==

With the default setup, when you log in to your weechat relay using a client such as glowing-bear or Weechat Android ''your password is sent in the clear''. If you believe this to be a bad thing, follow these steps to enable SSL encryption between you and your weechat relay running on neotame.

<ol>
<li>Log in to `neotame.csclub.uwaterloo.ca` to generate an SSL certificate:

<pre>
$ ssh neotame.csclub.uwaterloo.ca
$ mkdir ~/.weechat/ssl
$ cd ~/.weechat/ssl
$ openssl req -nodes -newkey rsa:4096 -keyout relay.pem -x509 -days 365 -out relay.pem # Fill in the fields as it asks
$ exit
</pre>
</li>

<li>Tell weechat to use the new certificate you generated, and add a new relay with a different password (since your old password was likely compromised):

In your weechat client (glowing-bear, or Weechat Android), run

<pre>
> /set relay.network.password [newpassword]
> /relay sslcertkey
> /relay del weechat
> /relay add ssl.weechat [yourport]
</pre>
</li>

<li>Tell your client to connect to your relay using SSL:

For glowing-bear, refresh and simply check the "Encryption. Check settings for help." checkbox when logging in with your new password.

For Weechat Android, in Settings > Connection, change Connection type to WeeChat SSL and change your Relay password.
</li>

</ol>

Enjoy fully encrypted communication!

You might have warnings about untrusted certificates, but since you made the certificate yourself you can trust yourself and add required security exceptions.

== Quick SSH-based Setup ==

1. Open up an IRC client, i.e. irssi. Launch irssi in a screen session, which you
can return to later.

$ ssh neotame.csclub.uwaterloo.ca
$ screen -U irssi

2. In irssi, connect to the libera network and join our channel.

/server add -auto -net libera -ssl -ssl_verify irc.libera.chat 6697
/save
/connect libera
/join #csc

3. Please set your nickname to your Quest ID so we know who you are.

/nick $YOUR_QUEST_ID
/save

You can register your nickname on the libera network by messaging NickServ.

/msg NickServ REGISTER password email

4. Close your screen session, which you can return to later.

CTRL-A CTRL-D

5. Return to your screen session. You will have remained connected to the channel.

$ ssh neotame.csclub.uwaterloo.ca -t "screen -Urd"

= syscom =

To kick (and optionally ban) a user:

/cs op #<channel>
/mode #<channel> +b <nick_to_ban>
/kick <nick_to_kick>
/mode -o <your_nick>

If the user need not be banned you can skip the second line. If other accounts from the same user/host should be banned, replace <code>nick_to_ban/kick</code> with <code>nick!username@host</code>.

ZNC

2022-07-30T04:45:45Z

Lbahodi: Mention the How To IRC page and make #csc monospace

This page describes client and server setup for ZNC with LDAP authentication.
If you're new to IRC, see [[How to IRC]] to get started. For more info on ZNC, see [https://wiki.znc.in/ZNC].

== ZNC setup ==
These instructions show how to connect to the <code>#csc</code> channel on libera.chat via ZNC.
<ol>
<li>
Visit the ZNC web portal at <code>znc.csclub.uwaterloo.ca</code> and login using your CSC credentials.
</li>
<li>
Go to "Your Settings". Under "Networks", if you do not see a network called "libera", then click "Add", type "libera" for the Network Name, edit your nickname if desired, and enter the following into the IRC servers table:
<pre>
Hostname Port SSL
irc.libera.chat 6697 [Checked]
</pre>
</li>
<li>
(Optional, but recommended): Under the settings for libera, check the box which says "Connect to IRC & automatically re-connect". This will connect you to Libera as soon as you connect to ZNC.
</li>
<li>
Set your nick, alt. nick, and ident for libera. Make sure these all have the same value. By default these are set to %user% which will expand to your csc username.
If you are already logged in to libera with your csc username on a different IRC client, make sure to change your nick here
as two different connections cannot share the same nick.
</li>
<li>
Under the "channels" section for libera, click "Add", then enter <code>#csc</code> in the "Channel Name" field, and check the boxes "Save to config", "Detached", and "Enabled". Click "Add Channel and return".
</li>
</ol>
Now you will connect to ZNC with an IRC client.

== IRC Client setup ==
=== The Lounge (chat.csclub.uwaterloo.ca) ===
<ol>
<li>
Under network settings, name can be anything you want.
</li>
<li>
Server should be set to <code>znc.csclub.uwaterloo.ca</code>, and port <code>6697</code>. The password is <code><zncusername>:<zncpassword></code>. If you have multiple networks configured, i.e. Libera and Freenode, use <code><zncusername>/<networkname>:<zncpassword></code> for the password. Also set your nick, username and real name.
</li>
<li>
Under Authentication, choose <code>Username + password (SASL PLAIN)</code>, and enter your LIBERA nick and password.
</li>
</ol>

=== Weechat ===
<ol>
<pre>
/server add myznc znc.csclub.uwaterloo.ca/6697 -username=<CSC_USERNAME>/libera -password=<CSC_PASSWORD> -ssl -autoconnect
/connect myznc
/join #csc
</pre>
Don't forget to concatenate "/libera" to the end of your username.

<li>
If you did not check the autoconnect box, you will need to manually connect using:
<pre>
/msg *status connect
</pre>
To verify that you are connected to Libera, run
<pre>
/msg *status ListNetworks
</pre>
The "IRC" column should have the value "Yes".
</li>
<li>
A modified version of the backlog module [https://wiki.znc.in/Backlog] is enabled globally. To use this, first enable the <kbd>log</kbd> module for your user via the web UI. You will then be able to request older logs for a channel from your IRC client, e.g.
<pre>
/msg *backlog #csc 42
</pre>
Note that you do not need to specify the log path.
</li>
</ol>

== Server setup ==
Note that the following instructions are about setting up a ZNC instance with support for LDAP authentication, similar to the CSC ZNC, and it is ''not'' about configuring an IRC client to connect to ZNC. For that, see the [[ZNC#Client_setup|Client setup]] section above.

=== saslauthd setup ===
For LDAP authentication, we use the Cyrusauth module [https://wiki.znc.in/Cyrusauth], which needs to communicate with the SASL authentication daemon (saslauthd).
<ol>
<li>
On the server, install the following packages:
<pre>apt install sasl2-bin ca-certificates</pre>
</li>
<li>
Open /etc/default/saslauthd, and change the following lines:
<pre>
START=yes
MECHANISM="ldap"
</pre>
</li>
<li>
Paste the following into /etc/saslauthd.conf:
<pre>
ldap_servers: ldaps://auth1.csclub.uwaterloo.ca ldaps://auth2.csclub.uwaterloo.ca
ldap_search_base: ou=People,dc=csclub,dc=uwaterloo,dc=ca
ldap_filter: (uid=%u)
</pre>
</li>
<li>
Start saslauthd:
<pre>
# service saslauthd start
</pre>
</li>
<li>
Test saslauthd to make sure it's working:
<pre>
$ testsaslauthd -u "your_csc_username" -p "your_csc_password"
</pre>
You should see a response like
<pre>
0: OK "Success."
</pre>
</li>
</ol>
=== ZNC setup ===
<ol>
<li>
Install ZNC:
<pre>
# apt install znc
</pre>
</li>
<li>
Add a user for ZNC and create an initial configuration:
<pre>
# useradd -s /bin/bash -m znc
# usermod -a -G sasl znc
# su - znc
$ znc --makeconf
</pre>
Note that the znc user must be part of the sasl group to communicate with saslauthd.
</li>
<li>
Visit the web interface at <SERVER_IP>:<PORT>. Note that you may need to modify your browser settings so that you can visit a website at port 6667 or 6697.
</li>
<li>
Log in using your admin credentials, then go to "Global Settings". Check the "cyrusauth" box, type "saslauthd" in the arguments input field, then scroll to the bottom and click "Save".
</li>
<li>
You will now need to connect to ZNC with an IRC client. The commands below assume Weechat is being used, but other clients should be similar.
<pre>
/server add myznc <SERVER_IP>/<PORT> -username=<ADMIN_USERNAME> -password=<ADMIN_PASSWORD>
/connect myznc
/msg *Cyrusauth CreateUsers yes
</pre>
This will tell ZNC to create a new user on their first login.
</li>
<li>
You may optionally wish to create users from a template (i.e. dummy) user to share some common per-user settings, such as MaxNetworks. To do this, login to the ZNC web interface as admin and click on "Manage Users". Add a new user called "dummy" with the desired settings, then click "save".
Now open Weechat, login to ZNC as admin, and run the following:
<pre>
/msg *Cyrusauth CreateUsers clone dummy
</pre>
This will tell ZNC to clone new users using "dummy" as the template.
</li>
<li>
You may wish to optionally enable the adminlog module [https://wiki.znc.in/Adminlog] so that you can see who has logged in from where at what time. By default, these logs will be written to a file. To prevent this file from growing too long, install logrotate and paste the following into /etc/logrotate.d/znc:
<pre>
/home/znc/.znc/moddata/adminlog/znc.log {
rotate 4
weekly
compress
}
</pre>
This will keep rotate logs every week, discarding logs after they have been rotated 4 times.
</li>
</ol>
=== NGINX tuning ===
If you are running ZNC behind NGINX as a reverse proxy, keep in mind that by default, NGINX will run one worker process per CPU core. To reduce this, change the following in <kbd>/etc/nginx/nginx.conf</kbd>:
<pre>
worker_processes 4
</pre>

ZNC

2022-07-30T04:41:58Z

Lbahodi: specify the url of the ZNC web portal

This page describes client and server setup for ZNC with LDAP authentication.
For more info on ZNC, see [https://wiki.znc.in/ZNC].

== ZNC setup ==
These instructions show how to connect to the #csc channel on libera.chat via ZNC.
<ol>
<li>
Visit the ZNC web portal at <code>znc.csclub.uwaterloo.ca</code> and login using your CSC credentials.
</li>
<li>
Go to "Your Settings". Under "Networks", if you do not see a network called "libera", then click "Add", type "libera" for the Network Name, edit your nickname if desired, and enter the following into the IRC servers table:
<pre>
Hostname Port SSL
irc.libera.chat 6697 [Checked]
</pre>
</li>
<li>
(Optional, but recommended): Under the settings for libera, check the box which says "Connect to IRC & automatically re-connect". This will connect you to Libera as soon as you connect to ZNC.
</li>
<li>
Set your nick, alt. nick, and ident for libera. Make sure these all have the same value. By default these are set to %user% which will expand to your csc username.
If you are already logged in to libera with your csc username on a different IRC client, make sure to change your nick here
as two different connections cannot share the same nick.
</li>
<li>
Under the "channels" section for libera, click "Add", then enter "#csc" in the "Channel Name" field, and check the boxes "Save to config", "Detached", and "Enabled". Click "Add Channel and return".
</li>
</ol>
Now you will connect to ZNC with an IRC client.

== IRC Client setup ==
=== The Lounge (chat.csclub.uwaterloo.ca) ===
<ol>
<li>
Under network settings, name can be anything you want.
</li>
<li>
Server should be set to <code>znc.csclub.uwaterloo.ca</code>, and port <code>6697</code>. The password is <code><zncusername>:<zncpassword></code>. If you have multiple networks configured, i.e. Libera and Freenode, use <code><zncusername>/<networkname>:<zncpassword></code> for the password. Also set your nick, username and real name.
</li>
<li>
Under Authentication, choose <code>Username + password (SASL PLAIN)</code>, and enter your LIBERA nick and password.
</li>
</ol>

=== Weechat ===
<ol>
<pre>
/server add myznc znc.csclub.uwaterloo.ca/6697 -username=<CSC_USERNAME>/libera -password=<CSC_PASSWORD> -ssl -autoconnect
/connect myznc
/join #csc
</pre>
Don't forget to concatenate "/libera" to the end of your username.

<li>
If you did not check the autoconnect box, you will need to manually connect using:
<pre>
/msg *status connect
</pre>
To verify that you are connected to Libera, run
<pre>
/msg *status ListNetworks
</pre>
The "IRC" column should have the value "Yes".
</li>
<li>
A modified version of the backlog module [https://wiki.znc.in/Backlog] is enabled globally. To use this, first enable the <kbd>log</kbd> module for your user via the web UI. You will then be able to request older logs for a channel from your IRC client, e.g.
<pre>
/msg *backlog #csc 42
</pre>
Note that you do not need to specify the log path.
</li>
</ol>

== Server setup ==
Note that the following instructions are about setting up a ZNC instance with support for LDAP authentication, similar to the CSC ZNC, and it is ''not'' about configuring an IRC client to connect to ZNC. For that, see the [[ZNC#Client_setup|Client setup]] section above.

=== saslauthd setup ===
For LDAP authentication, we use the Cyrusauth module [https://wiki.znc.in/Cyrusauth], which needs to communicate with the SASL authentication daemon (saslauthd).
<ol>
<li>
On the server, install the following packages:
<pre>apt install sasl2-bin ca-certificates</pre>
</li>
<li>
Open /etc/default/saslauthd, and change the following lines:
<pre>
START=yes
MECHANISM="ldap"
</pre>
</li>
<li>
Paste the following into /etc/saslauthd.conf:
<pre>
ldap_servers: ldaps://auth1.csclub.uwaterloo.ca ldaps://auth2.csclub.uwaterloo.ca
ldap_search_base: ou=People,dc=csclub,dc=uwaterloo,dc=ca
ldap_filter: (uid=%u)
</pre>
</li>
<li>
Start saslauthd:
<pre>
# service saslauthd start
</pre>
</li>
<li>
Test saslauthd to make sure it's working:
<pre>
$ testsaslauthd -u "your_csc_username" -p "your_csc_password"
</pre>
You should see a response like
<pre>
0: OK "Success."
</pre>
</li>
</ol>
=== ZNC setup ===
<ol>
<li>
Install ZNC:
<pre>
# apt install znc
</pre>
</li>
<li>
Add a user for ZNC and create an initial configuration:
<pre>
# useradd -s /bin/bash -m znc
# usermod -a -G sasl znc
# su - znc
$ znc --makeconf
</pre>
Note that the znc user must be part of the sasl group to communicate with saslauthd.
</li>
<li>
Visit the web interface at <SERVER_IP>:<PORT>. Note that you may need to modify your browser settings so that you can visit a website at port 6667 or 6697.
</li>
<li>
Log in using your admin credentials, then go to "Global Settings". Check the "cyrusauth" box, type "saslauthd" in the arguments input field, then scroll to the bottom and click "Save".
</li>
<li>
You will now need to connect to ZNC with an IRC client. The commands below assume Weechat is being used, but other clients should be similar.
<pre>
/server add myznc <SERVER_IP>/<PORT> -username=<ADMIN_USERNAME> -password=<ADMIN_PASSWORD>
/connect myznc
/msg *Cyrusauth CreateUsers yes
</pre>
This will tell ZNC to create a new user on their first login.
</li>
<li>
You may optionally wish to create users from a template (i.e. dummy) user to share some common per-user settings, such as MaxNetworks. To do this, login to the ZNC web interface as admin and click on "Manage Users". Add a new user called "dummy" with the desired settings, then click "save".
Now open Weechat, login to ZNC as admin, and run the following:
<pre>
/msg *Cyrusauth CreateUsers clone dummy
</pre>
This will tell ZNC to clone new users using "dummy" as the template.
</li>
<li>
You may wish to optionally enable the adminlog module [https://wiki.znc.in/Adminlog] so that you can see who has logged in from where at what time. By default, these logs will be written to a file. To prevent this file from growing too long, install logrotate and paste the following into /etc/logrotate.d/znc:
<pre>
/home/znc/.znc/moddata/adminlog/znc.log {
rotate 4
weekly
compress
}
</pre>
This will keep rotate logs every week, discarding logs after they have been rotated 4 times.
</li>
</ol>
=== NGINX tuning ===
If you are running ZNC behind NGINX as a reverse proxy, keep in mind that by default, NGINX will run one worker process per CPU core. To reduce this, change the following in <kbd>/etc/nginx/nginx.conf</kbd>:
<pre>
worker_processes 4
</pre>