wutta/wuttafarm
3
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

docs: add some notes on email setup

Browse source
This commit is contained in:
Lance Edgar 2026-02-14 08:44:24 -06:00
parent 34cb6b210d
commit 35068c0cb1
1 changed files with 36 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

39
docs/narr/install.rst
View file

@ -53,9 +53,9 @@ The app installer (last command above) will prompt you for DB
credentials, and the farmOS URL. credentials, and the farmOS URL.
One of the questions is about data versioning with One of the questions is about data versioning with
:doc:`wutta-continuum:index`. This feature will be leveraged more in :doc:`wutta-continuum:index`. You should probaby enable that even
the future but for the moment doesn't do a whole lot in this app. You though as of writing the default is disabled. It adds "revision
are encouraged to enable it anyway. history" for most types of records in the WuttaFarm app DB.
When the installer completes it will output a command you can then use When the installer completes it will output a command you can then use
to run the web app. Do that and you can then view the app in a to run the web app. Do that and you can then view the app in a
@ -116,6 +116,39 @@ consumer:
importing.client_secret = you_cant_guess_me importing.client_secret = you_cant_guess_me
Email Setup
-----------
WuttaFarm can send emails of various kinds; of note are:
* when user submits Feedback via button in top right of screen
* importer diff warning for farmOS → WuttaFarm
That last one is optional, triggered via the ``-W`` flag in the
importer command line.
Anyway the app basically assumes there is a Postfix or similar mail
server running on "localhost" which it can use as the SMTP server, and
which is in turn responsible for "really" sending the email out via
some configured relay. This has always worked very well for me since
I tend to want to have email working for other reasons on each Linux
server I maintain. (And since I have not traditionally used Docker
and/or containers.)
So if you need something else, touch base and we'll figure something
out. But assuming localhost is okay to use:
In the web app menu, see Admin -> App Info and then click Configure.
Check the box to enable email and plug in the default sender and
recipient (which should be the admin responsible for the app). I
often create an alias so I can use e.g. wuttafarm@edbob.org as
sender - aliased back to myself in case it generates bounces so I can
see them.
From there you can also see Admin -> Email Settings in the menu; this
lets you control and preview each type of email separately.
Import Data from farmOS Import Data from farmOS
----------------------- -----------------------