Skip to content

Commit 72154a0

Browse files
authored
Update README
1 parent c57ddda commit 72154a0

File tree

1 file changed

+2
-72
lines changed

1 file changed

+2
-72
lines changed

README

Lines changed: 2 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -86,79 +86,9 @@ kirc [-s hostname] [-p port] [-c channels] [-n nickname] [-r realname] [-u usern
8686
* **CTRL+U** deletes the entire line.
8787
* **CTRL+K** deletes the from current character to end of line.
8888

89-
## Transport Layer Security (TLS) Support
89+
## Support Documentation
9090

91-
There is no native TLS/SSL support. Instead, users can achieve this functionality by using third-party utilities (e.g. stunnel, [socat](https://linux.die.net/man/1/socat), ghosttunnel, etc).
92-
93-
* Example using `socat`. Remember to replace items enclosed with `<>`.
94-
95-
```shell
96-
socat tcp-listen:6667,reuseaddr,fork,bind=127.0.0.1 ssl:<irc-server>:6697
97-
kirc -s 127.0.0.1 -c 'channel' -n 'name' -r 'realname'
98-
```
99-
100-
## SASL PLAIN Authentication
101-
102-
In order to connect using `SASL PLAIN` mechanism authentication, the user must provide the required token during the initial connection. If the authentication token is base64 encoded and, therefore, can be generated a number of ways. For example, using Python, one could use the following:
103-
104-
```shell
105-
python -c 'import base64; print(base64.encodebytes(b"nick\x00nick\x00password"))'
106-
```
107-
108-
For example, lets assume an authentication identity of `jilles` and password `sesame`:
109-
110-
```shell
111-
$ python -c 'import base64; print(base64.encodebytes(b"jilles\x00jilles\x00sesame"))'
112-
b 'amlsbGVzAGppbGxlcwBzZXNhbWU=\n'
113-
$ kirc -n jilles -a amlsbGVzAGppbGxlcwBzZXNhbWU=
114-
```
115-
116-
## SASL EXTERNAL Authentication
117-
118-
Similar to `SASL PLAIN`, the `SASL EXTERNAL` mechanism allows us to authenticate using credentials by external means. An example where this might be required is when trying to connect to an IRC host through [Tor](https://www.torproject.org/). To do so, we can using third-party utilities (e.g. stunnel, socat, ghosttunnel, etc).
119-
120-
* Example using `socat`. Remember to replace items enclosed with `<>`.
121-
122-
```shell
123-
socat TCP4-LISTEN:1110,fork,bind=0,reuseaddr SOCKS4A:127.0.0.1:<onion_address.onion>:<onion_port>,socksport=9050
124-
socat TCP4-LISTEN:1111,fork,bind=0,reuseaddr 'OPENSSL:127.0.0.1:1110,verify=0,cert=<path_to_pem>'
125-
kirc -e -s 127.0.0.1 -p 1111 -n <nick> -x 'wait 5000'
126-
```
127-
128-
## Color Scheme Definition
129-
130-
Applying a new color scheme is easy! One of the quickest ways is to use an application, such as [kfc](https://github.com/mcpcpc/kfc), to apply pre-made color palettes. Alternatively, you can manually apply escape sequences to change the default terminal colors.
131-
132-
* Example using `kfc`
133-
134-
```shell
135-
kfc -s gruvbox
136-
```
137-
138-
* Example using ANSI escape sequences
139-
140-
```shell
141-
printf -e "\033]4;<color_number>;#<hex_color_code>"
142-
143-
# Replace <hex_color_code> with the desired Hex code (e.g. #FFFFFF is white).
144-
# Replace <color_number> with the one of the numbers below:
145-
# 0 - Regular Black
146-
# 1 - Regular Red
147-
# 2 - Regular Green
148-
# 3 - Regular Yellow
149-
# 4 - Regular Blue
150-
# 5 - Regular Magenta
151-
# 6 - Regular Cyan
152-
# 7 - Regular White
153-
# 8 - Bright Black
154-
# 9 - Bright Red
155-
# 10 - Bright Green
156-
# 11 - Bright Yellow
157-
# 12 - Bright Blue
158-
# 13 - Bright Magenta
159-
# 14 - Bright Cyan
160-
# 15 - Bright White
161-
```
91+
Please refer to the official [Support Documention](https://mcpcpc.github.io/kirc/documentation.html) for examples, troubleshooting and use cases.
16292

16393
## Contact
16494

0 commit comments

Comments
 (0)