Unable to verify via email so blocked from using self-hosted local test instance

Cord42 · August 27, 2024, 10:21pm

Self-hosted local instances for testing say they are sending a verification email upon completion of setup but do not seem to do so in all cases. I have not found information about setup to assist this email successfully being sent or to troubleshoot if unsuccessful in the docs.
Since this email is required to continue using the system after a few days, I’ve been locked out of the instance with a popup that asks me to confirm my account via sending an email, which is the same failing system for verification, so it is impossible to unlock.
I’m running the local instance via docker exactly as described on GitHub - OpenFn/lightning: OpenFn/Lightning ⚡️ is the newest version of the OpenFn DPG and provides a web UI to visually manage complex workflow automation projects.

ayodele · August 28, 2024, 12:05pm

Hey Cord,

OpenFn local deployment uses Swoosh for mailbox preview. You can access this via http://localhost:4000/dev/mailbox. Feel free to change localhost:4000 based on your setup.

taylordowns2000 · August 28, 2024, 1:42pm

Thanks Ayo!

Also, @Cord42 , it took me a while to find this…

github.com

OpenFn/lightning/blob/main/lib/lightning/config/bootstrap.ex#L253-L262


      
          # To actually send emails you need to configure the mailer to use a real
          # adapter. You may configure the swoosh api client of your choice. We
          # automatically configure Mailgun if an API key has been provided. See
          # https://hexdocs.pm/swoosh/Swoosh.html#module-installation for more details.
          if api_key = env!("MAILGUN_API_KEY", :string, nil) do
            config :lightning, Lightning.Mailer,
              adapter: Swoosh.Adapters.Mailgun,
              api_key: api_key,
              domain: env!("MAILGUN_DOMAIN", :string)
          end

We should definitely add a line pointing here from the main docs—possibly in Deployment — Lightning v2.8.1 !

If you’re setting up a local instance, would you mind opening a PR when done with the instructions?

Cord42 · August 28, 2024, 4:33pm

I was able too verify my local instance by using http://localhost:4000/dev/mailbox, thank you very much.
The docs definitely need a step that describes how to verify for a local instance - most developers who wants to test locally will have to do this - just mentioning the link to the mail handler at http://localhost:4000/dev/mailbox in the docs would be super helpful.
Where would you want me to open a PR to? The newer lightning docs you linked to at Lightning v2.8.1 — Documentation don’t have as clear as a path to submitting edits as the docs at https://docs.openfn.org/.