From d1f10b63cfe277cb821dc2ec46e0640340bd5f53 Mon Sep 17 00:00:00 2001 From: badaix Date: Tue, 7 Jan 2025 14:45:58 +0100 Subject: [PATCH] Add section about HTTP in configuration.md --- doc/configuration.md | 11 +++++++++++ server/etc/snapserver.conf | 2 -- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/doc/configuration.md b/doc/configuration.md index 70120594..417189e0 100644 --- a/doc/configuration.md +++ b/doc/configuration.md @@ -322,3 +322,14 @@ Use `codec=null` for stream sources that should only serve as input for meta str Streaming clients connect to the server and receive configuration and audio data. The client is fully controlled from the server so clients don't have to persist any state. The `[streaming_client]` section has just one option currently: - `initial_volume`: 0-100 [percent]: The volume a streaming client gets assigned on very first connect (i.e. the client is not known to the server yet). Defaults to 100 if unset. + +## HTTP + +Snapserver supports RPC via HTTP(S) and WS(S) as well as audio streaming over WS(S). To enable HTTP and WS, the parameter `enabled` must be set to `true` (default) in the `[http]` section. + +For HTTPS/WSS, the paramter `ssl_enabled` must be set to `true` (default: `false`) and the `certificate` and `certificate_key` paramters in the `[ssl]` section must point to a certificate file and key file in PEM format. + +Some hints on how to create a certificate and a private key are given for instance here: + +- [Create Root CA (Done once)](https://gist.github.com/fntlnz/cf14feb5a46b2eda428e000157447309) +- [Create Your Own SSL Certificate Authority for Local HTTPS Development](https://deliciousbrains.com/ssl-certificate-authority-for-local-https-development/) diff --git a/server/etc/snapserver.conf b/server/etc/snapserver.conf index 64a2fc46..1e08f815 100644 --- a/server/etc/snapserver.conf +++ b/server/etc/snapserver.conf @@ -50,8 +50,6 @@ # Secure Socket Layer ######################################################### # [ssl] -# https://deliciousbrains.com/ssl-certificate-authority-for-local-https-development/ -# https://gist.github.com/fntlnz/cf14feb5a46b2eda428e000157447309 # Certificate files are either specified by their full or relative path. Certificates with # relative path are searched for in the current path and in "/etc/snapserver/certs"