Merge pull request #99 from inventree/email-docs

Email docs

_includes/config.yaml

@@ -63,6 +63,31 @@ currencies:
   - NZD
   - USD
 
+# Email backend configuration
+# Ref: https://docs.djangoproject.com/en/dev/topics/email/
+# Available options:
+# host: Email server host address
+# port: Email port
+# username: Account username
+# password: Account password
+# prefix: Email subject prefix
+# tls: Enable TLS support
+# ssl: Enable SSL support
+
+# Alternatively, these options can all be set using environment variables,
+# with the INVENTREE_EMAIL_ prefix:
+# e.g. INVENTREE_EMAIL_HOST / INVENTREE_EMAIL_PORT / INVENTREE_EMAIL_USERNAME
+# Refer to the InvenTree documentation for more information
+
+email:
+  # backend: 'django.core.mail.backends.smtp.EmailBackend'
+  host: ''
+  port: 25
+  username: ''
+  password: ''
+  tls: False
+  ssl: False
+
 # Set debug to False to run in production mode
 # Use the environment variable INVENTREE_DEBUG
 debug: True
@@ -95,9 +120,9 @@ cors:
   # - https://sub.example.com
 
 # MEDIA_ROOT is the local filesystem location for storing uploaded files
-# By default, it is stored under /home/inventree
+# By default, it is stored under /home/inventree/data/media
 # Use environment variable INVENTREE_MEDIA_ROOT
-media_root: '/home/inventree/media'
+media_root: '/home/inventree/data/media'
 
 # STATIC_ROOT is the local filesystem location for storing static files
 # By default, it is stored under /home/inventree
@@ -116,7 +141,7 @@ static_root: '/home/inventree/static'
 # Set the backup_dir parameter to store backup files in a specific location
 # If unspecified, the local user's temp directory will be used
 # Use environment variable INVENTREE_BACKUP_DIR
-backup_dir: '/home/inventree/backup/'
+backup_dir: '/home/inventree/data/backup/'
 
 # Permit custom authentication backends
 #authentication_backends:

docs/admin/email.md

@@ -0,0 +1,13 @@
+---
+title: Email Configured
+---
+
+## Email Settings
+
+InvenTree can be configured to send emails to users, for various purposes.
+
+To enable this, email configuration settings must be supplied to the InvenTree [configuration options](../../start/config#email-settings).
+
+!!! info "Password Reset"
+    The *Password Reset* functionality requires the email backend to be correctly configured.
+

docs/releases/0.2.1.md

@@ -8,6 +8,13 @@ title: Release 0.2.1
 
 ## New Features
 
+### Email Support
+
+[#1304](https://github.com/inventree/InvenTree/pull/1304) adds support for email support. Initially, this is used for sending users emails to perform a password reset
+
+!!! warning "Configuration Required"
+    Refer to the [email configuration options](../../start/config/#email-settings).
+
 ## Major Bug Fixes
 
 | PR | Description |

docs/start/config.md

@@ -42,10 +42,10 @@ In addition to specifying InvenTree options via the `config.yaml` file, these op
 
 The following basic options are available:
 
-| Environment Variable | Settings File | Description |
-| --- | --- | --- |
-| INVENTREE_DEBUG | debug | Enable debug mode |
-| INVENTREE_LOG_LEVEL | log_level | Set level of logging to terminal |
+| Environment Variable | Settings File | Description | Default |
+| --- | --- | --- | --- |
+| INVENTREE_DEBUG | debug | Enable debug mode | True |
+| INVENTREE_LOG_LEVEL | log_level | Set level of logging to terminal | WARNING |
 
 ## Secret Key
 
@@ -73,15 +73,30 @@ Database options are specified under the *database* heading in the configuration
 
 The following database options can be configured:
 
-| Environment Variable | Settings File | Description |
-| --- | --- | --- |
-| INVENTREE_DB_ENGINE | database.ENGINE | Database backend |
-| INVENTREE_DB_NAME | database.NAME | Database name |
-| INVENTREE_DB_USER | database.USER | Database username (if required) |
-| INVENTREE_DB_PASSWORD | database.PASSWORD | Database password (if required) |
-| INVENTREE_DB_HOST | database.HOST | Database host address (if required) |
-| INVENTREE_DB_PORT | database.PORT | Database host port (if required) |
+| Environment Variable | Settings File | Description | Default |
+| --- | --- | --- | --- |
+| INVENTREE_DB_ENGINE | database.ENGINE | Database backend | *Not set* |
+| INVENTREE_DB_NAME | database.NAME | Database name | *Not set* |
+| INVENTREE_DB_USER | database.USER | Database username (if required) | *Not set* |
+| INVENTREE_DB_PASSWORD | database.PASSWORD | Database password (if required) | *Not set* |
+| INVENTREE_DB_HOST | database.HOST | Database host address (if required) | *Not set* |
+| INVENTREE_DB_PORT | database.PORT | Database host port (if required) | *Not set* |
 
+## Email Settings
+
+To enable [email functionality](../../admin/email), email settings must be configured here, either via environment variables or within the configuration file.
+
+The following email settings are available:
+
+| Environment Variable | Settings File | Description | Default |
+| --- | --- | --- | --- |
+| INVENTREE_EMAIL_BACKEND | email.backend | Email backend module | django.core.mail.backends.smtp.EmailBackend |
+| INVENTREE_EMAIL_HOST | email.host | Email server host | *Not set* |
+| INVENTREE_EMAIL_PORT | email.port | Email server port | 25 |
+| INVENTREE_EMAIL_USERNAME | email.username | Email account username | *Not set* |
+| INVENTREE_EMAIL_PASSWORD | email.password | Email account password | *Not set* |
+| INVENTREE_EMAIL_TLS | email.tls | Enable TLS support | False |
+| INVENTREE_EMAIL_SSL | email.ssl | Enable SSL support | False |
 
 ## Allowed Hosts / CORS
 

mkdocs.yml

@@ -90,6 +90,7 @@ nav:
     - Import Data: admin/import.md
     - Python Shell: admin/shell.md
     - Error Logs: admin/logs.md
+    - Email: admin/email.md
     - Background Tasks: admin/tasks.md
   - Extend:
     - API: extend/api.md