Skip to content
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.

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

Fix env templateto ensure compatibility with systemd's EnvironmentFile parsing #4315

Merged
merged 2 commits into from
Feb 19, 2024

Conversation

seiuneko
Copy link
Contributor

@seiuneko seiuneko commented Feb 3, 2024

This commit addresses an issue in the Vaultwarden project's .env.template file where comments explaining environment variable options were incorrectly placed on the same line as the variable definitions. Systemd's EnvironmentFile directive only recognizes comment symbols (#) at the beginning of a line. Therefore, explanatory comments placed on the same line as environment variable definitions can lead to misinterpretations or errors when the file is used in a systemd service file.

Adjust env template to ensure compatibility with systemd's EnvironmentFile parsing, which only recognizes line-starting comment symbols.
@stefan0xC
Copy link
Contributor

stefan0xC commented Feb 3, 2024

I'm not happy with just moving the comments on their own line. Can you improve the wording of the smtp security settings? Since the SMTP_PORT default depends on the SMTP_SECURITY setting this could probably be put more succinctly.

vaultwarden/src/config.rs

Lines 656 to 657 in 897bdf8

/// Port
smtp_port: u16, true, auto, |c| if c.smtp_security == *"force_tls" {465} else if c.smtp_security == *"starttls" {587} else {25};

And regarding the ROCKET_PORT I'd say that we should change the default to 8000 and explain that we use port 80 in the container image instead of vice versa.

- Simplify the SMTP_SECURITY and SMTP_PORT options by providing a list of choices and default values
- Clarify the ROCKET_PORT default value depending on the environment (Docker or not)
@seiuneko
Copy link
Contributor Author

seiuneko commented Feb 3, 2024

Thank you for your feedback. Please review the new commit.

@dani-garcia dani-garcia merged commit 94b077c into dani-garcia:main Feb 19, 2024
3 checks passed
truecharts-admin referenced this pull request in truecharts/public Mar 3, 2024
…1.30.5@edb8e2b by renovate (#18748)

This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
|
[docker.io/vaultwarden/server](https://togithub.com/dani-garcia/vaultwarden)
| patch | `1.30.3` -> `1.30.5` |

---

> [!WARNING]
> Some dependencies could not be looked up. Check the Dependency
Dashboard for more information.

---

### Release Notes

<details>
<summary>dani-garcia/vaultwarden
(docker.io/vaultwarden/server)</summary>

###
[`v1.30.5`](https://togithub.com/dani-garcia/vaultwarden/releases/tag/1.30.5)

[Compare
Source](https://togithub.com/dani-garcia/vaultwarden/compare/1.30.4...1.30.5)

#### What's Changed

- fix: web API call for jquery 3.7.1 by
[@&#8203;calvin-li-developer](https://togithub.com/calvin-li-developer)
in
[https://github.com/dani-garcia/vaultwarden/pull/4400](https://togithub.com/dani-garcia/vaultwarden/pull/4400)

#### New Contributors

-
[@&#8203;calvin-li-developer](https://togithub.com/calvin-li-developer)
made their first contribution in
[https://github.com/dani-garcia/vaultwarden/pull/4400](https://togithub.com/dani-garcia/vaultwarden/pull/4400)

**Full Changelog**:
dani-garcia/vaultwarden@1.30.4...1.30.5

###
[`v1.30.4`](https://togithub.com/dani-garcia/vaultwarden/releases/tag/1.30.4)

[Compare
Source](https://togithub.com/dani-garcia/vaultwarden/compare/1.30.3...1.30.4)

⚠️ Note: The WebSockets service for live sync has been integrated in the
main HTTP server, which means simpler proxy setups that don't require a
separate rule to redirect WS traffic to port 3012. Please check the
updated examples in the
[wiki](https://togithub.com/dani-garcia/vaultwarden/wiki/Proxy-examples).
It's recommended to migrate to this new setup as using the old server on
port 3012 is deprecated, won't receive new features and will be removed
in the next release.

#### What's Changed

- Update crates to fix new builds by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4308](https://togithub.com/dani-garcia/vaultwarden/pull/4308)
- Add Kubernetes environment detection by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4290](https://togithub.com/dani-garcia/vaultwarden/pull/4290)
- Update GHA Workflows by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4309](https://togithub.com/dani-garcia/vaultwarden/pull/4309)
- Update Rust, crates and web-vault by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4328](https://togithub.com/dani-garcia/vaultwarden/pull/4328)
- Change the codegen-units for low resources by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4336](https://togithub.com/dani-garcia/vaultwarden/pull/4336)
- Fix env templateto ensure compatibility with systemd's EnvironmentFile
parsing by [@&#8203;seiuneko](https://togithub.com/seiuneko) in
[https://github.com/dani-garcia/vaultwarden/pull/4315](https://togithub.com/dani-garcia/vaultwarden/pull/4315)
- Update crates, GHA and a Python script by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4357](https://togithub.com/dani-garcia/vaultwarden/pull/4357)

#### New Contributors

- [@&#8203;seiuneko](https://togithub.com/seiuneko) made their first
contribution in
[https://github.com/dani-garcia/vaultwarden/pull/4315](https://togithub.com/dani-garcia/vaultwarden/pull/4315)

**Full Changelog**:
dani-garcia/vaultwarden@1.30.3...1.30.4

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 10pm on monday" in timezone
Europe/Amsterdam, Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://togithub.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yMjQuNCIsInVwZGF0ZWRJblZlciI6IjM3LjIyNC40IiwidGFyZ2V0QnJhbmNoIjoibWFzdGVyIn0=-->
arthurgeek referenced this pull request in arthurgeek/vaultwarden-fly-template Mar 18, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [vaultwarden/server](https://togithub.com/dani-garcia/vaultwarden) |
stage | patch | `1.30.1-alpine` -> `1.30.5-alpine` |

---

### Release Notes

<details>
<summary>dani-garcia/vaultwarden (vaultwarden/server)</summary>

###
[`v1.30.5`](https://togithub.com/dani-garcia/vaultwarden/releases/tag/1.30.5)

[Compare
Source](https://togithub.com/dani-garcia/vaultwarden/compare/1.30.4...1.30.5)

#### What's Changed

- fix: web API call for jquery 3.7.1 by
[@&#8203;calvin-li-developer](https://togithub.com/calvin-li-developer)
in
[https://github.com/dani-garcia/vaultwarden/pull/4400](https://togithub.com/dani-garcia/vaultwarden/pull/4400)

#### New Contributors

-
[@&#8203;calvin-li-developer](https://togithub.com/calvin-li-developer)
made their first contribution in
[https://github.com/dani-garcia/vaultwarden/pull/4400](https://togithub.com/dani-garcia/vaultwarden/pull/4400)

**Full Changelog**:
dani-garcia/vaultwarden@1.30.4...1.30.5

###
[`v1.30.4`](https://togithub.com/dani-garcia/vaultwarden/releases/tag/1.30.4)

[Compare
Source](https://togithub.com/dani-garcia/vaultwarden/compare/1.30.3...1.30.4)

⚠️ Note: The WebSockets service for live sync has been integrated in the
main HTTP server, which means simpler proxy setups that don't require a
separate rule to redirect WS traffic to port 3012. Please check the
updated examples in the
[wiki](https://togithub.com/dani-garcia/vaultwarden/wiki/Proxy-examples).
It's recommended to migrate to this new setup as using the old server on
port 3012 is deprecated, won't receive new features and will be removed
in the next release.

#### What's Changed

- Update crates to fix new builds by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4308](https://togithub.com/dani-garcia/vaultwarden/pull/4308)
- Add Kubernetes environment detection by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4290](https://togithub.com/dani-garcia/vaultwarden/pull/4290)
- Update GHA Workflows by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4309](https://togithub.com/dani-garcia/vaultwarden/pull/4309)
- Update Rust, crates and web-vault by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4328](https://togithub.com/dani-garcia/vaultwarden/pull/4328)
- Change the codegen-units for low resources by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4336](https://togithub.com/dani-garcia/vaultwarden/pull/4336)
- Fix env templateto ensure compatibility with systemd's EnvironmentFile
parsing by [@&#8203;seiuneko](https://togithub.com/seiuneko) in
[https://github.com/dani-garcia/vaultwarden/pull/4315](https://togithub.com/dani-garcia/vaultwarden/pull/4315)
- Update crates, GHA and a Python script by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4357](https://togithub.com/dani-garcia/vaultwarden/pull/4357)

#### New Contributors

- [@&#8203;seiuneko](https://togithub.com/seiuneko) made their first
contribution in
[https://github.com/dani-garcia/vaultwarden/pull/4315](https://togithub.com/dani-garcia/vaultwarden/pull/4315)

**Full Changelog**:
dani-garcia/vaultwarden@1.30.3...1.30.4

###
[`v1.30.3`](https://togithub.com/dani-garcia/vaultwarden/releases/tag/1.30.3)

[Compare
Source](https://togithub.com/dani-garcia/vaultwarden/compare/1.30.2...1.30.3)

This is a minor release to fix some issues with push notification device
registration and docker healthcheck.

⚠️ **Note:** The WebSockets service for live sync has been integrated in
the main HTTP server, which means simpler proxy setups that don't
require a separate rule to redirect WS traffic to port 3012. Please
check the updated examples in the
[wiki](https://togithub.com/dani-garcia/vaultwarden/wiki/Proxy-examples).
It's recommended to migrate to this new setup as using the old server on
port 3012 is deprecated, won't receive new features and will be removed
in the next release.

#### What's Changed

- fix push device registration by
[@&#8203;stefan0xC](https://togithub.com/stefan0xC) in
[https://github.com/dani-garcia/vaultwarden/pull/4297](https://togithub.com/dani-garcia/vaultwarden/pull/4297)
- Fix healthcheck when using .env file by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4299](https://togithub.com/dani-garcia/vaultwarden/pull/4299)

**Full Changelog**:
dani-garcia/vaultwarden@1.30.2...1.30.3

###
[`v1.30.2`](https://togithub.com/dani-garcia/vaultwarden/releases/tag/1.30.2)

[Compare
Source](https://togithub.com/dani-garcia/vaultwarden/compare/1.30.1...1.30.2)

⚠️ **Note:** The WebSockets service for live sync has been integrated in
the main HTTP server, which means simpler proxy setups that don't
require a separate rule to redirect WS traffic to port 3012. Please
check the updated examples in the
[wiki](https://togithub.com/dani-garcia/vaultwarden/wiki/Proxy-examples).
It's recommended to migrate to this new setup as using the old server on
port 3012 is deprecated, won't receive new features and will be removed
in the next release.

#### What's Changed

- Prevent generating an error during ws close by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4127](https://togithub.com/dani-garcia/vaultwarden/pull/4127)
- Update Rust, Crates, Profile and Actions by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4126](https://togithub.com/dani-garcia/vaultwarden/pull/4126)
- Several small fixes for open issues by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4143](https://togithub.com/dani-garcia/vaultwarden/pull/4143)
- Fix the version string by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4153](https://togithub.com/dani-garcia/vaultwarden/pull/4153)
- Decrease JWT Refresh/Auth token by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4163](https://togithub.com/dani-garcia/vaultwarden/pull/4163)
- Update crates by [@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4173](https://togithub.com/dani-garcia/vaultwarden/pull/4173)
- Add additional build target which optimizes for size by
[@&#8203;gladiac](https://togithub.com/gladiac) in
[https://github.com/dani-garcia/vaultwarden/pull/4096](https://togithub.com/dani-garcia/vaultwarden/pull/4096)
- Update web-vault to v2023.12.0 by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4201](https://togithub.com/dani-garcia/vaultwarden/pull/4201)
- Update Rust and Crates by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4211](https://togithub.com/dani-garcia/vaultwarden/pull/4211)
- Fix Single Org Policy check by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4207](https://togithub.com/dani-garcia/vaultwarden/pull/4207)
- Allow customizing the featureStates by
[@&#8203;PKizzle](https://togithub.com/PKizzle) in
[https://github.com/dani-garcia/vaultwarden/pull/4168](https://togithub.com/dani-garcia/vaultwarden/pull/4168)
- Fix
[#&#8203;3413](https://togithub.com/dani-garcia/vaultwarden/issues/3413):
push to users accessing the collections using groups by
[@&#8203;matlink](https://togithub.com/matlink) in
[https://github.com/dani-garcia/vaultwarden/pull/3757](https://togithub.com/dani-garcia/vaultwarden/pull/3757)
- US or EU Data Region Selection by
[@&#8203;toto-xoxo](https://togithub.com/toto-xoxo) in
[https://github.com/dani-garcia/vaultwarden/pull/3752](https://togithub.com/dani-garcia/vaultwarden/pull/3752)
- enforce 2FA policy on removal of second factor and login by
[@&#8203;stefan0xC](https://togithub.com/stefan0xC) in
[https://github.com/dani-garcia/vaultwarden/pull/3803](https://togithub.com/dani-garcia/vaultwarden/pull/3803)
- improve emergency access when not enabled by
[@&#8203;stefan0xC](https://togithub.com/stefan0xC) in
[https://github.com/dani-garcia/vaultwarden/pull/4227](https://togithub.com/dani-garcia/vaultwarden/pull/4227)
- Update crates and fix icon issue by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4237](https://togithub.com/dani-garcia/vaultwarden/pull/4237)
- Bump h2 from 0.3.23 to 0.3.24 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/dani-garcia/vaultwarden/pull/4260](https://togithub.com/dani-garcia/vaultwarden/pull/4260)
- Fix bulk collection deletion by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4257](https://togithub.com/dani-garcia/vaultwarden/pull/4257)
- fix: use black text for update badge (better contrast) by
[@&#8203;tessus](https://togithub.com/tessus) in
[https://github.com/dani-garcia/vaultwarden/pull/4245](https://togithub.com/dani-garcia/vaultwarden/pull/4245)
- prevent side effects if groups are disabled by
[@&#8203;stefan0xC](https://togithub.com/stefan0xC) in
[https://github.com/dani-garcia/vaultwarden/pull/4265](https://togithub.com/dani-garcia/vaultwarden/pull/4265)
- Update crates, web-vault to 2024.1.2 and GHA by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4275](https://togithub.com/dani-garcia/vaultwarden/pull/4275)
- Return 404 when user public_key is empty by
[@&#8203;Timshel](https://togithub.com/Timshel) in
[https://github.com/dani-garcia/vaultwarden/pull/4271](https://togithub.com/dani-garcia/vaultwarden/pull/4271)
- Improve file limit handling by
[@&#8203;dani-garcia](https://togithub.com/dani-garcia) in
[https://github.com/dani-garcia/vaultwarden/pull/4242](https://togithub.com/dani-garcia/vaultwarden/pull/4242)
- Fix attachment upload size check by
[@&#8203;BlackDex](https://togithub.com/BlackDex) in
[https://github.com/dani-garcia/vaultwarden/pull/4282](https://togithub.com/dani-garcia/vaultwarden/pull/4282)
- err on invalid feature flag by
[@&#8203;stefan0xC](https://togithub.com/stefan0xC) in
[https://github.com/dani-garcia/vaultwarden/pull/4263](https://togithub.com/dani-garcia/vaultwarden/pull/4263)
- register missing push devices at login by
[@&#8203;stefan0xC](https://togithub.com/stefan0xC) in
[https://github.com/dani-garcia/vaultwarden/pull/3792](https://togithub.com/dani-garcia/vaultwarden/pull/3792)
- Update env template file by
[@&#8203;gzfrozen](https://togithub.com/gzfrozen) in
[https://github.com/dani-garcia/vaultwarden/pull/4276](https://togithub.com/dani-garcia/vaultwarden/pull/4276)

#### New Contributors

- [@&#8203;gladiac](https://togithub.com/gladiac) made their first
contribution in
[https://github.com/dani-garcia/vaultwarden/pull/4096](https://togithub.com/dani-garcia/vaultwarden/pull/4096)
- [@&#8203;PKizzle](https://togithub.com/PKizzle) made their first
contribution in
[https://github.com/dani-garcia/vaultwarden/pull/4168](https://togithub.com/dani-garcia/vaultwarden/pull/4168)
- [@&#8203;matlink](https://togithub.com/matlink) made their first
contribution in
[https://github.com/dani-garcia/vaultwarden/pull/3757](https://togithub.com/dani-garcia/vaultwarden/pull/3757)
- [@&#8203;toto-xoxo](https://togithub.com/toto-xoxo) made their first
contribution in
[https://github.com/dani-garcia/vaultwarden/pull/3752](https://togithub.com/dani-garcia/vaultwarden/pull/3752)
- [@&#8203;Timshel](https://togithub.com/Timshel) made their first
contribution in
[https://github.com/dani-garcia/vaultwarden/pull/4271](https://togithub.com/dani-garcia/vaultwarden/pull/4271)
- [@&#8203;gzfrozen](https://togithub.com/gzfrozen) made their first
contribution in
[https://github.com/dani-garcia/vaultwarden/pull/4276](https://togithub.com/dani-garcia/vaultwarden/pull/4276)

**Full Changelog**:
dani-garcia/vaultwarden@1.30.1...1.30.2

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "on saturday" (UTC), Automerge - At
any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/arthurgeek/vaultwarden-fly-template).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xNTMuMiIsInVwZGF0ZWRJblZlciI6IjM3LjIyMC4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants