add config docs

docs/CONFIG.md

@@ -0,0 +1,15 @@
+# Configuration
+
+Configuration is stored in a `config.json` file.
+
+Available options:
+- `clickhouseUrl` (string): Connection URL for Clickhouse. Note that it should start with the protocol (`http://`)
+- `clickhouseDb` (string): Clickhouse database name.
+- `clickhouseUsername` (string): Clickhouse username.
+- `clickhousePassword` (string): Clickhouse password.
+- `listenAddress` (string): Listening address for the web server. Defaults to `0.0.0.0:8025`.
+- `channels` (array of strings): List of channel ids to be logged.
+- `clientId` (string): Twitch client id.
+- `clientSecret` (string): Twitch client secret.
+- `admins` (array of strings): List of usernames who are allowed to use administration commands.
+- `optOut` (object of strings: booleans): Liste of user ids who opted out from being logged.

docs/MIGRATION.md

@@ -3,7 +3,7 @@
 Rustlog supports migrating your existing data from justlog. This process will read all log files and write them into the database.
 
 ## Config
-Rustlog uses a config format nearly identical to justlog, however you still need to add Clickhouse connection settings to it. See [config.example.json](../config.example.json) for the keys starting with `clickhouse`.
+Rustlog uses a config format nearly identical to justlog, however you still need to add Clickhouse connection settings to it. See [CONFIG.md](./CONFIG.md) for the keys starting with `clickhouse`.
 
 After this, you should have a running rustlog instance logging new messages.
 

src/config.rs

@@ -10,7 +10,6 @@ const CONFIG_FILE_NAME: &str = "config.json";
 #[derive(Serialize, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct Config {
-    // pub logs_directory: String,
     pub clickhouse_url: String,
     pub clickhouse_db: String,
     pub clickhouse_username: Option<String>,