From 2782d924d36cd1ed3df48b9c4dba3fb77bc4c247 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=98=AD?= <81747598+lan-yonghui@users.noreply.github.com> Date: Tue, 3 Dec 2024 21:59:18 +0800 Subject: [PATCH] docs: Add English README (#2662) --- adguardhome/README_en.md | 19 ++++++++++ adminer/README_en.md | 17 +++++++++ code-server/README_en.md | 14 ++++++++ drawio/README_en.md | 14 ++++++++ go/README_en.md | 25 +++++++++++++ home-assistant/README_en.md | 29 +++++++++++++++ java/README_en.md | 25 +++++++++++++ jellyfin/README_en.md | 15 ++++++++ jenkins/README_en.md | 11 ++++++ jumpserver/README_en.md | 27 ++++++++++++++ memos/README_en.md | 11 ++++++ minio/README_en.md | 4 +-- mongodb/README_en.md | 41 ++++++++++++++++++++++ nextcloud/README_en.md | 29 +++++++++++++++ node/README_en.md | 21 +++++++++++ ollama-webui/README.md | 70 +++++++++++++++++++------------------ ollama-webui/README_en.md | 40 +++++++++++++++++++++ pgadmin4/README_en.md | 44 +++++++++++++++++++++++ portainer-ce/README_en.md | 36 +++++++++++++++++++ sftpgo/README_en.md | 16 +++++++++ stirling-pdf/README_en.md | 11 ++++++ 21 files changed, 483 insertions(+), 36 deletions(-) create mode 100644 adguardhome/README_en.md create mode 100644 adminer/README_en.md create mode 100644 code-server/README_en.md create mode 100644 drawio/README_en.md create mode 100644 go/README_en.md create mode 100644 home-assistant/README_en.md create mode 100644 java/README_en.md create mode 100644 jellyfin/README_en.md create mode 100644 jenkins/README_en.md create mode 100644 jumpserver/README_en.md create mode 100644 memos/README_en.md create mode 100644 mongodb/README_en.md create mode 100644 nextcloud/README_en.md create mode 100644 node/README_en.md create mode 100644 ollama-webui/README_en.md create mode 100644 pgadmin4/README_en.md create mode 100644 portainer-ce/README_en.md create mode 100644 sftpgo/README_en.md create mode 100644 stirling-pdf/README_en.md diff --git a/adguardhome/README_en.md b/adguardhome/README_en.md new file mode 100644 index 000000000..8d3e254d5 --- /dev/null +++ b/adguardhome/README_en.md @@ -0,0 +1,19 @@ +# AdGuard Home + +AdGuard Home is an open-source network-wide ad blocker and privacy protection tool. It filters ads, trackers, and malicious websites on your home network, offering a safer and cleaner browsing experience. + +## Main Features + +- **Ad Blocking**:Blocks intrusive ads on websites, including image ads, text ads, and video ads, ensuring an ad-free browsing experience. + +- **Tracker Blocking**:Prevents websites from using trackers to collect data about your online activities, safeguarding your privacy and reducing the risk of personal data leaks. + +- **Malicious Website Blocking**:Detects and blocks attempts to access malicious websites, protecting users from malware, phishing, and fraudulent activities. + +- **Home Network Protection**:Protects all devices connected to the same network, such as computers, smartphones, tablets, and smart home devices, without requiring individual installations. + +- **Custom Rules**:Allows users to create custom rules for precise control over filtering behavior, such as allowing or blocking specific websites or content. + +- **DNS Blocking**:Works by intercepting DNS requests at the network level, eliminating the need for plugins or software installations on each device to filter ads and harmful content. + +- **Statistics and Logs**:Provides detailed traffic statistics and logs, showing the number of ads blocked, malicious websites intercepted, and more, helping users understand their network activity. \ No newline at end of file diff --git a/adminer/README_en.md b/adminer/README_en.md new file mode 100644 index 000000000..52d14fbeb --- /dev/null +++ b/adminer/README_en.md @@ -0,0 +1,17 @@ +# Adminer + +Adminer is a lightweight database management tool that allows users to manage various types of databases through a simple web interface, including MySQL, PostgreSQL, SQLite, and more. + +## Main Features: + +- **Cross-Database Support**: Adminer supports multiple database systems, enabling you to manage different types of databases under a unified interface. +- **Simple and Easy to Use**: Adminer features an intuitive user interface, requiring no complex installation or configuration process, allowing for quick startup. +- **Data Query and Editing**: You can execute SQL queries, view, and edit data within the database using Adminer. Custom SQL commands are supported. +- **Table Structure Management**: Adminer allows you to create, modify, and delete tables, define fields, primary keys, and indexes. +- **Import and Export**: Easily import and export data, supporting various data formats such as SQL, CSV, and Excel. +- **Database Backup**: Adminer allows you to create database backups to ensure data security and recoverability. +- **Permission Management**: You can manage database users and permissions, controlling who can access and modify the database. +- **Query History**: Adminer saves the history of executed queries for convenient review and re-execution later. +- **Multi-Language Support**: Adminer offers interfaces in multiple languages to meet the needs of different users. +- **Custom Appearance**: Supports custom themes and interface styles to adapt Adminer to your personal preferences. +- **Open Source and Free**: Adminer is open-source software, free to use and customize. diff --git a/code-server/README_en.md b/code-server/README_en.md new file mode 100644 index 000000000..52bcc6e29 --- /dev/null +++ b/code-server/README_en.md @@ -0,0 +1,14 @@ +# code-server + +**code-server** is a powerful open-source tool that brings [Visual Studio Code (VS Code)](https://code.visualstudio.com/) into a web-based environment. It allows you to securely connect to that remote machine from anywhere through a local VS Code client, without the requirement of SSH. + +## Main Features: + +- **Remote Development**: Allows you to access your development environment from anywhere using a web browser. This means you can write, edit, and run code consistently across different devices and operating systems. +- **Lightweight**: A lightweight application with low resource consumption, making it efficient to run on servers with limited resources. This makes it an ideal tool for providing a unified development environment for teams or for cloud-based development. +- **Rich Extension Ecosystem**: You can install and use the extensive library of VS Code extensions to expand the editor’s functionality. This includes language support, themes, code snippets, workflow automation, and more. +- **Multi-Language Support**: Provides broad support for programming languages, including JavaScript, Python, Java, C++, etc. You can handle multiple programming tasks within a unified development environment. +- **Integrated Terminal**: It includes an integrated terminal that lets you run commands, install dependencies, and run applications within the same interface. +- **Version Control**: Integrated version control systems (such as Git) make it easy to manage and track changes to your code. +- **Team Collaboration**: Allows multiple developers to collaborate simultaneously by sharing workspaces and codebases, enhancing team collaboration. +- **Customizable Settings**: You can customize the editor's settings according to your needs, including themes, shortcuts, and workspace configurations. \ No newline at end of file diff --git a/drawio/README_en.md b/drawio/README_en.md new file mode 100644 index 000000000..ee759845f --- /dev/null +++ b/drawio/README_en.md @@ -0,0 +1,14 @@ +# Draw.io + +**Draw.io** is a popular online diagramming tool for creating various charts and diagrams, including flowcharts, organizational charts, network diagrams, mind maps, and more. + +## Main Features: + +- **Variety of Diagram Types**: Provides a wide range of pre-defined diagram types, making it easy to create different types of visuals. +- **Online Editing**: Edit diagrams directly in your browser without the need to install additional software. +- **Export**: Export diagrams in multiple formats such as PNG, JPEG, SVG, PDF, and more. +- **Real-Time Collaboration**: Allows multiple users to edit the same diagram simultaneously, perfect for team projects. +- **Template Library**: Offers various templates to accelerate the creation process. +- **Custom Styles**: Customize element styles, colors, and fonts to meet specific needs. +- **Version Control**: Supports version history to review and restore previous versions of diagrams. +- **Embedded**: Embed diagrams into websites or documents for easy sharing with others. \ No newline at end of file diff --git a/go/README_en.md b/go/README_en.md new file mode 100644 index 000000000..d0adb11a4 --- /dev/null +++ b/go/README_en.md @@ -0,0 +1,25 @@ +# Golang + +Golang (also known as Go) is a statically typed, compiled programming language developed by Google. Renowned for its simplicity, robustness, and high performance, it is particularly suited for building efficient and scalable server-side applications. + +## Main Features: + +- **High Performance**: Golang is renowned for its efficient compilation and execution speed. The executables it generates are very small, with fast startup and execution times, making it ideal for building high-performance servers and microservices. + +- **Simplicity and Clarity**: One of Golang's design goals is to maintain the simplicity and readability of the language. It avoids many complex features, focusing on clear and concise code to improve developer productivity. + +- **Concurrency**: Golang natively supports concurrent programming, providing a simple and powerful concurrency model through goroutines and channels, making it easier to build highly concurrent applications. + +- **Memory Management**: Golang features an automatic garbage collection mechanism, reducing the burden on developers to manually manage memory and lowering the risks of memory leaks and related errors. + +- **Standard Library**: Golang comes with a rich and powerful standard library that covers common needs such as network programming, file handling, and data structures, significantly simplifying the development process. + +- **Static Typing**: Golang is a statically typed language, which allows the compiler to catch most errors during compilation, enhancing the reliability and maintainability of the code. + +- **Cross-Platform**: Golang can run on various operating systems, including Windows, Linux, and macOS, allowing developers to write code once and compile and execute it across multiple platforms. + +- **Built-in Tools**: Golang provides a range of built-in tools, such as gofmt for code formatting, godoc for generating documentation, and go test for testing code, greatly improving the development experience. + +- **Modular Design**: Golang supports modular programming with modules and packages, helping organize code more clearly and making it easier to maintain. + +- **Community Support**: Golang has a large and active developer community, where developers can easily find libraries and tools to extend its functionality and receive support and feedback from the community. \ No newline at end of file diff --git a/home-assistant/README_en.md b/home-assistant/README_en.md new file mode 100644 index 000000000..606060694 --- /dev/null +++ b/home-assistant/README_en.md @@ -0,0 +1,29 @@ +# Home Assistant + +Home Assistant is a smart home automation platform that offers extensive features and flexibility to control and automate various smart devices and services in your home. + +## Main Features + +### Device Integration + +Home Assistant integrates with a wide range of smart devices, including smart lights, outlets, temperature sensors, cameras, and smart speakers. It supports multiple communication protocols such as Z-Wave, Zigbee, and Wi-Fi, allowing seamless integration of devices from various brands and types into a single platform. + +### Automation + +Home Assistant enables you to create automation scripts that respond to specific events or conditions. You can set triggers, such as time, device states, or sensor readings, and define corresponding actions like turning on lights, sending notifications, or performing other tasks. This allows you to create convenient and sophisticated home automation scenarios. + +### Remote Control and Monitoring + +Using Home Assistant, you can remotely control and monitor your smart devices through a unified interface. Manage lighting, heating, cooling, and security systems from your mobile device or computer. Additionally, you can view live video streams from connected cameras to ensure home security. + +### Security + +Home Assistant prioritizes security by offering authentication and access control features. You can configure user permissions to ensure that only authorized individuals can remotely access and control your smart home system. + +### Custom Themes + +Home Assistant allows you to customize the interface theme to match your personal preferences. Choose different theme colors and icons to create a user interface that suits your style. + +### Community Support and Plugins + +Home Assistant boasts a vibrant community where members continuously develop and share plugins and integrations. This ecosystem enables you to expand the system's functionality, ensuring that you can find a solution for virtually any requirement. \ No newline at end of file diff --git a/java/README_en.md b/java/README_en.md new file mode 100644 index 000000000..c6e6c58bf --- /dev/null +++ b/java/README_en.md @@ -0,0 +1,25 @@ +# Java + +Java is a widely used programming language and platform designed for building various types of applications, ranging from desktop applications to large-scale enterprise systems. + +## Main Features: + +- **Platform Independence**: Java is "write once, run anywhere" (WORA) feature allows code to run on any platform that supports Java. This is achieved through the Java Virtual Machine (JVM), which interprets Java bytecode into machine code specific to the platform. + +- **Object-Oriented**: Java supports encapsulation, inheritance, and polymorphism, which promote modularity, maintainability, and scalability. + +- **Standard Library**: Java provides extensive libraries covering data structures, networking, file I/O, GUI development, and more, boosting development efficiency. + +- **Multithreading**: Built-in multithreading capabilities enable developers to create concurrent programs that utilize multi-core processors for enhanced performance. + +- **Garbage Collection**: Java is automatic garbage collection reduces the risk of memory leaks and simplifies memory management. + +- **Security**: Java ensures secure execution through bytecode verification, sandboxing, and a security manager. + +- **Cross-Platform**: Java applications run seamlessly on multiple operating systems, including Windows, Linux, and macOS. + +- **Strong Type Checking**: Java is strict compile-time type checking helps catch errors early, improving code reliability. + +- **Community Support**: With a large and active developer community, Java offers extensive libraries, frameworks, and support for resolving challenges. + +- **Enterprise-Grade Applications**: Java is widely used for enterprise systems, powering critical applications in industries such as finance, telecommunications, and e-commerce. \ No newline at end of file diff --git a/jellyfin/README_en.md b/jellyfin/README_en.md new file mode 100644 index 000000000..9345853ee --- /dev/null +++ b/jellyfin/README_en.md @@ -0,0 +1,15 @@ +# Jellyfin + +**Jellyfin** is a free and open-source media server software designed to organize, manage, and share your audio, video, and image collections. + +## Main Features + +- **Personal Media Center**: Jellyfin allows you to organize your media files into libraries, creating a personal media center for easy access to your music, movies, TV shows, and more. + +- **Cross-Platform Support**: Jellyfin runs on various platforms, including Linux, Windows, macOS, and FreeBSD, enabling usage across different devices and operating systems. + +- **Multi-Device Access**: With Jellyfin's user-friendly interface and multiple client applications, you can access and stream your media content from any device, such as computers, smartphones, or tablets. + +- **Sharing and Remote Access**: Jellyfin supports sharing media content with family and friends and allows remote access to your library over the internet, ensuring entertainment on the go. + +- **Media Transcoding and Streaming**: Jellyfin automatically transcodes and streams your media content to accommodate different devices and network conditions, delivering an optimal playback experience. \ No newline at end of file diff --git a/jenkins/README_en.md b/jenkins/README_en.md new file mode 100644 index 000000000..fc6e0a6b2 --- /dev/null +++ b/jenkins/README_en.md @@ -0,0 +1,11 @@ +# Jenkins + +**Jenkins** is an open-source automation server designed for implementing continuous integration and continuous delivery (CI/CD) workflows. It offers powerful tools and plugins to help development teams automate building, testing, and deploying software. + +## Main Features: + +- **Continuous Integration**: Automates building and integrating code changes, ensuring timely merging and testing of changes from team members, reducing code conflicts and integration issues. +- **Automated Testing**: Supports a wide range of testing tools and plugins to run unit tests, integration tests, and end-to-end tests, ensuring software quality and stability. +- **Automated Deployment**: Integrates with various deployment tools and platforms to automate software deployment and release processes, enabling fast and reliable delivery. +- **Extensibility**: Offers a rich ecosystem of plugins to extend and customize functionalities based on project and team requirements. +- **Configuration and Management**: Features a user-friendly interface and scriptable configuration options, allowing administrators to configure and manage Jenkins instances effortlessly. \ No newline at end of file diff --git a/jumpserver/README_en.md b/jumpserver/README_en.md new file mode 100644 index 000000000..91031dc27 --- /dev/null +++ b/jumpserver/README_en.md @@ -0,0 +1,27 @@ +# JumpServer + +JumpServer is an open-source Privileged Access Management (PAM) tool that provides DevOps and IT teams with on-demand and secure access to SSH, RDP, Kubernetes, Database and RemoteApp endpoints through a web browser. + +## Main Features + +- **SSH**: Linux/Unix/Network devices, etc. +- **Windows**: Connect via web or native RDP. +- **Databases**: MySQL, Oracle, SQL Server, PostgreSQL, etc. +- **Kubernetes**: Access pods in K8s clusters. +- **Websites**: Manage web admin backends of various systems. +- **Applications**: Connect to various applications using Remote App. + +## Product Highlights: + +- **Open Source**: Zero barrier, quick online setup, and installation. +- **Plugin-Free**: Only a browser is required for an optimal web terminal experience. +- **Distributed**: Supports distributed deployment and horizontal scaling, handling high concurrent access with ease. +- **Multi-Cloud Support**: Manage assets across different clouds with a single system. +- **Multi-Tenancy**: One system can be used by multiple subsidiaries or departments. +- **Cloud Storage**: Audit recordings stored in the cloud, ensuring they are never lost. + +# Default Account and Password + +- **Username**: `admin` +- **Password**: The default password for version 3 is `admin`, and for version 4 is `ChangeMe`. + diff --git a/memos/README_en.md b/memos/README_en.md new file mode 100644 index 000000000..10bdc7d70 --- /dev/null +++ b/memos/README_en.md @@ -0,0 +1,11 @@ +# Memos + +Memos is a lightweight, privacy-first note-taking service designed to effortlessly capture and share your brilliant ideas. + +## Features: + +- **Open Source and Free Forever**: Embrace a borderless creative future with our open-source solution—free today, tomorrow, and always. +- **Self-Host in Seconds with Docker**: Enjoy the flexibility, scalability, and ease of setup provided by Docker, giving you full control over your data and privacy. +- **Plain Text with Markdown Support**: Say goodbye to the overwhelming complexity of rich formatting and adopt a minimalist approach to note-taking. +- **Easily Customize and Share Notes**: With our intuitive sharing features, you can effortlessly collaborate with others and distribute your notes. +- **RESTful API**: Unlock new possibilities by harnessing the power of integration with our RESTful API support. \ No newline at end of file diff --git a/minio/README_en.md b/minio/README_en.md index 9d33e3a12..54c9279da 100644 --- a/minio/README_en.md +++ b/minio/README_en.md @@ -20,9 +20,9 @@ MinIO ensures data security through encryption and access control. It supports S MinIO is compatible with Amazon S3, allowing integration with existing S3 tools and applications. This compatibility simplifies migration and scaling of existing S3 workloads. -### Multi-Tenant Support +### Multi-Tenancy Support -MinIO supports multi-tenant environments, enabling independent storage spaces and access controls for different organizations or users within a single MinIO instance. +MinIO supports multi-tenancy environments, enabling independent storage spaces and access controls for different organizations or users within a single MinIO instance. ### Version Control diff --git a/mongodb/README_en.md b/mongodb/README_en.md new file mode 100644 index 000000000..b1ee62310 --- /dev/null +++ b/mongodb/README_en.md @@ -0,0 +1,41 @@ +# MongoDB + +MongoDB is a popular NoSQL database management system that offers a wealth of features, making it a powerful tool for handling large-scale data and flexible data models. + +## Main Features: + +### Document-Oriented Database + +MongoDB stores data in BSON (Binary JSON) documents, providing a highly flexible data model. This allows for easy handling of varying data structures without the constraints of a fixed table schema. + +### High Scalability + +MongoDB supports horizontal scaling, making it easy to add servers to handle large volumes of data and high concurrency requests. This is ideal for large-scale applications and growing projects. + +### Powerful Query Language + +MongoDB's query language supports complex operations, including filtering, aggregation, sorting, and geospatial queries. Users can easily retrieve the data they need. + +### Replication and Failover + +MongoDB supports data replication, allowing for master-slave clusters that improve data availability and fault tolerance. In case of a primary node failure, a new primary is automatically elected. + +### Automatic Sharding + +MongoDB supports sharding, enabling horizontal partitioning of data across multiple servers. This improves performance and load balancing. + +### Indexing Support + +MongoDB offers various index types, including single-field, compound, and geospatial indexes. Indexes significantly enhance query performance. + +### Built-in Complex Transactions + +From version 4.0 onward, MongoDB supports multi-document transactions, allowing multiple operations to be executed within a single transaction to ensure data consistency. + +### Advanced Security + +MongoDB provides advanced security features, including access control, authentication, and encryption, ensuring data confidentiality and integrity. + +### Community Support and Ecosystem + +MongoDB boasts a large community and a rich ecosystem, with numerous tools, drivers, and extensions available for various development and operational tasks. diff --git a/nextcloud/README_en.md b/nextcloud/README_en.md new file mode 100644 index 000000000..a2ce19c5f --- /dev/null +++ b/nextcloud/README_en.md @@ -0,0 +1,29 @@ +# Nextcloud + +Nextcloud is an open-source, self-hosted cloud storage and collaboration platform that provides a range of features designed to help you manage and share files, calendars, contacts, tasks, and more, while protecting your data privacy. + +## Main Features: + +### File Storage and Sync + +Nextcloud allows you to easily upload, store, and synchronize files. You can access your files anytime, anywhere, whether on a computer, phone, or tablet, and share them effortlessly. + +### Calendars and Contacts + +Nextcloud includes a powerful calendar and contacts application that helps you organize appointments, tasks, and contact information. You can share calendars with other users and collaborate efficiently. + +### File Sharing and Collaboration + +You can easily share files and folders with other users and set different permission levels to control access. Nextcloud also supports collaborative document editing and planning. + +### Privacy and Security + +Nextcloud places a strong emphasis on data privacy and security. It offers end-to-end encryption, two-factor authentication, file versioning, and more to ensure your data is well-protected. + +### Extensibility and Plugins + +Nextcloud has a rich ecosystem of plugins, allowing you to extend its functionality based on your needs. You can add various applications and plugins to meet different use-case requirements. + +### Self-Hosting + +You can deploy Nextcloud on your own server, giving you full control over your data. This means you don't need to rely on third-party cloud service providers, offering better control over your digital life. diff --git a/node/README_en.md b/node/README_en.md new file mode 100644 index 000000000..4afef1e82 --- /dev/null +++ b/node/README_en.md @@ -0,0 +1,21 @@ +# Node.js + +Node.js is a popular server-side runtime environment that enables developers to build dynamic and scalable web applications and networked software. + +## Main Features: + +- **Non-Blocking I/O**: Node.js processes multiple concurrent connections efficiently without blocking operations, making it ideal for real-time applications. + +- **JavaScript**: Node.js uses JavaScript for server-side programming, allowing developers to use the same language for both client-side and server-side application development, simplifying web application development. + +- **Package Management**: Node.js comes with a powerful package manager that facilitates easy installation, management, and sharing of code libraries, speeding up development. + +- **Cross-Platform**: Node.js runs seamlessly on Windows, Linux, and macOS, making it versatile for different deployment needs. + +- **Event-Driven**: Developers can easily listen to and handle events, which is particularly suitable for creating real-time, interactive applications. + +- **Modular Design**: Node.js supports modular programming, allowing developers to break down code into smaller, reusable components, improving maintainability and scalability. + +- **Community Support**: With a large and active developer community, Node.js offers a vast array of modules and libraries, as well as community assistance. + +- **Single-Threaded**: Node.js uses a single-threaded model combined with an event loop and asynchronous operations, achieving efficient concurrency while avoiding challenges associated with multithreaded programming. \ No newline at end of file diff --git a/ollama-webui/README.md b/ollama-webui/README.md index 61059aab0..9c06157c6 100644 --- a/ollama-webui/README.md +++ b/ollama-webui/README.md @@ -1,38 +1,40 @@ # Open WebUI -针对 LLM 用户友好的 WebUI,支持的 LLM 运行程序包括 Ollama、OpenAI 兼容的 API。 +**Open WebUI** 是针对 LLM 用户友好的 WebUI,支持的 LLM 运行程序包括 Ollama、OpenAI 兼容的 API。 -## 特征: +## 主要功能: -- 直观的界面:我们的聊天界面从 ChatGPT 中汲取灵感,确保用户友好的体验。 -- 响应式设计:在桌面和移动设备上享受无缝体验。 -- 快速响应:享受快速响应的性能。 -- 轻松设置:使用 Docker 或 Kubernetes(kubectl、kustomize 或 helm)无缝安装,以获得无忧体验。 -- 代码语法突出显示:通过我们的语法突出显示功能增强代码的可读性。 -- 完整的 Markdown 和 LaTeX 支持:通过全面的 Markdown 和 LaTeX 功能来丰富交互,提升您的 LLM 体验。 -- 本地 RAG 集成:通过突破性的检索增强生成 (RAG) 支持深入了解聊天交互的未来。此功能将文档交互无缝集成到您的聊天体验中。您可以将文档直接加载到聊天中或将文件添加到文档库中,使用#提示中的命令轻松访问它们。在 alpha 阶段,当我们积极完善和增强此功能以确保最佳性能和可靠性时,可能会偶尔出现问题。 -- 网页浏览功能:使用#URL 后的命令将网站无缝集成到您的聊天体验中。此功能允许您将网络内容直接合并到您的对话中,从而增强交互的丰富性和深度。 -- 提示预设支持/:使用聊天输入中的命令立即访问预设提示。轻松加载预定义的对话开头并加快您的互动。通过Open WebUI Community集成轻松导入提示。 -- RLHF 注释:通过对消息进行“赞成”和“反对”评级来增强您的消息的能力,从而促进根据人类反馈 (RLHF) 创建强化学习数据集。利用您的消息来训练或微调模型,同时确保本地保存数据的机密性。 -- 对话标记:轻松分类和定位特定聊天,以便快速参考和简化数据收集。 -- 下载/删除模型:直接从 Web UI 轻松下载或删除模型。 -- GGUF 文件模型创建:通过直接从 Web UI 上传 GGUF 文件,轻松创建 Ollama 模型。简化的流程,可选择从您的计算机上传或从 Hugging Face 下载 GGUF 文件。 -- 多模型支持:不同聊天模型之间无缝切换,实现多样化交互。 -- 多模式支持:与支持多模式交互的模型无缝交互,包括图像(例如 LLava)。 -- 模型文件生成器:通过 Web UI 轻松创建 Ollama 模型文件。通过开放 WebUI 社区集成轻松创建和添加角色/代理、自定义聊天元素以及导入模型文件。 -- 多个模特对话:轻松地同时与多个模特互动,利用他们的独特优势来获得最佳响应。通过并行利用一组不同的模型来增强您的体验。 -- 协作聊天:通过无缝编排群组对话来利用多个模型的集体智慧。使用@命令指定模型,在聊天界面中启用动态且多样化的对话。让自己沉浸在聊天环境中的集体智慧中。 -- 再生历史访问:轻松重新访问和探索您的整个再生历史。 -- 聊天历史记录:轻松访问和管理您的对话历史记录。 -- 导入/导出聊天历史记录:将您的聊天数据无缝移入和移出平台。 -- 语音输入支持:通过语音交互与您的模型互动;享受直接与模特交谈的便利。此外,探索在 3 秒静音后自动发送语音输入的选项,以获得简化的体验。 -- 使用高级参数进行微调控制:通过调整温度等参数和定义系统提示来获得更深层次的控制,以根据您的特定偏好和需求定制对话。 -- 图像生成集成:使用 AUTOMATIC1111 API(本地)和 DALL-E 无缝集成图像生成功能,通过动态视觉内容丰富您的聊天体验。 -- OpenAI API 集成:轻松集成 OpenAI 兼容 API,与 Ollama 模型进行多功能对话。自定义 API 基本 URL 以链接到LMStudio、Mistral、OpenRouter 等。 -- 多种 OpenAI 兼容 API 支持:无缝集成和定制各种 OpenAI 兼容 API,增强聊天交互的多功能性。 -- 外部 Ollama 服务器连接:通过配置环境变量无缝链接到托管在不同地址上的外部 Ollama 服务器。 -- 多个 Ollama 实例负载平衡:轻松地在多个 Ollama 实例之间分配聊天请求,以增强性能和可靠性。 -- 多用户管理:通过我们直观的管理面板轻松监督和管理用户,简化用户管理流程。 -- 基于角色的访问控制(RBAC):通过受限的权限确保安全访问;只有经过授权的个人才能访问您的 Ollama,并且为管理员保留专有的模型创建/拉取权限。 -- 后端反向代理支持:通过 Open WebUI 后端和 Ollama 之间的直接通信增强安全性。这一关键功能消除了通过 LAN 公开 Ollama 的需要。从 Web UI 向“/ollama/api”路由发出的请求会从后端无缝重定向到 Ollama,从而增强整体系统安全性。 -- 持续更新:我们致力于通过定期更新和新功能来改进 Open WebUI。 \ No newline at end of file +- **直观的界面**:我们的聊天界面从 ChatGPT 中汲取灵感,确保用户友好的体验。 +- **响应式设计**:在桌面和移动设备上享受无缝体验。 +- **快速响应**:享受快速响应的性能。 +- **轻松部署**:使用 Docker 或 Kubernetes(kubectl、kustomize 或 helm)无缝安装,以获得无忧体验。 +- **代码语法高亮**:通过我们的语法突出显示功能增强代码的可读性。 +- **Markdown 和 LaTeX 支持**:通过全面的 Markdown 和 LaTeX 功能来丰富交互,提升您的 LLM 体验。 +- **RAG 集成**:通过突破性的检索增强生成 (RAG) 支持深入了解聊天交互的未来。此功能将文档交互无缝集成到您的聊天体验中。您可以将文档直接加载到聊天中或将文件添加到文档库中,使用#提示中的命令轻松访问它们。在 alpha 阶段,当我们积极完善和增强此功能以确保最佳性能和可靠性时,可能会偶尔出现问题。 +- **网页浏览功能**:使用 `#URL` 后的命令将网站无缝集成到您的聊天体验中。此功能允许您将网络内容直接合并到您的对话中,从而增强交互的丰富性和深度。 +- **提示预设支持**:使用聊天输入中的命令立即访问预设提示。轻松加载预定义的对话开头并加快您的互动。通过Open WebUI Community集成轻松导入提示。 +- **RLHF 注释**:通过对消息进行“赞成”和“反对”评级来增强您的消息的能力,从而促进根据人类反馈 (RLHF) 创建强化学习数据集。利用您的消息来训练或微调模型,同时确保本地保存数据的机密性。 +- **对话管理**:轻松分类和定位特定聊天,以便快速参考和简化数据收集。 +- **下载/删除模型**:直接从 Web UI 轻松下载或删除模型。 +- **GGUF 文件模型创建**:通过直接从 Web UI 上传 GGUF 文件,轻松创建 Ollama 模型。简化的流程,可选择从您的计算机上传或从 Hugging Face 下载 GGUF 文件。 +- **多模型支持**:不同聊天模型之间无缝切换,实现多样化交互。 +- **多模式支持**:与支持多模式交互的模型无缝交互,包括图像(例如 LLava)。 +- **模型文件生成器**:通过 Web UI 轻松创建 Ollama 模型文件。通过开放 WebUI 社区集成轻松创建和添加角色/代理、自定义聊天元素以及导入模型文件。 +- **多个模特对话**:轻松地同时与多个模特互动,利用他们的独特优势来获得最佳响应。通过并行利用一组不同的模型来增强您的体验。 +- **协作聊天**:通过无缝编排群组对话来利用多个模型的集体智慧。使用@命令指定模型,在聊天界面中启用动态且多样化的对话。让自己沉浸在聊天环境中的集体智慧中。 +- **再生历史访问**:轻松重新访问和探索您的整个再生历史。 +- **聊天历史记录**:轻松访问和管理您的对话历史记录。 +- **导入/导出聊天历史记录**:将您的聊天数据无缝移入和移出平台。 +- **语音输入支持**:通过语音交互与您的模型互动;享受直接与模特交谈的便利。此外,探索在 3 秒静音后自动发送语音输入的选项,以获得简化的体验。 +- **使用高级参数进行微调控制**:通过调整温度等参数和定义系统提示来获得更深层次的控制,以根据您的特定偏好和需求定制对话。 +- **图像生成集成**:使用 AUTOMATIC1111 API(本地)和 DALL-E 无缝集成图像生成功能,通过动态视觉内容丰富您的聊天体验。 +- **OpenAI API 集成**:轻松集成 OpenAI 兼容 API,与 Ollama 模型进行多功能对话。自定义 API 基本 URL 以链接到LMStudio、Mistral、OpenRouter 等。 +- **多种 OpenAI 兼容 API 支持**:无缝集成和定制各种 OpenAI 兼容 API,增强聊天交互的多功能性。 +- **外部 Ollama 服务器连接**:通过配置环境变量无缝链接到托管在不同地址上的外部 Ollama 服务器。 +- **多个 Ollama 实例负载平衡**:轻松地在多个 Ollama 实例之间分配聊天请求,以增强性能和可靠性。 +- **多用户管理**:通过我们直观的管理面板轻松监督和管理用户,简化用户管理流程。 +- **基于角色的访问控制(RBAC)**:通过受限的权限确保安全访问;只有经过授权的个人才能访问您的 Ollama,并且为管理员保留专有的模型创建/拉取权限。 +- **后端反向代理支持**:通过 Open WebUI 后端和 Ollama 之间的直接通信增强安全性。这一关键功能消除了通过 LAN 公开 Ollama 的需要。从 Web UI 向`/ollama/api`路由发出的请求会从后端无缝重定向到 Ollama,从而增强整体系统安全性。 +- **持续更新**:我们致力于通过定期更新和新功能来改进 Open WebUI。 + +**Open WebUI** 提供了广泛的功能集和高度的可扩展性,是理想的 LLM 用户工具。 \ No newline at end of file diff --git a/ollama-webui/README_en.md b/ollama-webui/README_en.md new file mode 100644 index 000000000..78200f445 --- /dev/null +++ b/ollama-webui/README_en.md @@ -0,0 +1,40 @@ +# Open WebUI + +**Open WebUI** is a user-friendly WebUI for LLM users, supporting LLM runtime programs such as Ollama and OpenAI compatible APIs. + +## Main Features: + +- **Intuitive Interface**: Our chat interface is inspired by ChatGPT, ensuring a user-friendly experience. +- **Responsive Design**: Enjoy a seamless experience on both desktop and mobile devices. +- **Fast Response**: Experience fast response performance. +- **Easy Deployment**: Seamlessly install using Docker or Kubernetes (kubectl, kustomize, or helm) for a hassle-free experience. +- **Code Syntax Highlighting**: Enhance code readability with our syntax highlighting feature. +- **Markdown and LaTeX Support**: Enrich interactions with comprehensive Markdown and LaTeX features to enhance your LLM experience. +- **RAG Integration**: Support for cutting-edge retrieval-augmented generation (RAG) that allows you to deeply explore the future of chat interactions. This feature seamlessly integrates document interactions into your chat experience. You can load documents directly into the chat or add files to the document library and easily access them using #prompt commands. During the alpha phase, we are actively refining and enhancing this feature to ensure optimal performance and reliability, though occasional issues may arise. +- **Web Browsing Capabilities**: Seamlessly integrate websites into your chat experience using commands with `#URL`. This feature lets you directly merge web content into your conversation, enriching the depth and interaction. +- **Prompt Presets Support**: Instantly access preset prompts in the chat input. Easily load predefined conversation starters and speed up your interactions. You can easily import prompts via Open WebUI Community integration. +- **RLHF Annotation**: Enhance the capability of your messages by rating them "upvote" and "downvote" to facilitate the creation of reinforcement learning datasets based on human feedback (RLHF). Use your messages to train or fine-tune models while ensuring local data confidentiality. +- **Conversation Management**: Easily categorize and locate specific chats for quick reference and simplified data collection. +- **Download/Delete Models**: Easily download or delete models directly from the Web UI. +- **GGUF File Model Creation**: Easily create Ollama models by uploading GGUF files directly from the Web UI. A simplified process allows you to upload from your computer or download GGUF files from Hugging Face. +- **Multi-Model Support**: Seamlessly switch between different chat models for diverse interactions. +- **Multi-Mode Support**: Interact seamlessly with models that support multi-modal interactions, including images (e.g., LLava). +- **Model File Generator**: Easily create Ollama model files through the Web UI. Open WebUI Community integration allows you to create and add roles/agents, customize chat elements, and import model files with ease. +- **Multiple Model Conversations**: Interact simultaneously with multiple models, leveraging their unique strengths to get the best responses. Parallelly utilizing a range of different models enhances your experience. +- **Collaborative Chat**: Seamlessly orchestrate group conversations to harness the collective intelligence of multiple models. Use the @command to specify models and enable dynamic and diverse conversations in the chat interface. Immerse yourself in the collective wisdom within the chat environment. +- **Regeneration History Access**: Easily revisit and explore your entire regeneration history. +- **Chat History Management**: Easily access and manage your chat history. +- **Import/Export Chat History**: Seamlessly import and export your chat data into and out of the platform. +- **Voice Input Support**: Interact with your model through voice; enjoy the convenience of speaking directly with the model. Additionally, explore the option to automatically send voice input after 3 seconds of silence for a streamlined experience. +- **Advanced Parameter Fine-Tuning Control**: Gain deeper control over your conversations by adjusting parameters like temperature and defining system prompts, allowing you to tailor your interaction based on your specific preferences and needs. +- **Image Generation Integration**: Seamlessly integrate image generation features with AUTOMATIC1111 API (local) and DALL-E, enriching your chat experience with dynamic visual content. +- **OpenAI API Integration**: Easily integrate OpenAI compatible APIs for multi-functional conversations with Ollama models. Customize the API base URL to link with LMStudio, Mistral, OpenRouter, etc. +- **Multiple OpenAI Compatible API Support**: Seamlessly integrate and customize various OpenAI compatible APIs to enhance the multi-functionality of your chat interactions. +- **External Ollama Server Connection**: Seamlessly connect to external Ollama servers hosted at different addresses by configuring environment variables. +- **Multiple Ollama Instance Load Balancing**: Effortlessly distribute chat requests across multiple Ollama instances to enhance performance and reliability. +- **Multi-User Management**: Easily monitor and manage users through our intuitive management panel, simplifying the user management process. +- **Role-Based Access Control (RBAC)**: Ensure secure access with restricted permissions; only authorized individuals can access your Ollama, with exclusive model creation/pulling rights reserved for administrators. +- **Backend Reverse Proxy Support**: Enhance security with direct communication between the Open WebUI backend and Ollama. This key feature eliminates the need to expose Ollama over LAN. Requests routed from the Web UI to `/ollama/api` will seamlessly redirect to Ollama from the backend, improving overall system security. +- **Continuous Updates**: We are committed to improving Open WebUI with regular updates and new features. + +**Open WebUI** offers a broad feature set and high scalability, making it the ideal tool for LLM users. \ No newline at end of file diff --git a/pgadmin4/README_en.md b/pgadmin4/README_en.md new file mode 100644 index 000000000..3a3c0d01c --- /dev/null +++ b/pgadmin4/README_en.md @@ -0,0 +1,44 @@ +# PGAdmin 4 + +PGAdmin 4 is a powerful tool for managing and maintaining PostgreSQL databases. It provides a rich set of features to help database administrators and developers efficiently manage their databases. + +## Main Features: + +### Database Connection Management + +- **Database Connections**: Easily connect to multiple PostgreSQL database servers. +- **Server Groups**: Organize and manage database servers by grouping them. + +### Database Object Management + +- **Table Management**: View, edit, and delete tables in the database, as well as execute SQL queries. +- **View Management**: Create, modify, and delete views in the database. +- **Indexes and Constraints**: Create and manage indexes and constraints to improve database performance and ensure data integrity. +- **Functions and Stored Procedures**: Manage functions and stored procedures within the database. +- **Triggers**: Create and manage triggers to perform actions when specific events occur. +- **External Data Import and Export**: Import and export data for backup and migration purposes. + +### Query Tools + +- **SQL Query Editor**: Execute SQL queries and view results, with support for SQL syntax highlighting and query history. +- **Visual Query Builder**: Build SQL queries using a drag-and-drop interface without writing SQL code. + +### Data Visualization + +- **Table Data Viewer**: View database data in a tabular format. +- **Charts and Graphs**: Create charts and graphs for more intuitive data presentation. + +### Database Backup and Restore + +- **Database Backup**: Create database backups to prevent data loss. +- **Database Restore**: Restore databases from backup files. + +### Security and Permissions Management + +- **User and Role Management**: Manage database users and roles to control access permissions. +- **Object Permissions**: Define and manage access permissions for database objects. +- **SSL Support**: Enhance the security of database connections. + +### Extensibility + +- **Plugin Support**: Extend PGAdmin 4's functionality through its plugin system. \ No newline at end of file diff --git a/portainer-ce/README_en.md b/portainer-ce/README_en.md new file mode 100644 index 000000000..3253ea3b2 --- /dev/null +++ b/portainer-ce/README_en.md @@ -0,0 +1,36 @@ +# Portainer CE + +Portainer CE (Community Edition) is an open-source container management tool that provides a user-friendly web interface for managing and monitoring containerized applications. + +## Main Features: + +### Container Management + +- **Container Creation and Start**: Portainer CE allows users to easily create, configure, and start containers. You can choose to create containers from existing images or import custom images. +- **Container Monitoring**: Through an intuitive interface, you can monitor container status, resource utilization, and logs in real time, helping you quickly identify issues and perform diagnostics. +- **Container Orchestration**: Portainer CE supports Docker Compose, allowing you to define multi-container applications declaratively and manage them within a single project. + +### Image Management + +- **Image Browsing and Search**: You can easily browse available Docker images and use the built-in search function to find the images you need. +- **Image Import and Export**: Supports importing and exporting Docker images for sharing and backing up applications across different environments. + +### Stacks and Services + +- **Stack Management**: Portainer CE supports Docker Swarm, allowing you to create, manage, and monitor stacks to deploy distributed applications. +- **Service Management**: Easily manage Swarm services, including scaling, updating, and performing rolling back operations. + +### User and Team Management + +- **Users and Permissions**: You can create multiple user accounts and assign different permissions, enabling collaborative management of containers and applications. + +### System Settings + +- **Dashboard and Monitoring**: Portainer CE provides a dashboard displaying key performance indicators of hosts and containers, helping you monitor your entire containerized environment. +- **Storage and Network Configuration**: Configure storage volumes and network settings to enable containers to communicate with each other and access external resources. +- **Application Templates**: Supports application templates to simplify the deployment of common containerized applications. + +### Logs and Auditing + +- **Log Viewing**: Easily view real-time logs of containers and services to assist with troubleshooting and monitoring. +- **Audit Logs**: Records user actions for auditing and security analysis. \ No newline at end of file diff --git a/sftpgo/README_en.md b/sftpgo/README_en.md new file mode 100644 index 000000000..6bf243efa --- /dev/null +++ b/sftpgo/README_en.md @@ -0,0 +1,16 @@ +# SFTPGo + +**SFTPGo** is a fully-featured and highly configurable SFTP server that also supports custom HTTP/S, FTP/S, and WebDAV services. + +> Supported backend storage: Local filesystem, encrypted local filesystem, S3-compatible object storage, Google Cloud Storage, Azure Blob Storage, and SFTP. + +## Main Features: + +- **Multi-User Support**: Create and manage multiple user accounts, each with independent access permissions and directories. +- **Highly Configurable**: Customize extensively to meet your needs, including user access control, upload/download limits, and authentication methods. +- **Security**: Supports multiple authentication methods like SSH keys, username/password, and multifactorial authentication. IP whitelisting and blacklisting enhance security further. +- **File Transfer Management**: Securely upload and download files using SFTP and SCP protocols. Features include transfer rate limits, folder quotas, and file type filtering. +- **High Performance**: Optimized for handling high concurrency and throughput in file transfers. +- **Monitoring and Logging**: Offers detailed logging and monitoring capabilities for administrators to track user activity and server performance. +- **Automation**: Integrates into workflows via REST API and Webhook support for streamlined file transfer management. +- **Extensibility**: You can increase the functionality of SFTPGo through plugins and extensions to meet specific requirements. \ No newline at end of file diff --git a/stirling-pdf/README_en.md b/stirling-pdf/README_en.md new file mode 100644 index 000000000..ffc376a08 --- /dev/null +++ b/stirling-pdf/README_en.md @@ -0,0 +1,11 @@ +# Stirling-PDF + +**Stirling-PDF** is a powerful self-hosted web-based tool for performing various operations on PDF files, such as splitting, merging, converting, reorganizing, adding images, rotating, and compressing. + +## Main Features + +- **Dark Mode Support**: Enjoy a visually comfortable experience with dark mode. +- **Customizable Download Options**: Personalize your downloads. See an example [here](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/images/settings-light.png). +- **Parallel File Processing and Downloads**: Handle multiple files simultaneously for efficient workflow. +- **API for Integration**: Seamlessly integrate with external scripts via the provided API. +- **Optional Login and Authentication Support**: Secure your application as needed. Documentation is available [here](https://github.com/Stirling-Tools/Stirling-PDF/tree/main#login-authentication). \ No newline at end of file