Skip to content

Commit

Permalink
Merge pull request #2183 from dolthub/gitbook-dev
Browse files Browse the repository at this point in the history
update doltlab docs getting started and gmail section
  • Loading branch information
coffeegoddd authored May 3, 2024
2 parents 2923888 + 293657e commit 2180fc6
Show file tree
Hide file tree
Showing 20 changed files with 400 additions and 5 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 4 additions & 3 deletions packages/doltlab/content/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@
## Introduction

- [What is DoltLab?](introduction/what-is-doltlab.md)
- [Installation](introduction/installation.md)
- [Linux](introduction/installation/linux.md)
- [Start DoltLab](introduction/installation/start-doltlab.md)
- [Getting Started](introduction/getting-started.md)

## Guides

- [Installation](guides/installation.md)
- [Linux](guides/installation/linux.md)
- [Start DoltLab](guides/installation/start-doltlab.md)
- [Administrator](guides/administrator/administrator.md)
- [Enterprise](guides/administrator/enterprise.md)
- [Features](guides/features/README.md)
Expand Down
20 changes: 18 additions & 2 deletions packages/doltlab/content/guides/administrator/administrator.md
Original file line number Diff line number Diff line change
Expand Up @@ -421,9 +421,21 @@ Successfully sent email!

# Set up a SMTP Server using any Gmail address

To quickly get up and running with an existing SMTP server, we recommend using [Gmail's](https://www.gmail.com). Once you've created a Gmail account, navigate to [your account page](https://myaccount.google.com/) and click the [Security](https://myaccount.google.com/security) tab. Under the section "How you sign in to Google", click `2-Step Verification`. If you have not yet setup 2-Step Verification, follow the prompts on this page to enable it.
To quickly get up and running with an existing SMTP server, we recommend using [Gmail's](https://www.gmail.com). Once you've created a Gmail account, navigate to [your account page](https://myaccount.google.com/) and click the [Security](https://myaccount.google.com/security) tab. Under the section "How you sign in to Google", click `2-Step Verification`. If you have not yet setup 2-Step Verification, follow the prompts on this page to enable it. You will need to set up 2-step verification before continuing on to the remaining steps.

After 2-Step Verification is set up, at the bottom of the page click "App passwords". Select app `Mail` and select a device, then click "Generate" to generate a password. This generated password can be supplied along with your Gmail email address to send emails with `smtp_connection_helper` and DoltLab.
After 2-Step Verification is set up, at the bottom of the page click "App passwords".

![App passwords on 2-step page](../../../.gitbook/assets/gmail_app_passwords_are_here.png)

If you do not see "App Passwords" at the bottom of this page, return to the Security page and in the search bar, search for "App Passwords".

![App passwords in search](../../../.gitbook/assets/gmail_search_app_passwords.png)

Next, name your app password, then click "Generate." You will be provided a password you can use with your DoltLab instance.

![Generated password](../../../.gitbook/assets/gmail_app_password_no_worky.png)

This generated password can be supplied along with your Gmail email address, as the `username`, to send emails with `smtp_connection_helper` and DoltLab.

```bash
./smtp_connection_helper \
Expand All @@ -438,6 +450,10 @@ Sending email with auth method: plain
Successfully sent email!
```

Importantly, there have been times when these passwords do not work as expected and [we've written a blog post](https://www.dolthub.com/blog/2024-05-03-deconfusing-how-to-use-gmails-smtp-server-in-2024/) about this happening.

In the event the password you generated results in a "Bad credentials" error, try generating a new app password, and using that one instead. For some reason, this seems to work. We do not know the root cause, but as far as we can tell, stems from an issue/bug on Google's side.

<h1 id="prevent-unauthorized-users">Prevent unauthorized user account creation</h1>

DoltLab supports explicit email whitelisting to prevent account creation by unauthorized users.
Expand Down
378 changes: 378 additions & 0 deletions packages/doltlab/content/introduction/getting-started.md

Large diffs are not rendered by default.

0 comments on commit 2180fc6

Please sign in to comment.