mirror-chatterino2/docs/ENV.md

# Environment variables
Below I have tried to list all environment variables that can be used to modify the behaviour of Chatterino. Used for things that I don't feel like fit in the settings system.

### CHATTERINO2_RECENT_MESSAGES_URL
Used to change the URL that Chatterino2 uses when trying to load historic Twitch chat messages (if the setting is enabled).  
Default value: `https://recent-messages.robotty.de/api/v2/recent-messages/%1?clearchatToNotice=true` (an [open-source service](https://github.com/robotty/recent-messages) written and currently run by [@RAnders00](https://github.com/RAnders00))  
Arguments:  
 - `%1` = Name of the Twitch channel

### CHATTERINO2_LINK_RESOLVER_URL
Used to change the URL that Chatterino2 uses when trying to get link information to display in the tooltip on hover.  
Default value: `https://braize.pajlada.com/chatterino/link_resolver/%1`  
Arguments:  
 - `%1` = Escaped URL the link resolver should resolve

### CHATTERINO2_TWITCH_EMOTE_SET_RESOLVER_URL
Used to change the URL that Chatterino2 uses when trying to get emote set information
Default value: `https://braize.pajlada.com/chatterino/twitchemotes/set/%1/`  
Arguments:  
 - `%1` = Emote set ID

### CHATTERINO2_IMAGE_UPLOADER_URL
Used to change the URL that Chatterino2 uses when trying to paste an image into chat. This can be used for hosting the uploaded images yourself.
Default value: `https://i.nuuls.com/upload`

Arguments:
 - None

Notes:
 - If you want to host the images yourself. You need [Nuuls' filehost software](https://github.com/nuuls/filehost)
 - Other image hosting software is currently not supported.

### CHATTERINO2_TWITCH_SERVER_HOST
String value used to change what Twitch chat server host to connect to.  
Default value: `irc.chat.twitch.tv`

### CHATTERINO2_TWITCH_SERVER_PORT
Number value used to change what port to use when connecting to Twitch chat servers.  
Currently known valid ports for secure usage: 6697, 443.  
Currently known valid ports for non-secure usage (CHATTERINO2_TWITCH_SERVER_SECURE set to false): 6667, 80.  
Default value: `443`

### CHATTERINO2_TWITCH_SERVER_SECURE
Bool value used to tell Chatterino whether to try to connect securely (secure irc) to the Twitch chat server.  
Default value: `true`
Document current environment variables that can be used the change the Chatterino experience 2019-05-26 21:25:50 +02:00			`# Environment variables`
			`Below I have tried to list all environment variables that can be used to modify the behaviour of Chatterino. Used for things that I don't feel like fit in the settings system.`

Move environment variable parsing and storage to its own class Make the Link resolver and Twitch emotes set resolver urls modifiable with environment variables 2019-05-26 21:44:13 +02:00			`### CHATTERINO2_RECENT_MESSAGES_URL`
Document current environment variables that can be used the change the Chatterino experience 2019-05-26 21:25:50 +02:00			`Used to change the URL that Chatterino2 uses when trying to load historic Twitch chat messages (if the setting is enabled).`
Update ENV.md with link to recent-messages service repo 2019-09-01 23:07:19 +02:00			Default value: `https://recent-messages.robotty.de/api/v2/recent-messages/%1?clearchatToNotice=true` (an [open-source service](https://github.com/robotty/recent-messages) written and currently run by [@RAnders00](https://github.com/RAnders00))
Document current environment variables that can be used the change the Chatterino experience 2019-05-26 21:25:50 +02:00			`Arguments:`
Move environment variable parsing and storage to its own class Make the Link resolver and Twitch emotes set resolver urls modifiable with environment variables 2019-05-26 21:44:13 +02:00			- `%1` = Name of the Twitch channel

			`### CHATTERINO2_LINK_RESOLVER_URL`
			`Used to change the URL that Chatterino2 uses when trying to get link information to display in the tooltip on hover.`
			Default value: `https://braize.pajlada.com/chatterino/link_resolver/%1`
			`Arguments:`
			- `%1` = Escaped URL the link resolver should resolve

			`### CHATTERINO2_TWITCH_EMOTE_SET_RESOLVER_URL`
			`Used to change the URL that Chatterino2 uses when trying to get emote set information`
			Default value: `https://braize.pajlada.com/chatterino/twitchemotes/set/%1/`
			`Arguments:`
			- `%1` = Emote set ID
Redo all changes done before breaking the branch. 2019-09-23 19:36:52 +02:00
Fix a couple things Pajlada pointed out :) Change `CHATTERINO2_IMAGE_PASTE_SITE_URL` to `CHATTERINO2_IMAGE_UPLOADER_URL` Remove newline at the end of `docs/ENV.md` 2020-02-08 15:44:03 +01:00			`### CHATTERINO2_IMAGE_UPLOADER_URL`
Reword docs slightly. 2019-09-24 18:39:15 +02:00			`Used to change the URL that Chatterino2 uses when trying to paste an image into chat. This can be used for hosting the uploaded images yourself.`
Redo all changes done before breaking the branch. 2019-09-23 19:36:52 +02:00			Default value: `https://i.nuuls.com/upload`

			`Arguments:`
			`- None`

			`Notes:`
Fix issues pointed out in reviews :) Fixed PR BabyRage 2020-01-03 14:43:05 +01:00			`- If you want to host the images yourself. You need [Nuuls' filehost software](https://github.com/nuuls/filehost)`
Smol change in ENV.md. 2019-09-25 12:33:34 +02:00			`- Other image hosting software is currently not supported.`
Reword docs slightly. 2019-09-24 18:39:15 +02:00
allow customizing twitch server parameters through environment variables (#1449) 2019-12-21 10:11:23 +01:00			`### CHATTERINO2_TWITCH_SERVER_HOST`
			`String value used to change what Twitch chat server host to connect to.`
			Default value: `irc.chat.twitch.tv`

			`### CHATTERINO2_TWITCH_SERVER_PORT`
			`Number value used to change what port to use when connecting to Twitch chat servers.`
			`Currently known valid ports for secure usage: 6697, 443.`
			`Currently known valid ports for non-secure usage (CHATTERINO2_TWITCH_SERVER_SECURE set to false): 6667, 80.`
			Default value: `443`

			`### CHATTERINO2_TWITCH_SERVER_SECURE`
			`Bool value used to tell Chatterino whether to try to connect securely (secure irc) to the Twitch chat server.`
Fix issues pointed out in reviews :) Fixed PR BabyRage 2020-01-03 14:43:05 +01:00			Default value: `true`