Add authenticated documentation server
- Created docs_server.py with HTTP basic authentication - Added start-docs-server.sh for easy startup - Updated README.md with documentation access instructions - Provides working authentication when .htaccess isn't supported Usage: ./start-docs-server.sh [port] Credentials: langmem / langmem2025 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
39
README.md
39
README.md
@@ -18,6 +18,7 @@ LangMem uses a hybrid approach combining:
|
||||
- 📊 **Rich Metadata**: Flexible memory attributes
|
||||
- 🔒 **Secure API**: Bearer token authentication
|
||||
- 🐳 **Docker Ready**: Containerized deployment
|
||||
- 📚 **Protected Documentation**: Basic auth-protected docs
|
||||
- 🧪 **Comprehensive Tests**: Unit and integration tests
|
||||
|
||||
## Quick Start
|
||||
@@ -278,6 +279,44 @@ For production deployment:
|
||||
4. Set up monitoring and logging
|
||||
5. Configure backup procedures
|
||||
|
||||
## Documentation
|
||||
|
||||
The LangMem project includes comprehensive documentation with authentication protection.
|
||||
|
||||
### Accessing Documentation
|
||||
|
||||
Start the authenticated documentation server:
|
||||
|
||||
```bash
|
||||
# Start documentation server on port 8080 (default)
|
||||
./start-docs-server.sh
|
||||
|
||||
# Or specify a custom port
|
||||
./start-docs-server.sh 8090
|
||||
```
|
||||
|
||||
**Access Credentials:**
|
||||
- **Username:** `langmem`
|
||||
- **Password:** `langmem2025`
|
||||
|
||||
**Available Documentation:**
|
||||
- 📖 **Main Docs**: System overview and features
|
||||
- 🏗️ **Architecture**: Detailed system architecture
|
||||
- 📡 **API Reference**: Complete API documentation
|
||||
- 🛠️ **Implementation**: Step-by-step setup guide
|
||||
|
||||
### Direct Server Usage
|
||||
|
||||
You can also run the documentation server directly:
|
||||
|
||||
```bash
|
||||
python3 docs_server.py [port]
|
||||
```
|
||||
|
||||
Then visit: `http://localhost:8080` (or your specified port)
|
||||
|
||||
Your browser will prompt for authentication credentials.
|
||||
|
||||
## Contributing
|
||||
|
||||
1. Fork the repository
|
||||
|
||||
Reference in New Issue
Block a user