Skip to content

Commit 15186c1

Browse files
authored
Add setup docs for self-hosted email registration [skip ci]
1 parent e81d9de commit 15186c1

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ Contents
2929
1. [Other](#other)
3030
1. [How It Works / Security](#how-it-works--security)
3131
1. [Self-Hosting](#self-hosting)
32-
1. [Notes](#notes)
32+
- [Access](#access)
33+
- [Email Registration](#email-registration)
3334
1. [CLI Configuration](#cli-configuration)
3435
1. [Development](#development)
3536
1. [Requirements](#requirements)
@@ -116,7 +117,7 @@ volumes:
116117
You should create your own `.env` file with whichever variables needed to customize your instance
117118
(see: [Environment Variables](#environment-variables)).
118119

119-
### Notes
120+
#### Access
120121

121122
When self-hosting, the web interface must be accessed either from a secure context (HTTPS/TLS) or
122123
from the same machine the service is hosted on (`localhost` or `0.0.0.0`).
@@ -129,13 +130,35 @@ generate a cert and set the `YEETFILE_TLS_CERT` and `YEETFILE_TLS_KEY` environme
129130
> This does not apply to the CLI tool. You can still use all features of YeetFile from the CLI tool
130131
> without a secure connection.
131132
133+
#### Email Registration
134+
135+
To set up email registration for your self-hosted instance, you need to define the following environment
136+
variables:
137+
138+
```sh
139+
# The email address to use for correspondence
140+
YEETFILE_EMAIL_ADDR=...
141+
142+
# The host of the email address being used
143+
YEETFILE_EMAIL_HOST=...
144+
145+
# The port of the email host
146+
YEETFILE_EMAIL_PORT=...
147+
148+
# The SMTP login for the email address
149+
YEETFILE_EMAIL_USER=...
150+
151+
# The SMTP password for the email address
152+
YEETFILE_EMAIL_PASSWORD=...
153+
```
154+
132155
## CLI Configuration
133156

134157
The YeetFile CLI tool can be configured using a `config.yml` file in the following path:
135158

136159
**Linux/macOS**: `~/.config/yeetfile/config.yml`
137160

138-
**Windows**: `%AppData%\yeetfile`
161+
**Windows**: `%AppData%\yeetfile\config.yml`
139162

140163
When you initially launch the CLI tool, it will create this directory and add a default `config.yml`:
141164

0 commit comments

Comments
 (0)