Skip to content

Commit 792b369

Browse files
docs: update README
1 parent 45c9e5b commit 792b369

File tree

2 files changed

+32
-12
lines changed

2 files changed

+32
-12
lines changed

README.md

+31-11
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,20 @@ Bridge email to other messaging services.
1111

1212
[![Screenshot](https://static.gurnain.com/github/smtpbridge/demo-small.png)](https://static.gurnain.com/github/smtpbridge/demo.png)
1313

14+
# Features
15+
16+
- Envelopes that contain subject, from, to, text, html, and attachments of an email
17+
- Endpoints for sending envelopes
18+
- Rules for matching envelopes
19+
- SMTP server that creates envelopes
20+
- HTTP server
21+
- Create, view, and delete envelopes
22+
- View and test endpoints
23+
- Create, view, update, and delete rules
24+
- Authentication for HTTP and SMTP servers
25+
- Retention policy for deleting old envelopes
26+
- Healthcheck for monitoring
27+
1428
# Use Cases
1529

1630
- Pictures from IP cameras
@@ -27,6 +41,12 @@ It is recommended to delete `smtpbridge_data` on every minor release and also ch
2741
smtpbridge
2842
```
2943

44+
## Show Help
45+
46+
```
47+
smtpbridge -help
48+
```
49+
3050
## Show Version
3151

3252
```
@@ -93,7 +113,7 @@ rules:
93113
debug: false
94114
95115
# Used by HTTP, ...
96-
time_format: 12h # (12h, 24h)
116+
time_format: 12h # [12h, 24h]
97117
98118
# Directory for storing data
99119
data_directory: smtpbridge_data
@@ -105,51 +125,51 @@ python_executable: python3
105125
# You can use a third party service such as healthchecks.io
106126
healthcheck:
107127
# URL to fetch, empty means health checking is disabled
108-
url: "" # (https://hc-ping.com/cb8bcf81-d3c4-4c98-85a6-734c3b7ddb2b, ...)
128+
url: "" # [https://hc-ping.com/cb8bcf81-d3c4-4c98-85a6-734c3b7ddb2b, ...]
109129
110130
# Interval between each fetch
111-
interval: 5m # (5m, 5h45m, ...)
131+
interval: 5m # [5m, 5h45m, ...]
112132
113133
# Run on startup
114134
startup: false
115135
116136
# Retention policy will delete resources that pass the configured policy
117137
retention:
118138
# Envelopes in database
119-
envelope_count: # (0, 100, 250, ...)
120-
envelope_age: # (5m, 5h45m, ...)
139+
envelope_count: # [0, 100, 250, ...]
140+
envelope_age: # [5m, 5h45m, ...]
121141
122142
# Attachment files in file store
123-
attachment_size: # (100 MB, 1 GB, ...)
143+
attachment_size: # [100 MB, 1 GB, ...]
124144
125145
# Traces in database
126-
trace_age: 168h # 7 days (5m, 5h45m, ...)
146+
trace_age: 168h # 7 days [5m, 5h45m, ...]
127147
128148
# HTTP server
129149
http:
130150
disable: false
131-
host: "" # (127.0.0.1, ...)
151+
host: "" # [127.0.0.1, ...]
132152
port: 8080
133153
134154
# Authentication is disabled if both username and password are empty
135155
username: ""
136156
password: ""
137157
138158
# Public URL
139-
url: "" # (http://127.0.0.1:8080, ...)
159+
url: "" # [http://127.0.0.1:8080, ...]
140160
141161
# SMTP server
142162
smtp:
143163
disable: false
144-
host: "" # (127.0.0.1, ...)
164+
host: "" # [127.0.0.1, ...]
145165
port: 1025
146166
147167
# Authentication is disabled if both username and password are empty
148168
username: ""
149169
password: ""
150170
151171
# Maximum payload size
152-
max_payload_size: 25 MB
172+
max_payload_size: 25 MB # [100 MB, 1 GB, ...]
153173
154174
# Endpoints for envelopes
155175
endpoints:

entrypoint.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ if [ -n "$APPRISE_ENABLE" ]; then
1010
fi
1111
fi
1212

13-
/usr/bin/smtpbridge --data-directory=/data
13+
/usr/bin/smtpbridge -data-directory=/data

0 commit comments

Comments
 (0)