Skip to content

Add a few more options for self-hosting#833

Merged
vamsi merged 10 commits intomakeplane:developfrom
kylewlacy:self-hosting-tweaks
Apr 21, 2023
Merged

Add a few more options for self-hosting#833
vamsi merged 10 commits intomakeplane:developfrom
kylewlacy:self-hosting-tweaks

Conversation

@kylewlacy
Copy link
Contributor

@kylewlacy kylewlacy commented Apr 15, 2023

This PR adds a few more settings to address some papercuts I ran into while I was setting up a self-hosted instance of Plane.

Just to go over the changes:

  • Added $EMAIL_USE_TLS to optionally disable TLS when sending emails via SMTP. I added this because I have been using MailHog to test email delivery locally (which doesn't support TLS as far as I cant tell).
  • Added $EMAIL_PORT change the port used when sending emails via SMTP. Port 587 still seems like the right default, but my understanding is that there's not even consensus that this is the "one true" SMTP port. Again, I added this because of MailHog (which uses port 1025 by default).
  • Added $EMAIL_FROM to set the sender name/address. I needed this so I could switch over to sending emails through a real SMTP server (AWS SES in my case).
  • Added $REDIS_BROKER_SSL to optionally disable the extra TLS settings that are added to the Celery Redis connection string. I added this in the first version of the PR, but removed it since a fix for this issue already landed on develop.
  • Added $AWS_S3_ENDPOINT_URL to set the setting of the same name. I used this to use SeaweedFS for file uploads while self-hosting.
  • Added $NEXT_PUBLIC_EXTRA_IMAGE_DOMAINS. This option is used to add more domains (comma-separated) to the next/images config. Without this setting, I wasn't able to actually use the images that were being uploaded to S3 (avatar URLs, for example).

@vercel
Copy link

vercel bot commented Apr 15, 2023

@kylewlacy is attempting to deploy a commit to the Caravel Team on Vercel.

A member of the Team first needs to authorize it.

@vihar
Copy link
Contributor

vihar commented Apr 17, 2023

Thanks for your contribution @kylewlacy, this is great. We will review this shortly and get back to you.

@vihar vihar requested review from pablohashescobar and vamsi April 17, 2023 09:16
@vihar vihar added the Plane label Apr 17, 2023
@kylewlacy
Copy link
Contributor Author

I pushed a few extra changes to resolve merge conflicts, to add support for setting AWS_S3_ENDPOINT_URL using an env var, and to remove the $REDIS_BROKER_SSL setting/env-var (since this is no longer necessary after some changes on develop).

@kylewlacy
Copy link
Contributor Author

Alright, just added one more change, which I think this is the final one I needed for my self-hosting setup. The new option is the $NEXT_PUBLIC_EXTRA_IMAGE_DOMAINS env var, which is a comma-separated list of domains to add for the next/images list of allowed domains.

@pablohashescobar
Copy link
Member

pablohashescobar commented Apr 20, 2023

Hi @kylewlacy, The PR looks good I have approved it we will merge it shortly to our develop branch. Thanks for your contribution.

Copy link
Contributor

@vamsi vamsi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@vamsi vamsi merged commit 2016205 into makeplane:develop Apr 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants