Correct format of SMTP E-Mail String in .env file

tarator

Hello,

I'm setting up an Funkwhale instance right now and have problems to figure out the correct format of the SMTP Connection String in my .env file.
I'm using docker-compose and multi-container installation.

For example, if my Email-address is no-reply@funkwhale.example, my SMTP-Password is pass123 and the SMTP-Server's name is smtp.somedomain.com using STARTTLS listening on port 587 (Note the difference between email domain and smtp-server-domain)

How would the connection string in my .env file look like? I tried many different options, none of them worked.

This is the current example (is this correct? the first @-sign confuses me.

EMAIL_CONFIG=smtp+tls://user@:password@youremail.host:587

# I tried to go for the following, but didn't work
EMAIL_CONFIG=smtp+tls://no-reply@funkwhale.example@:pass123@smtp.somedomain.com:587

tarator

WORKS, after I read in the file common.py that special-chars need to be escaped. Especially the @ character needs to be replaced with %40 in the username which is the full e-mail-address in my case.

EMAIL_CONFIG=smtp+tls://no-reply%40funkwhale.example@:pass123@smtp.somedomain.com:587

gcrk

Most likely something to fix in the documentation? cc @Sporiff

tarator

I added the information in the file env.prod.example and created a Merge request

Lucius

Hello @tarator

thank you for add this information on doc, i search too for that.

I my side, i have found this command for escaped user and password if needed :
python3 -c 'import urllib.parse; print(urllib.parse.quote_plus("put_your_user_or_pwd_here"))'

On my side, i get already error for create user :

Aug 12 10:52:33 services gunicorn[1645175]: smtplib.SMTPAuthenticationError: (535, b'5.7.8 Error: authentication failed: UGFzc3dvcmQ6')

I have escaped my smtp user : user%40.domain.ndd
I have beautiful password without escaped need

I have test my account via echo "hello there username." | msmtp -a default username@domain.com
=> work well

EMAIL_CONFIG=smtp+tls://user%40domain.tld@:beautiful_pwd@domain.tld:587
=> not for funkwhale with good params ...

gcrk

Thats done with https://dev.funkwhale.audio/funkwhale/funkwhale/-/merge_requests/1350