-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
fcebf26
commit fc4edde
Showing
1 changed file
with
45 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,67 +1,74 @@ | ||
| <p align="center"><img src="https://raw.githubusercontent.com/vanguardbackup/assets/main/icon-200.png" width="120" alt="Vanguard Logo"></p> | ||
|  | ||
|
|
||
| <p align="center"> | ||
| <a href="https://opensource.org/license/agpl-v3"> | ||
| <img src="https://img.shields.io/github/license/vanguardbackup/vanguard?style=for-the-badge&logo=opensourceinitiative&logoColor=ffffff" alt="License: MIT"> | ||
| <img src="https://img.shields.io/github/license/vanguardbackup/vanguard?style=for-the-badge&logo=opensourceinitiative&logoColor=ffffff" alt="License: AGPLv3"> | ||
| </a> | ||
| <a href="https://github.com/vanguardbackup/vanguard/actions/workflows/main-ci.yml"> | ||
| <img src="https://img.shields.io/github/actions/workflow/status/vanguardbackup/vanguard/main-ci.yml?style=for-the-badge&logo=githubactions&logoColor=ffffff&label=CI%20Pipeline" alt="CI Pipeline"> | ||
| </a> | ||
| <a href="https://github.com/vanguardbackup/vanguard/releases"> | ||
| <img src="https://img.shields.io/github/v/release/vanguardbackup/vanguard?style=for-the-badge&logo=github&logoColor=ffffff" alt="GitHub Release"> | ||
| </a> | ||
| <a href="https://laravel.com"> | ||
| <img src="https://img.shields.io/badge/laravel-%23FF2D20.svg?style=for-the-badge&logo=laravel&logoColor=white" alt="Laravel"> | ||
| </a> | ||
| <a href="https://github.com/vanguardbackup/vanguard/releases"> | ||
| <img src="https://img.shields.io/github/v/release/vanguardbackup/vanguard?style=for-the-badge&logo=github&logoColor=ffffff" alt="GitHub Release"> | ||
| </a> | ||
| <a href="https://laravel.com"> | ||
| <img src="https://img.shields.io/badge/laravel-%23FF2D20.svg?style=for-the-badge&logo=laravel&logoColor=white" alt="Laravel"> | ||
| </a> | ||
| </p> | ||
|
|
||
| ## About Vanguard | ||
|
|
||
| Vanguard is a Laravel project that aims to provide an easy way to backup your files and databases. It is designed to be easy to use and friendly. | ||
|
|
||
| Vanguard has official support for modern Ubuntu and Debian servers. | ||
| Vanguard is an open-source Laravel project that provides an easy-to-use solution for backing up your files and databases. Designed with simplicity and efficiency in mind, Vanguard offers official support for modern Ubuntu and Debian servers. | ||
|
|
||
| <p align="center"> | ||
| <img src="https://raw.githubusercontent.com/vanguardbackup/assets/main/screenshots/backup-tasks.png" width="900" alt="Screenshot"></p> | ||
| <img src="https://raw.githubusercontent.com/vanguardbackup/assets/main/screenshots/backup-tasks.png" width="900" alt="Screenshot"> | ||
| </p> | ||
|
|
||
| ## Key Features | ||
|
|
||
| For detailed documentation, please visit our [official documentation site](https://docs.vanguardbackup.com/). | ||
| - Intuitive user interface with flexible backup scheduling | ||
| - File and database backup support | ||
| - Multichannel notifications (Email, Discord, Slack, Pushover) | ||
| - OAuth login (GitHub, GitLab, Bitbucket) and two-factor authentication | ||
| - REST API for integration and automation | ||
| - Multi-language support and encrypted data storage | ||
| - Comprehensive backup statistics and reporting | ||
|
|
||
| ## Features | ||
| ## Getting Started | ||
|
|
||
| - Easy-to-use interface | ||
| - Flexible scheduling of backups | ||
| - Schedule backups daily, weekly, or with custom cron expressions | ||
| - Back up both files and databases | ||
| - Receive notifications via Email, Discord, or Slack | ||
| - Weekly backup summaries | ||
| - Option to authenticate with GitHub | ||
| - Ability to pause/resume scheduled backup tasks as needed | ||
| - Automatic server connection checks | ||
| - Multi-language support | ||
| - Encrypts sensitive information | ||
| - View statistics and aggregated data about your backups over time | ||
| For detailed installation instructions and system requirements, please visit our [official documentation](https://docs.vanguardbackup.com/installation). | ||
|
|
||
| Do you have an idea that isn't listed? [Create a post](https://github.com/vanguardbackup/vanguard/discussions/new?category=ideas) in our discussions section. | ||
| Quick start: | ||
| 1. Clone the repository | ||
| 2. Follow the step-by-step guide in our [documentation](https://docs.vanguardbackup.com/installation) | ||
|
|
||
| ## Installation and Running Vanguard | ||
| ## Vanguard Ecosystem | ||
|
|
||
| For detailed installation instructions and system requirements, please visit our [official documentation](https://docs.vanguardbackup.com/installation). | ||
| Explore our related projects: | ||
|
|
||
| Key points to note: | ||
| - [Marketing](https://github.com/vanguardbackup/marketing) - Our website at https://vanguardbackup.com | ||
| - [Docs](https://github.com/vanguardbackup/docs) - Official documentation at https://docs.vanguardbackup.com | ||
| - [Mobile](https://github.com/vanguardbackup/mobile) - Mobile application | ||
| - [PHP SDK](https://github.com/vanguardbackup/vanguard-php-sdk) - PHP SDK for Vanguard's API | ||
| - [Feedback API](https://github.com/vanguardbackup/feedback-api) - API for experimental features feedback | ||
| - [Assets](https://github.com/vanguardbackup/assets) - Brand image assets | ||
|
|
||
| - Vanguard is a Laravel project and follows standard Laravel installation procedures. | ||
| - System requirements include PHP 8.2+, Redis, Composer, Node.js, and NPM. | ||
| - We recommend using Laravel Valet, but any local development environment will work. | ||
| ## Community and Support | ||
|
|
||
| To get started quickly: | ||
| ### Contributing | ||
|
|
||
| 1. Clone the repository | ||
| 2. Follow the step-by-step installation guide in our [documentation](https://docs.vanguardbackup.com/installation) | ||
| We welcome contributions! Please read our [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to contribute. | ||
|
|
||
| ### Get Involved | ||
|
|
||
| - **Ask Questions**: Use our [Discussions forum](https://github.com/orgs/vanguardbackup/discussions) | ||
| - **Report Issues**: Open an issue in the relevant repository | ||
| - **Suggest Features**: [Create a post](https://github.com/vanguardbackup/vanguard/discussions/new?category=ideas) in our discussions section | ||
|
|
||
| ## Contributing | ||
| ### Contact Us | ||
|
|
||
| Thank you for considering contributing to Vanguard! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information on how to contribute to the project. | ||
| - **Email**: [[email protected]](mailto:[email protected]) | ||
| - **Website**: [https://vanguardbackup.com](https://vanguardbackup.com) | ||
| - **Documentation**: [https://docs.vanguardbackup.com](https://docs.vanguardbackup.com) | ||
|
|
||
| ## License | ||
|
|
||
|
|
||