fleet/docs/Contributing
Lucas Manuel Rodriguez 40265d0e6f
Fix SMTP e-mail send when SMTP server has credentials (#10758)
#9609

This PR also fixes #10777.

The issue is: We were using `svc.AppConfig` instead of
`svc.ds.AppConfig` to retrieve the SMTP credentials.
`svc.AppConfig` obfuscates credentials, whereas `svc.ds.AppConfig` does
not.
To help prevent this from happening again I've renamed `svc.AppConfig`
to `svc.AppConfigObfuscated`.
I've also added a new test SMTP server
(https://github.com/axllent/mailpit) that supports Basic Authentication
and tests that make use of it to catch these kind of bugs (the tests are
executed when running `go test` with `MAIL_TEST=1`).

- [X] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- ~[ ] Documented any API changes (docs/Using-Fleet/REST-API.md or
docs/Contributing/API-for-contributors.md)~
- ~[ ] Documented any permissions changes~
- ~[ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)~
- ~[ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.~
- [X] Added/updated tests
- [X] Manual QA for all new/changed functionality
  - ~For Orbit and Fleet Desktop changes:~
- ~[ ] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.~
- ~[ ] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).~
2023-03-28 15:23:15 -03:00
..
Adding-new-endpoints.md Set interface for response types (#9121) 2022-12-27 11:26:59 -03:00
API-for-contributors.md Feat/implement api for disk encryption status aggregate (#10422) 2023-03-28 15:50:14 +01:00
API-Versioning.md Replace references to /api/latest/fleet with /api/v1/fleet (#7464) 2022-08-31 09:51:25 -05:00
Building-Fleet.md Adding WSL integration links (#8738) 2022-11-17 17:07:22 -03:00
Committing-Changes.md change relative links in documentation (#8441) 2022-10-26 18:26:49 -05:00
Configuration-for-contributors.md Remove packs from docs (#9452) 2023-01-20 16:47:24 -06:00
FAQ.md Update list of endpoints (#10013) 2023-02-27 16:51:02 -06:00
Fleet-UI-Testing.md removing cypress references for e2e and add docs for QA wolf (#10382) 2023-03-08 16:00:57 +00:00
Migrations.md change relative links in documentation (#8441) 2022-10-26 18:26:49 -05:00
Orbit-development-and-release-strategy.md Docs: add missing pageOrderInSection meta tag (#8104) 2022-10-06 11:04:36 -05:00
README.md Run-Locally-Built-Orbit (#9359) 2023-01-19 10:31:24 -06:00
Releasing-Fleet.md Update Releasing-Fleet.md (#10692) 2023-03-23 12:29:16 -05:00
Run-Locally-Built-Orbit.md Run-Locally-Built-Orbit (#9359) 2023-01-19 10:31:24 -06:00
Seeding-Data.md Documentation: Seeding data links to creating test hosts (#8131) 2022-10-10 14:08:18 -04:00
Simulate-slow-network.md Add guide on how to simulate slow connections to redis and mysql (#9140) 2023-01-03 17:29:40 -03:00
Testing-and-local-development.md Fix SMTP e-mail send when SMTP server has credentials (#10758) 2023-03-28 15:23:15 -03:00

Contributing

Building Fleet

Learn about building the code, development infrastructure, and database migrations.

Build And Run Orbit From Local Code

Building and running your modified code.

Testing

Look at Fleet's full test suite and integration tests.

Migrations

Learn about creating and updating database migrations.

Committing changes

Learn how to merge changes into the codebase.

Releasing Fleet

Learn the process for how to release Fleet.

Seeding data

Learn how to add fake data to your development instance.

API for contributors

Get to grips with Fleet API routes. This documentation is helpful for developing or contributing to Fleet.

FAQ

Find commonly asked questions and answers about contributing to Fleet as part of our community.