ZNC: Difference between revisions
(More info about SSL certificates) |
m (Removed a hyperlink to a hypothetical URL. Used path template.) |
||
(13 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
[https://wiki.znc.in/ZNC ZNC] is an advanced IRC bouncer that can establish such a permanent connection to several IRC networks and channels so your IRC client (or multiple clients) can disconnect/reconnect without losing the chat session, while appearing as a single user to other users. | [https://wiki.znc.in/ZNC ZNC] is an advanced IRC bouncer that can establish such a permanent connection to several IRC networks and channels so your IRC client (or multiple clients) can disconnect/reconnect without losing the chat session, while appearing as a single user to other users. | ||
== | == Installation == | ||
Install the package that contains ZNC. | Install the package that contains ZNC. | ||
{{Cmd|apk add znc}} | {{Cmd|apk add znc}} | ||
Create a ZNC configuration file, this command will automatically create znc.conf in /var/lib/znc/configs/. You will be asked to enter some information. | Create a ZNC configuration file, this command will automatically create znc.conf in {{path|/var/lib/znc/configs/}}. You will be asked to enter some information. | ||
{{Cmd|rc-service znc setup}} | {{Cmd|rc-service znc setup}} | ||
{{Note|Make sure the information you enter is as it's shown below.}} | {{Note|Make sure the information you enter is as it's shown below.}} | ||
Listen on port: | Listen on port: 1025 | ||
Listen using SSL: yes | Listen using SSL: yes | ||
Listen using both IPv4 and IPv6: no | Listen using both IPv4 and IPv6: no | ||
Line 27: | Line 27: | ||
=== Configure the ZNC webadmin page === | === Configure the ZNC webadmin page === | ||
Open the ZNC webadmin page <code>https://YOUR_SERVER_IP: | Open the ZNC webadmin page <code><nowiki>https://YOUR_SERVER_IP:1025</nowiki></code> in your browser. Accept the insecure certificate and go forward. | ||
Log in with your username and password and go to global settings. | Log in with your username and password and go to global settings. | ||
We want to maintain the webadmin connections separate from the IRC connections. | We want to maintain the webadmin connections separate from the IRC connections. | ||
Line 45: | Line 45: | ||
{{Cmd|rc-service znc stop}} | {{Cmd|rc-service znc stop}} | ||
Edit the configuration file. | Edit the configuration file. | ||
{{Cmd|vim /lib/znc/configs/znc.conf}} | {{Cmd|vim /var/lib/znc/configs/znc.conf}} | ||
{{Note|Listener0 is the webadmin port (it's listening port | {{Note|Listener0 is the webadmin port (it's listening port 1025). Listener1 is the IRC port (it's listening port 6697).}} | ||
Your configuration file should look like this: | Your configuration file should look like this: | ||
Line 56: | Line 56: | ||
IPv4 = true | IPv4 = true | ||
IPv6 = false | IPv6 = false | ||
Port = | Port = 1025 | ||
SSL = false | SSL = false | ||
URIPrefix = / | URIPrefix = / | ||
<Listener listener1> | <Listener listener1> | ||
AllowIRC = true | AllowIRC = true | ||
Line 83: | Line 84: | ||
server_name znc.yourdomain.com; | server_name znc.yourdomain.com; | ||
location / { | location / { | ||
proxy_pass http://localhost: | proxy_pass http://localhost:1025; | ||
} | } | ||
} | } | ||
Line 93: | Line 93: | ||
=== Set up SSL certificates === | === Set up SSL certificates === | ||
{{Note|We opt to use SSL certificates made by Let's Encrypt, instead of using the znc.pem certificate that | {{Note|We opt to use SSL certificates made by Let's Encrypt, instead of using the znc.pem certificate that comes with the program.}} | ||
Install Certbot and its module to work with NGINX. | Install Certbot and its module to work with NGINX. | ||
{{Cmd|apk add certbot cerbot-nginx}} | {{Cmd|apk add certbot cerbot-nginx}} | ||
Line 101: | Line 101: | ||
{{Cmd|rc-service nginx restart}} | {{Cmd|rc-service nginx restart}} | ||
Now we will replace the znc.pem certificate with the Let's Encrypt certificates for any person who wants to connect to our IRC bouncer. For this we need to concatenate two important files into znc.pem | Now we will replace the znc.pem certificate with the Let's Encrypt certificates for any person who wants to connect to our IRC bouncer. For this we need to concatenate two important files into znc.pem | ||
{{cat /etc/letsencrypt/live/ | {{Cmd|cat /etc/letsencrypt/live/your_domain.com/privkey.pem /etc/letsencrypt/live/your_domain.com/fullchain.pem > /var/lib/znc/znc.pem}} | ||
[[Category:Server]] | [[Category:Server]] | ||
Latest revision as of 22:19, 20 December 2021
ZNC is an advanced IRC bouncer that can establish such a permanent connection to several IRC networks and channels so your IRC client (or multiple clients) can disconnect/reconnect without losing the chat session, while appearing as a single user to other users.
Installation
Install the package that contains ZNC.
apk add znc
Create a ZNC configuration file, this command will automatically create znc.conf in /var/lib/znc/configs/. You will be asked to enter some information.
rc-service znc setup
Listen on port: 1025 Listen using SSL: yes Listen using both IPv4 and IPv6: no Username: your_username Enter password: your_password Confirm password: your_password Nick: nick Alternate nick: nick_ Real name: optional Bind host: try to leave empty Set up a network? no Launch ZNC now? no
htop
or rc-status
if ZNC is running.
Start ZNC as service.
rc-service znc start
Run ZNC in a subdomain using NGINX
Configure the ZNC webadmin page
Open the ZNC webadmin page https://YOUR_SERVER_IP:1025
in your browser. Accept the insecure certificate and go forward.
Log in with your username and password and go to global settings.
We want to maintain the webadmin connections separate from the IRC connections.
Let's make a listening port for the IRC connections.
In Listen Port(s) add:
Port: 6697 BindHost: * SSL: on IPv4: on IPv6: off IRC: on HTTP: off URIPrefix: /
Save the information you entered and stop the service for now.
rc-service znc stop
Edit the configuration file.
vim /var/lib/znc/configs/znc.conf
Your configuration file should look like this:
Contents of /lib/znc/configs/znc.conf
Start ZNC as service.
rc-service znc start
Configure NGINX
Install NGINX if you haven't already.
apk add nginx
Create a configuration file in conf.d separated from the main configuration files.
vim /etc/nginx/conf.d/znc.your_domain.com.conf
The file should look something like below.
Contents of /etc/nginx/conf.d/znc.your_domain.com.conf
Restart the NGINX service.
rc-service nginx restart
Set up SSL certificates
Install Certbot and its module to work with NGINX.
apk add certbot cerbot-nginx
Run Certbot, this program will create Let's Encrypt SSL certificates for free. You will have to manually or automatically renew them every month.
certbot
Restart NGINX and you're done. Your webadmin page will be automatically running the SSL certificate made by Let's Encrypt.
rc-service nginx restart
Now we will replace the znc.pem certificate with the Let's Encrypt certificates for any person who wants to connect to our IRC bouncer. For this we need to concatenate two important files into znc.pem
cat /etc/letsencrypt/live/your_domain.com/privkey.pem /etc/letsencrypt/live/your_domain.com/fullchain.pem > /var/lib/znc/znc.pem