From 1ed35f6a39dc2ce6a8e85cc1f3c3b1da7e98c3ed Mon Sep 17 00:00:00 2001 From: Tyler Stiene Date: Tue, 9 Mar 2021 00:05:04 -0500 Subject: [PATCH] chore: doc update --- .gitignore | 1 + README.md | 11 ++++++++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 0984308..87b6e38 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ mumble-discord-bridge dist bridge .prof +cert.pem \ No newline at end of file diff --git a/README.md b/README.md index 1919f47..c079c0f 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ Usage of ./mumble-discord-bridge: -mumble-address string MUMBLE_ADDRESS, mumble server address, example example.com, required -mumble-channel string - MUMBLE_CHANNEL, mumble channel to start in, using '/' to seperate nested channels, optional + MUMBLE_CHANNEL, mumble channel to start in, using '/' to separate nested channels, optional -mumble-disable-text MUMBLE_DISABLE_TEXT, disable sending text to mumble, (default false) -mumble-insecure @@ -93,6 +93,15 @@ Discord GID is a unique ID linked to one Discord Server, also called Guild. CID Then you can get the GID by right-clicking your server and selecting Copy-ID. Similarly the CID can be found right clicking the voice channel and selecting Copy ID. +### Generating Mumble Client (Optional) + +Optionally you can specify a client certificate for mumble [Mumble Certificates](https://wiki.mumble.info/wiki/Mumble_Certificates) +If you don't have a client certificate, you can generate one with this command: + +``` bash +openssl req -x509 -nodes -days 3650 -newkey rsa:2048 -keyout cert.pem -out cert.pem -subj "/CN=mumble-discord-bridge" +``` + ### Binary Prebuilt binaries are available.