Configuration

SegnoSharp has several runtime configuration options. As SegnoSharp is designed to primarily be used as a Docker Container these configuration options are usually set as environment variables. Environments supporting Docker containers can usually also use secrets, which are recommended for sensitive configuration options like Authentication. Refer to the documentation for your environment to learn how to use secrets.

If you are cloning the SegnoSharp repository, compiling and running it locally then you should use User Secrets.

Note

All environment variables must be prefixed by SegnoSharp_. This prefix is not displayed below for brevity.

Note

Configuration options are displayed using dot-notation. For environment variables replace dots with two underscores. For User Secrets either replace dots with colons, or create a corresponding JSON structure.

Configuration of database and authentication are covered in their respective chapters.

Site configuration

SiteConfig.DataPath	Absolute path or relative to working directory	Directory used for additional persistent data handling, i.e. SQLite database
SiteConfig.LibPath	Absolute path or relative to working directory	Directory used for BASS and other binaries
SiteConfig.MusicPath	Absolute path or relative to working directory	This is the default directory SegnoSharp will read music from
SiteConfig.StartPage	Relative to root of website	If the user accesses the root of the website (/) they will be redirected to this path. This path will not be validated. Relative to BasePath, so no need to start with a /.
SiteConfig.SharedSecret	Secret string value	Used by IHashingUtil to generate hashes unique to your installation
Modules.ModulesFolder	Absolute path or relative to working directory	Change this if you want to load modules from another folder.

Proxies

You can run SegnoSharp behind a proxy. Simply set the SiteConfig.BehindProxy to true. This will enable the ForwardedHeaders middleware in .NET. Make sure your proxy properly sets the X-Forwarded-Proto, X-Forwarded-Host, and X-Forwarded-For headers to the correct values.

Virtual directory

A feature often combined with the proxy functionality is to run SegnoSharp in a virtual directory. If you don’t want to run SegnoSharp on the root of your web server, you can set the SiteConfig.BasePath to another path. This will make SegnoSharp accessible at https://yourdomain.com/<BasePath> instead of the root of the domain.

Note

Make sure that the BasePath both starts and ends with a /. For example: /segnosharp/.

Examples using environment variables:

SegnoSharp_SiteConfig__BehindProxy=true
SegnoSharp_SiteConfig__BasePath=/segnosharp/

BASS

SegnoSharp uses the BASS audio libraries from un4seen (see the corresponding chapter in prerequisites). These libraries are not free for all use, so check if you need a license registration. See also the relevant chapter in the FAQ This registration can be placed in the following configuration options:

BASS.Registration.Key	Secret string value	Your BASS registration key
BASS.Registration.Email	Secret string value	Your BASS registration email

Logging

SegnoSharp logs to both console and file by default, using Serilog. The Serilog configuration can be overridden by setting environment variables, or changing the appsettings.json in the main application if running it from a cloned repo. In the following example the Serilog.Sinks.File is modified to keep the latest 14 log files instead of the default 7:

SegnoSharp_Serilog__WriteTo__1__Args__retainedFileCountLimit=14

You can also overwrite the existing console logger by changing the 1 to 0 in the above example.

For more settings to override, see the documentation for Serilog.Settings.Configuration.

Data protection

.NET uses Data Protection to protect sensitive data, such as authentication cookies. Keys are generated and stored in a folder defined by DataProtection:Folder inside the SiteConfig:DataPath folder. This folder is created automatically when SegnoSharp starts.

The keys can optionally be encrypted using a PFX certificate that includes a private key. You can optionally set the DataProtection:CertificateFile to point to a certificate file in the same folder, and define the password for the certificate in DataProtection:CertificatePassword.

Even though the encryption is optional, it is highly recommended to enable it, even if it only uses a self-signed certificate.

Examples using environment variables:

SegnoSharp_DataProtection__CertificateFile=MyCertificate.pfx
SegnoSharp_DataProtection__CertificatePassword=MyPassword