Skip to content

Small docs additions #181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Denperidge wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Small docs additions #181

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b735906
Added Caddy instructions to README
Denperidge Apr 6, 2025
137ad80
Added mail & no-mail setup to README
Denperidge Apr 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ Make sure to set the `APP_URL` env to the domain you want to use for your proxy.

Also make sure that the proxy is configured to pass forward important request information like the scheme, host and IP.

#### Nginx
```nginx
location / {
proxy_set_header Connection "";
Expand All @@ -151,6 +152,13 @@ location / {
}
```

#### Caddy
```caddy
input.example.com {
reverse_proxy 127.0.0.1:8080
}
```

### With MySQL

To use MySQL as database, you need to set the following environment variables in your `.env` file:
Expand All @@ -163,3 +171,20 @@ DB_HOST=<MySQL-Host>
DB_USERNAME=<MySQL-User>
DB_PASSWORD=<MySQL-Password>
```

### With e-mail

To allow input to send e-mails, you need to set the following environment variables in your `.env` file:
```dotEnv
### Mail Config
MAIL_MAILER=smtp
MAIL_HOST=
MAIL_USERNAME=
MAIL_PASSWORD=
MAIL_PORT=1025
MAIL_ENCRYPTION=tls
```
The different mailers are defined in [config/mail.php](config/mail.php), but may require additional configuration (see [config/services.php](config/services.php))

### Without e-mail
In case you do not wish to use e-mail, buit still want to invite someone: setting `MAIL_MAILER=log` in your `.env` file will send the invite links (or any e-mails for that matter) to the logs. Note that this the default option for **Docker** configurations.
Loading