Details for different port/address added

[granth23]

Problem

The documentation lacked information about necessary configuration changes for users working with a port other than 8100 or a host other than localhost.

Solution

Updated the configuration file to include details for working with different ports or hosts. Added a note in the server documentation for user assistance regarding the same:

• For a development server running on a port other than 8100, update the SERVER_ROOT_URL field with the correct port number.
• For a development server running on a host other than localhost (e.g., GitHub Codespaces), update the SERVER_NAME and SERVER_ROOT_URL fields with the appropriate host details.

Action

• Please review the added documentation and configuration file for clarity and completeness.
• Let me know if any additional details or corrections are required.
• If the changes look good, kindly proceed with merging the PR.

[MonkeyDo]

Thanks for working on improving this!
I have some suggestions to limit the amount of modifications required and streamline the setup a bit.

[MonkeyDo]

There are potentially quite a few more configuration lines that would need to be modified, so I wonder if a more generic advice such as "search for 8100 in the config file and replace it with the port you want to use" or something along those lines would be more suited and more future-proof.

For example, API_URL, SPOTIFY_CALLBACK_URL and other callback URLs use the port number.

Alternatively, you could modify the sample config again to replace localhost:8100 with SERVER_ROOT_URL in an f-string like we do for MUSICBRAINZ_BASE_URL :

listenbrainz-server/listenbrainz/config.py.sample

Line 85 in 82e3eb6

OAUTH_AUTHORIZE_URL = f"{MUSICBRAINZ_BASE_URL}/new-oauth2/authorize"

[granth23]

Made the necessary changes by using a f-string format.

[MonkeyDo]

Can you explain why setting this SERVER_NAME is required?
I only see it use in the testing framework so i am wondering.

As mentioned in my previous comment, this could potentially use the value of SERVER_ROOT_URL?

[granth23]

In situations where generating absolute external URLs is required, such as during OAuth redirection, Flask relies on the SERVER_NAME configuration. Without setting SERVER_NAME, Flask defaults to localhost, which can lead to incorrect or invalid redirect URLs. To ensure OAuth and similar features point to the correct local or production URL, it is necessary to configure SERVER_NAME with the actual base URL of the application.

While SERVER_ROOT_URL serves as a full external-facing URL, it is not directly usable for Flask’s purposes since it includes the protocol (http:// or https://), which Flask does not interpret in SERVER_NAME. Therefore, the two values, while related, cannot be interchanged directly.

You can refer to the attached Flask Documentation.

[MonkeyDo]

Newline deleted automatically? You might need to adjust your code editor settings to not remove them automatically.

[granth23]

Will look into it.