mirror of
https://github.com/jamiepine/voicebox.git
synced 2026-09-15 12:50:42 -07:00
Jamie Pine
7b5e73cfa8
- Created a new .npmrc file to enforce bun usage. - Bumped version numbers for multiple packages to 0.1.9 in bun.lock. - Added react-sound-visualizer dependency to enhance audio visualization features. - Introduced convert:assets script in package.json for asset optimization. - Updated CONTRIBUTING.md with instructions for converting assets to web formats. - Added documentation files for API endpoints and developer guidelines in the docs directory.
56 lines
1.1 KiB
Plaintext
56 lines
1.1 KiB
Plaintext
---
|
|
title: "Authentication"
|
|
description: "API authentication and security"
|
|
---
|
|
|
|
## Current Status
|
|
|
|
<Warning>
|
|
Authentication is not currently implemented in Voicebox. The API is intended for local use only.
|
|
</Warning>
|
|
|
|
## Local Usage
|
|
|
|
For local development and usage:
|
|
- API runs on `localhost:17493`
|
|
- No authentication required
|
|
- Access restricted to local machine
|
|
|
|
## Future Implementation
|
|
|
|
Authentication will be added in a future release for:
|
|
- Remote deployments
|
|
- Multi-user access
|
|
- Production environments
|
|
|
|
Planned authentication methods:
|
|
- API keys
|
|
- OAuth 2.0
|
|
- JWT tokens
|
|
|
|
## Security Best Practices
|
|
|
|
Until authentication is implemented:
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Use VPN" icon="shield">
|
|
Use WireGuard or Tailscale for remote access
|
|
</Card>
|
|
<Card title="Reverse Proxy" icon="server">
|
|
Run behind nginx with basic auth
|
|
</Card>
|
|
<Card title="Firewall" icon="fire">
|
|
Restrict access to trusted IPs only
|
|
</Card>
|
|
<Card title="Local Only" icon="laptop">
|
|
Don't expose to public internet
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## Coming Soon
|
|
|
|
- API key management
|
|
- User accounts
|
|
- Rate limiting
|
|
- Access control
|