mirror of
https://github.com/secure-updates/secure-updates-server.git
synced 2025-11-23 20:16:16 +08:00
2baa86af4d
- Split monolithic README into standard MD files: - README.md: Core project info and quickstart - API.md: API endpoint documentation - CHANGELOG.md: Version history - CONTRIBUTING.md: Development guidelines - INSTALL.md: Detailed setup instructions - SECURITY.md: Security policies - Update project status from "Not Production-Ready" to "Beta Status" to better reflect mature codebase while encouraging testing - Organize documentation following standard conventions - Improve readability and maintainability - Keep content consistent across all files
85 lines
No EOL
3.4 KiB
Markdown
85 lines
No EOL
3.4 KiB
Markdown
# Secure Updates Server
|
|
|
|
A WordPress plugin that provides secure plugin updates by allowing direct uploads and mirroring from repositories with Media Library integration.
|
|
|
|
**Contributors:** Secure Updates Foundation
|
|
**Tags:** updates server, plugin mirror, WordPress, media library, plugin updates, API keys
|
|
**Requires at least:** 5.0
|
|
**Tested up to:** 6.6.2
|
|
**Stable tag:** 4.0
|
|
**License:** GPLv2 or later
|
|
**License URI:** [https://www.gnu.org/licenses/gpl-2.0.html](https://www.gnu.org/licenses/gpl-2.0.html)
|
|
|
|
## Beta Status
|
|
This plugin is in active development and while it's feature-complete and follows security best practices, it hasn't undergone extensive production testing across different environments. Test thoroughly in a staging environment before deploying to production.
|
|
|
|
|
|
|
|
## Description
|
|
|
|
**Secure Updates Server** is a comprehensive WordPress plugin designed to provide secure and controlled plugin updates. It caters to two primary user groups:
|
|
|
|
1. **Companies Managing Client Sites**: Mirror plugins from centralized repositories like WordPress.org to maintain greater control over plugin updates across multiple client sites.
|
|
|
|
2. **Plugin Authors**: Simplify the distribution of updates by directly uploading plugins to the Secure Updates Server.
|
|
|
|
## Features
|
|
|
|
- **API Key Integration**: Secure client authentication using API keys
|
|
- **Direct Plugin Uploads & Versioning**: Upload and manage plugin versions
|
|
- **1-Click Mirroring from WordPress.org**: Easy plugin mirroring
|
|
- **Media Library Integration**: Seamless cloud storage integration
|
|
- **REST API Endpoints**: Secure communication infrastructure
|
|
- **Automated & Scheduled Updates**: Hourly update checks
|
|
- **Checksum Verification**: File integrity verification
|
|
- **Enhanced Security Measures**: Comprehensive security features
|
|
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
1. **Download the Plugin:**
|
|
- Clone the repository or download the ZIP file
|
|
- Install via WordPress Admin > Plugins > Add New > Upload Plugin
|
|
- Activate the plugin
|
|
|
|
2. **Configure the Plugin:**
|
|
- Navigate to Secure Updates Server in admin menu
|
|
- Set up API keys
|
|
- Configure plugin mirroring or uploads
|
|
- Manage plugin versions
|
|
|
|
For detailed installation and configuration instructions, see [INSTALL.md](INSTALL.md).
|
|
|
|
## Documentation
|
|
|
|
- [Installation Guide](INSTALL.md) - Detailed setup instructions
|
|
- [API Documentation](API.md) - REST API endpoints and usage
|
|
- [Contributing Guide](CONTRIBUTING.md) - Development and contribution guidelines
|
|
- [Changelog](CHANGELOG.md) - Version history and updates
|
|
- [Security Policy](SECURITY.md) - Security guidelines and reporting
|
|
|
|
## Related Tools
|
|
|
|
- **[Secure Updates Client](https://github.com/secure-updates/secure-updates-client)**: Plugin for client sites
|
|
- **[Secure Updates Library](https://github.com/secure-updates/secure-updates-library)**: Integration library for plugin authors
|
|
|
|
|
|
|
|
|
|
## Requirements
|
|
|
|
- WordPress 5.0 or higher
|
|
- PHP 7.4 or higher
|
|
- ZIP extension enabled
|
|
- Write permissions for wp-content/uploads
|
|
|
|
## Support
|
|
|
|
For bug reports and feature requests, please use the [GitHub issue tracker](https://github.com/secure-updates/secure-updates-server/issues).
|
|
|
|
## License
|
|
|
|
This project is licensed under the GPL v2 or later - see [LICENSE](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html) for details. |
