@@ -29,7 +29,8 @@ Contents
29
29
1 . [ Other] ( #other )
30
30
1 . [ How It Works / Security] ( #how-it-works--security )
31
31
1 . [ Self-Hosting] ( #self-hosting )
32
- 1 . [ Notes] ( #notes )
32
+ - [ Access] ( #access )
33
+ - [ Email Registration] ( #email-registration )
33
34
1 . [ CLI Configuration] ( #cli-configuration )
34
35
1 . [ Development] ( #development )
35
36
1 . [ Requirements] ( #requirements )
@@ -116,7 +117,7 @@ volumes:
116
117
You should create your own ` .env ` file with whichever variables needed to customize your instance
117
118
(see: [ Environment Variables] ( #environment-variables ) ).
118
119
119
- ### Notes
120
+ #### Access
120
121
121
122
When self-hosting, the web interface must be accessed either from a secure context (HTTPS/TLS) or
122
123
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
129
130
> This does not apply to the CLI tool. You can still use all features of YeetFile from the CLI tool
130
131
> without a secure connection.
131
132
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
+
132
155
## CLI Configuration
133
156
134
157
The YeetFile CLI tool can be configured using a ` config.yml ` file in the following path:
135
158
136
159
** Linux/macOS** : ` ~/.config/yeetfile/config.yml `
137
160
138
- ** Windows** : ` %AppData%\yeetfile `
161
+ ** Windows** : ` %AppData%\yeetfile\config.yml `
139
162
140
163
When you initially launch the CLI tool, it will create this directory and add a default ` config.yml ` :
141
164
0 commit comments