blob: 222468a6d402495bad03b5de35c971018729e234 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
# milla
Milla is an IRC bot that sends things over to an LLM when you ask it questions and prints the answer with optional syntax-hilighting.<br/>
Currently Supported:
- Ollama
- Openai
- Gemini
milla accepts one cli arg which tells it where to look for the config file:<br/>
```$ milla -help
Usage of ./milla:
-config string
path to the config file (default "./config.toml")
```
## Config
An exhaustive example is in `config-example.toml`.
#### ircServer
The address for the IRC server to connect to.
#### ircNick
The nick the bot should use.
#### enableSasl
Whether to use SASL for authentication.
#### ircSaslUser
The SASL username.
#### ircSaslPass
The SASL password for SASL plain authentication.
#### ollamaEndpoint
The address for the Ollama chat endpoint.
#### model
The name of the model to use.
#### chromaStyle
The style to use for syntax highlighting done by [chroma](https://github.com/alecthomas/chroma). This is basically what's called a "theme".
#### chromaFormatter
The formatter to use. This tells chroma how to generate the color in the output. The supported options are:
- `noop` for no syntax highlighting
- `terminal` for 8-color terminals
- `terminal8` for 8-color terminals
- `terminal16` for 16-color terminals
- `terminal256` for 256-color terminals
- `terminal16m` for treucolor terminals
- `html` for HTML output
#### provider
Which LLM provider to use. The supported options are:
- [ollama](https://github.com/ollama/ollama)
- chatgpt
- gemini
#### apikey
The apikey to use for the LLM provider.
#### ollamaSystem
The system message to use for ollama.
#### clientCertPath
The path to the client certificate to use for SASL external authentication.
#### serverPass
The password to use for the IRC server the bot is trying to connect to if the server has a password.
#### bind
Which address to bind to for the IRC server.
#### temp
The temperature to config the model with.
#### requestTimeout
The timeout for requests made to the LLM provider.
#### millaReconnectDelay
How much to wait before reconnecting to the IRC server.
#### ircPort
Which port to connect to for the IRC server.
#### keepAlive
#### memoryLimit
How many conversations to keep in memory for a model.
#### pingDelay
Ping delay for the IRC server.
#### pingTimeout
Ping timeout for the IRC server.
#### topP
#### topK
#### skipTLSVerify
Skip verifying the IRC server's TLS certificate. This only makes sense if you are trying to connect to an IRC server with a self-signed certificate.
#### useTLS
Whether to use TLS to connect to the IRC server. This option is provided to support usage on overlay networks such as Tor, i2p and [yggdrassil](https://github.com/yggdrasil-network/yggdrasil-go).
#### disableSTSFallback
#### allowFlood
Disable [girc](https://github.com/lrstanley/girc)'s built-in flood protection.
#### debug
Whether to enable debug logging. The logs are written to stdout.
#### out
Whether to write raw messages to stdout.
#### admins
List of adimns for the bot. Only admins can use commands.
```
admins = ["admin1", "admin2"]
```
#### ircChannels
List of channels for the bot to join when it connects to the server.
```
ircChannels = ["#channel1", "#channel2"]
```
## Commands
#### help
Prints the help message.
#### get
Get the value of a config option. Use the same name as the config file but capitalized.
#### getall
Get the value of all config options.
#### set
Set a config option on the fly. Use the same name as the config file but capitalized.
## Deploy
An example docker compose file is provided in the repo under `docker-compose.yaml`.
```yaml
services:
milla:
image: milla
build:
context: .
deploy:
resources:
limits:
memory: 64M
user: ${UID}:${GID}
logging:
driver: "json-file"
options:
max-size: "100m"
networks:
- millanet
restart: unless-stopped
command: ["--config", "/opt/milla/config.toml"]
volumes:
- ./config.toml:/opt/milla/config.toml
- /etc/ssl/certs:/etc/ssl/certs:ro
cap_drop:
- ALL
environment:
- SERVER_DEPLOYMENT_TYPE=deployment
networks:
millanet:
```
## Thanks
- [girc](https://github.com/lrstanley/girc)
- [chroma](https://github.com/alecthomas/chroma)
- [ollama](https://github.com/ollama/ollama)
## Similar Projects
- [soulshack](https://github.com/pkdindustries/soulshack)
|
