diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..7b5d028 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,27 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to a positive environment include: +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Focusing on what is best for the overall community + +Examples of unacceptable behavior include: +- The use of sexualized language or imagery, and sexual attention or advances of any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, without their explicit permission + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team at [info@openwebui.com](mailto:info@openwebui.com). All complaints will be reviewed and investigated promptly and fairly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html). \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f3e5357 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing to Open WebUI + +Thank you for your interest in contributing to our ecosystem! We welcome contributions of all kinds, from fixing bugs and improving documentation to suggesting new features. + +## Getting Started + +The best place to start is our comprehensive **[Contributing Tutorial](https://docs.openwebui.com/tutorials/tips/contributing-tutorial)**, which is part of our official documentation. It covers everything you need to know, including: + +- Setting up your development environment. +- Our coding standards and style guides. +- The process for submitting a Pull Request. + +## Code of Conduct + +All contributors are expected to abide by our [Code of Conduct](./CODE_OF_CONDUCT.md) to ensure our community remains a welcoming and respectful environment for everyone. + +## Reporting Issues + +- For bugs or feature requests related to the main application, please open an issue in the [**open-webui/open-webui**](https://github.com/open-webui/open-webui/issues) repository. +- For issues related to documentation, please use the [**open-webui/docs**](https://github.com/open-webui/docs/issues) repository. + +We look forward to your contributions! \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..60fed17 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Open WebUI Community Health Files + +## About This Repository + +This is a special repository used to manage community health and configuration files for the entire **Open WebUI** organization on GitHub. + +The files and configurations defined here provide defaults for all other repositories under our organization, ensuring a consistent and welcoming environment for our community. + +### What's Inside? + +* **`profile/README.md`**: This file contains the content for our main organization profile page, which you can see at [github.com/open-webui](https://github.com/open-webui). + +* **`CONTRIBUTING.md`**: Our central guide for new and existing contributors. It outlines the general process for contributing to any of our projects. + +* **`CODE_OF_CONDUCT.md`**: The code of conduct that applies to all our community spaces, ensuring a safe and respectful environment for everyone. + +* **`SECURITY.md`**: Provides instructions on how to responsibly report security vulnerabilities you might find in our projects. + +--- + +To explore the main Open WebUI application, please visit our primary repository at [**open-webui/open-webui**](https://github.com/open-webui/open-webui). \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..f11f902 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,16 @@ +# Security Policy + +The Open WebUI team takes security seriously. We appreciate your efforts to responsibly disclose your findings, and we will make every effort to acknowledge your contributions. + +## Reporting a Vulnerability + +If you believe you have found a security vulnerability in any of our projects, please **do not** report it via public GitHub issues. + +Instead, please send an email to us at **[security@openwebui.com](mailto:security@openwebui.com)**. + +Please include the following details with your report: +- A description of the vulnerability and its potential impact. +- Steps to reproduce the issue, including any proof-of-concept code. +- The repository and version affected. + +We will work with you to resolve the issue promptly. \ No newline at end of file diff --git a/profile/README.md b/profile/README.md index 2c3e1b4..124913c 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,2 +1,33 @@ -# Building the best AI user interface. -Created by [Tim J. Baek](https://github.com/tjbck) +# Welcome to Open WebUI 👋 + +![Open WebUI Demo](./demo.gif) + +**Open WebUI is an [extensible](https://docs.openwebui.com/features/plugin/), feature-rich, and user-friendly self-hosted AI platform designed to operate entirely offline.** It supports various LLM runners like **Ollama** and **OpenAI-compatible APIs**, making it a powerful and versatile AI deployment solution. + +Our goal is to build the best open-source user interface for AI. + +--- + +### 🚀 Key Repositories + +Explore our core projects to get started: + +| Repository | Description | Stars | +|---|---|---| +| основной [**open-webui/open-webui**](https://github.com/open-webui/open-webui) | The main user interface for Ollama and other LLMs. | ![GitHub stars](https://img.shields.io/github/stars/open-webui/open-webui?style=social) | +| 📚 [**open-webui/docs**](https://github.com/open-webui/docs) | The source code for our official documentation at [docs.openwebui.com](https://docs.openwebui.com/). | ![GitHub stars](https://img.shields.io/github/stars/open-webui/docs?style=social) | +| 🧩 [**open-webui/pipelines**](https://github.com/open-webui/pipelines) | The official plugin framework for extending Open WebUI's capabilities. | ![GitHub stars](https://img.shields.io/github/stars/open-webui/pipelines?style=social) | +| 🛠️ [**open-webui/functions**](https://github.com/open-webui/functions) | A curated collection of high-quality custom functions for Open WebUI. | ![GitHub stars](https://img.shields.io/github/stars/open-webui/functions?style=social) | + +--- + +### 💬 Get Involved + +We believe in the power of community and welcome you to get involved. + +- **Join our Community on [Discord](https://discord.gg/5rJgQTnV4s)** to chat with other users and developers. +- **Read our [Contribution Guide](https://github.com/open-webui/.github/blob/main/CONTRIBUTING.md)** to learn how you can help improve the project. +- **Become a [Sponsor](https://github.com/sponsors/tjbck)** to support the development of Open WebUI. +- **Passionate about open-source AI? [Join our team →](https://careers.openwebui.com/)** + +Created by [Timothy Jaeryang Baek](https://github.com/tjbck) and a global community of contributors. \ No newline at end of file