{"id":28414418,"url":"https://github.com/faun/local-open-webui","last_synced_at":"2025-06-25T06:32:29.149Z","repository":{"id":286858998,"uuid":"926836639","full_name":"faun/local-open-webui","owner":"faun","description":"Spawn a local open-webui instance easily","archived":false,"fork":false,"pushed_at":"2025-04-08T17:31:22.000Z","size":6,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-03T18:28:12.202Z","etag":null,"topics":["ai","docker-compose","openweb"],"latest_commit_sha":null,"homepage":"https://localhost","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/faun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-04T00:00:42.000Z","updated_at":"2025-04-08T17:31:25.000Z","dependencies_parsed_at":"2025-04-08T18:44:26.704Z","dependency_job_id":null,"html_url":"https://github.com/faun/local-open-webui","commit_stats":null,"previous_names":["faun/local-open-webui"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/faun/local-open-webui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faun%2Flocal-open-webui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faun%2Flocal-open-webui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faun%2Flocal-open-webui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faun%2Flocal-open-webui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/faun","download_url":"https://codeload.github.com/faun/local-open-webui/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faun%2Flocal-open-webui/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261819083,"owners_count":23214427,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","docker-compose","openweb"],"created_at":"2025-06-03T08:15:18.688Z","updated_at":"2025-06-25T06:32:29.142Z","avatar_url":"https://github.com/faun.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Local AI with Open WebUI and Caddy\n\nThis project provides a streamlined local development environment using Docker Compose with automatic SSL certificate management. It sets up a secure local environment with Open WebUI and Caddy as a reverse proxy.\n\n## Prerequisites\n\n- Docker and Docker Compose\n- mkcert (for SSL certificate generation)\n- make (usually pre-installed on Unix-based systems)\n\n### Installing mkcert\n\nmkcert is required for generating trusted SSL certificates for local development.\n\n**macOS:**\n```bash\nbrew install mkcert\n```\n\n**Linux:**\n```bash\nsudo apt install mkcert    # Ubuntu/Debian\nsudo dnf install mkcert    # Fedora\n```\n\n**Windows:**\n```bash\nchoco install mkcert\n```\n\n## Getting Started\n\n1. Clone this repository\n2. Generate SSL certificates:\n   ```bash\n   make certs\n   ```\n3. Start the services:\n   ```bash\n   make start\n   ```\n\nThe environment will be available at https://localhost (or https://$WEBUI_DOMAIN, if configured).\n\n## Available Commands\n\n### Certificate Management\n- `make certs` - Generate SSL certificates for local development\n- `make clean` - Remove generated certificates\n\n### Service Management\n- `make start` - Start all services (alias: `make up`)\n- `make stop` - Stop all services (alias: `make down`)\n- `make rm` - Remove services and volumes\n- `make logs` - View service logs in follow mode\n- `make restart` - Restart all services\n- `make update` - Pull latest images and restart services\n- `make status` - Show current service status\n\n### Container Updates\n- `make watchtower` - Update containers using Watchtower (one-time check)\n\n## Configuration\n\nThe project uses a `.env` file for configuration. If it doesn't exist, it will be automatically created when running `make start`.\n\n### Default Domains\n\nThe SSL certificates are configured for:\n- Your domain (set the WEBUI_DOMAIN environment variable)\n- localhost\n- 127.0.0.1\n- ::1 (IPv6 localhost)\n\n## Architecture\n\nThe environment consists of two main services:\n1. **Open WebUI** - Main application interface\n2. **Caddy** - Reverse proxy handling SSL termination\n\n## Troubleshooting\n\n1. **Certificate Issues**\n   - Run `make clean` followed by `make certs` to regenerate certificates\n   - Ensure mkcert is properly installed\n\n2. **Service Won't Start**\n   - Check if ports are available using `make status`\n   - Review logs with `make logs`\n\n3. **Container Updates**\n   - Use `make update` to pull latest images\n   - For automatic updates, consider running Watchtower as a service\n\n## Development Workflow\n\n1. Start the services:\n   ```bash\n   make start\n   ```\n\n2. View logs while services are running:\n   ```bash\n   make logs\n   ```\n\n3. When finished, stop the environment:\n   ```bash\n   make stop\n   ```\n\n## Contributing\n\n1. Ensure you have the latest certificates and images:\n   ```bash\n   make clean certs\n   make update\n   ```\n\n2. Test your changes thoroughly\n3. Submit a pull request with a clear description of your changes\n\n## License\n\nSee [LICENSE](./LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffaun%2Flocal-open-webui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffaun%2Flocal-open-webui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffaun%2Flocal-open-webui/lists"}