204941a1dc
- Created a detailed database schema document outlining tables, relationships, and key fields. - Added OAuth integration documentation covering Spotify and Dropbox authentication processes. - Introduced a FAQ section addressing common user inquiries about the application. - Developed a user-friendly index page for easy navigation of the documentation. - Specified documentation dependencies in requirements.txt for building the documentation site. - Expanded user guide with sections on account management, creating rounds, exporting rounds, getting started, importing songs, and user interface navigation. - Updated mkdocs.yml for improved site structure and navigation.
3.4 KiB
3.4 KiB
Account Management
This guide explains how to manage your Quizzical Beats account, including profile settings, integrations, and authentication options.
Profile Settings
Manage your personal information and preferences:
- Click your username in the top-right corner
- Select "Profile" from the dropdown menu
- Here you can:
- Update your username
- Change your email address
- Edit your first and last name
- Modify your password
- Update your Dropbox export path
Authentication Methods
Quizzical Beats supports multiple authentication methods:
Local Username/Password
- Go to Profile > Change Password
- You can:
- Update your current password
- View your last login time
OAuth Providers
Connect and use third-party authentication:
- Navigate to your Profile page
- Here you can connect/disconnect:
- Spotify account
- Google account (if enabled by your administrator)
- Dropbox account (for file exports)
- Authentik (if enabled by your administrator)
Email-Based Account Identification
Quizzical Beats uses your email address as the primary identifier for your account, which provides several benefits:
Single Account Across Login Methods
- If you login with username/password and later use Google or Authentik with the same email address, you'll be automatically logged into the same account
- There's no need to manually link accounts - the system recognizes you based on your email
- Your profile data, saved rounds, and settings remain consistent regardless of how you login
For example:
- You register with username "musicfan" and email "you@example.com"
- Later, you click "Sign in with Google" using the same email "you@example.com"
- The system will recognize and log you into your existing "musicfan" account
- All your data, settings, and history will be preserved
Switching Between Login Methods
You can freely alternate between:
- Username/password login
- Google authentication (if enabled)
- Authentik authentication (if enabled)
As long as all methods use the same email address, you'll always access the same account.
Benefits
- Simplified Experience: No need to remember which login method you used previously
- Data Consistency: Your preferences and data remain unified across login methods
- Flexible Authentication: Choose the most convenient login method for your current situation
Managing OAuth Connections
For each connected service:
- View connection status and details
- Disconnect services when needed
- Re-authorize when tokens expire
- See token expiration information
Custom Audio Files
Upload and manage your custom audio files:
- Navigate to Profile > Audio Settings
- Here you can:
- Upload custom intro music
- Upload custom outro music
- Upload custom replay sound
- Generate audio using text-to-speech
Account Security
Keep your account secure:
- Use a strong, unique password
- Log out from shared computers
- Check your last login time
- Review connected applications regularly
Troubleshooting
Can't Log In:
- Try the "Forgot Password" option
- Check that you're using the correct OAuth provider
- Clear browser cookies and cache
- Contact your administrator if problems persist
OAuth Connection Issues:
- Disconnect and reconnect the service
- Ensure you're granting all required permissions
- Check that your third-party account is active and in good standing