openwebui / README.md
owlninjam's picture
Upload 4 files
7c1a9d1 verified
---
title: OpenWebUI with Data Sync
emoji: πŸ”„
colorFrom: blue
colorTo: purple
sdk: docker
pinned: true
app_port: 8080
suggested_hardware: cpu-basic
suggested_storage: medium
short_description: OpenWebUI with automated GitHub data sync
tags:
- openwebui
- chat
- llm
- ai
- docker
- data-sync
- backup
models:
- openai-community/gpt2
datasets:
- openwebui/openwebui
---
# OpenWebUI with Data Synchronization
A self-hosted OpenWebUI instance with automated data backup and synchronization to GitHub repositories.
## Features
- πŸ€– **OpenWebUI Interface**: Full-featured chat interface for AI models
- πŸ”„ **Automated Data Sync**: Automatic backup to GitHub repository every hour
- πŸ”’ **Private Storage**: Secure data storage in your private GitHub repo
- πŸ“Š **Persistent Data**: Never lose your conversations and settings
- 🐳 **Docker Ready**: Easy deployment on Hugging Face Spaces
## Environment Variables
Set these in your Space's Repository secrets:
### Required
- `G_NAME`: Your GitHub repository (e.g., `username/repo-name`)
- `G_TOKEN`: GitHub Personal Access Token with repo access
### Optional
- `WEBDAV_URL`: WebDAV server URL for additional backup
- `WEBDAV_USERNAME`: WebDAV username
- `WEBDAV_PASSWORD`: WebDAV password
## Setup Instructions
1. Create a private GitHub repository for data backup
2. Generate a GitHub Personal Access Token with repo permissions
3. Add the environment variables to your Space's Repository secrets
4. Deploy and enjoy persistent OpenWebUI!
## Data Synchronization
The system automatically:
- Syncs every hour (08:00-24:00 Beijing time)
- Backs up `webui.db` to your GitHub repository
- Creates versioned commits with timestamps
- Handles conflicts and retries on failures
Check out the [configuration reference](https://huggingface.co/docs/hub/spaces-config-reference) for more details.