summaryrefslogtreecommitdiff
path: root/docs/content/configuration/notifications/file.md
blob: 08f48d8946ad87230711641a57947793bdc27212 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
---
title: "File System"
description: "Configuring the File Notifications Settings."
summary: "Authelia can save notifications to a file. This section describes how to configure this."
date: 2022-06-15T17:51:47+10:00
draft: false
images: []
weight: 108300
toc: true
aliases:
  - /docs/configuration/notifier/filesystem.html
seo:
  title: "" # custom title (optional)
  description: "" # custom description (recommended)
  canonical: "" # custom canonical URL (optional)
  noindex: false # false (default) or true
---

It is recommended in a production environment that you do not use the file notification system, and that it should only
be used for testing purposes. See one of [the other methods](introduction.md) for a production ready solution.

This method will use the plain text email template for readability purposes.

## Configuration

{{< config-alert-example >}}

```yaml {title="configuration.yml"}
notifier:
  disable_startup_check: false
  filesystem:
    filename: '/config/notification.txt'
```

## Options

This section describes the individual configuration options.

### filename

{{< confkey type="string" required="yes" >}}

The file to add email text to. If it doesn't exist it will be created.