mirror of
https://github.com/onyx-dot-app/documentation.git
synced 2026-07-25 13:46:14 -04:00
Wenxi
0b57d1540d
* draft revamp * cleanup * open source statement * Yuhong * initial security tab cleanup * Yuhong * Yuhong * developer docs initial commit * Adding RDS Docs * Yuhong * Yuhong * k * Yuhong * Yuhong * welcome page * api reference lints * overview use cases * new rich content * more overview pages + admin connectors mock * fix simple exmaple * over view chat interface * api reference docs * more api guides * developers guides and api reference * fix next steps * capitalize Chat and move api guides * fix images and use style.css * more chat page * deployment init * more deployment * resourcing guide * more resourcing * oauth/oidc/saml * oidc/saml pictures * ec2 guide * rework deployment guides * more deployment guides * fix broken links * configuration options * deployment/ee and release process * formatting * ignore macos files * tab icons * EE env vars * rename admin dashboard and prep welcome page for launch * fix actions folder * Yuhong * chat overview * continue revising overview tab * . * Yuhong * Security Tab Done * Yuhong * icons * k * more overview * comments on landing page * fix actions dir * reorganize connectors and ai configs * evan's SF docs * formatting * . * more admin docs * more admin docs * more admin docs * pre-commit * . * llm config docs * admin docs + slack bot * slackbot * ee snippet * bedrock * Yuhong * ai models * vertex and bedrock * custom inference + formatting * img * alt text * typo * format * Yuhong * k * alt text * k * . * custom provider * ollama * k * k * connectors * connectors * format * actions and snippet * actions * k * k * k * admin docs * k * k * . * formatting * new docs * archive * archive * clean up * advanced configs * onyx cli * cleanup * . --------- Co-authored-by: Yuhong Sun <yuhongsun96@gmail.com> Co-authored-by: justin-tahara <justintahara@gmail.com>
101 lines
2.3 KiB
Plaintext
101 lines
2.3 KiB
Plaintext
---
|
|
title: "Basic Auth"
|
|
description: "Set up Onyx with basic username/password authentication"
|
|
icon: "user-lock"
|
|
---
|
|
|
|
Basic Auth is the easiest way to get started with Onyx. However, we recommend using Google OAuth, OIDC,
|
|
or SAML for production deployments.
|
|
|
|
<Tip>
|
|
If you have questions about which authentication approach is best for your organization,
|
|
don't hesitate to [contact us](https://docs.onyx.app/contact_us)
|
|
- we're happy to help you choose the right solution.
|
|
</Tip>
|
|
|
|
## Basic Setup
|
|
|
|
**Using Docker:**
|
|
|
|
In your `.env` file, set:
|
|
|
|
```bash
|
|
AUTH_TYPE=basic
|
|
```
|
|
|
|
**Using Helm:**
|
|
|
|
In your `values.yaml` file, set:
|
|
|
|
```yaml
|
|
configMap:
|
|
AUTH_TYPE: basic
|
|
```
|
|
|
|
If you don't need email verification, you're done!
|
|
|
|
Restart Onyx to apply the changes and the next time you visit the site,
|
|
you'll be prompted to create an account and set a password.
|
|
|
|
<Accordion title="Password Requirements">
|
|
- 12+ characters
|
|
- 1 number
|
|
- 1 special character
|
|
- 1 uppercase letter
|
|
- 1 lowercase letter
|
|
</Accordion>
|
|
|
|
## Basic Auth with Email Verification
|
|
|
|
Enabling email verification blocks your users from signing in until they click their verification email.
|
|
|
|
**Using Docker:**
|
|
|
|
Set the following in your `.env` file:
|
|
|
|
```bash
|
|
AUTH_TYPE=basic
|
|
|
|
# Enable email verification
|
|
REQUIRE_EMAIL_VERIFICATION=true
|
|
|
|
# Email configuration
|
|
SMTP_USER=<EMAIL_TO_SEND_VERIFICATION_EMAILS_FROM> # e.g. noreply@yourcompany.com
|
|
SMTP_PASS=<PASSWORD_FOR_THE_EMAIL_ABOVE>
|
|
|
|
# Required for non-Gmail accounts
|
|
SMTP_SERVER=<YOUR_SMTP_SERVER>
|
|
SMTP_PORT=<PORT_YOUR_SMTP_SERVER_LISTENS_ON> # default: 587
|
|
```
|
|
|
|
**Using Helm:**
|
|
|
|
Set the following in your `values.yaml` file:
|
|
|
|
```yaml
|
|
auth:
|
|
secrets:
|
|
smpt_pass: <PASSWORD_FOR_THE_SMTP_USER>
|
|
configMap:
|
|
AUTH_TYPE: basic
|
|
|
|
REQUIRE_EMAIL_VERIFICATION: true
|
|
SMTP_USER: <EMAIL_TO_SEND_VERIFICATION_EMAILS_FROM>
|
|
|
|
# Required for non-Gmail accounts
|
|
SMTP_SERVER: <YOUR_SMTP_SERVER>
|
|
SMTP_PORT: <PORT_YOUR_SMTP_SERVER_LISTENS_ON>
|
|
```
|
|
|
|
## Next Steps
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Set up Google OAuth" icon="google" href="/deployment/authentication/oauth">
|
|
Google OAuth is a secure and easy way to authenticate users with their Google accounts.
|
|
</Card>
|
|
|
|
<Card title="Other Onyx Configuration Options" icon="gear" href="/deployment/configuration/configuration">
|
|
There are many other configuration options available for Onyx.
|
|
</Card>
|
|
</CardGroup>
|