Welcome to the official documentation for Vanguard, an open-source Laravel application for managing remote server backups.
Vanguard is a powerful tool that allows users to:
- Connect to remote Linux servers
- Facilitate backups from these servers to various destinations (e.g., S3 buckets)
- Enable both scheduled and manual backup operations
Our documentation is powered by VitePress, a static site generator designed for building fast, content-focused websites.
- Node.js (version 18 or higher)
- npm or yarn
-
Clone the repository:
git clone https://github.com/vanguardbackup/docs.git cd docs -
Install dependencies:
npm install # or yarn install -
Start the development server:
npm run docs:dev # or yarn docs:dev -
Build for production:
npm run docs:build # or yarn docs:build
/docs: Contains all markdown files for the documentation/docs/.vitepress: VitePress configuration and theme customization/public: Static assets like images and icons
We welcome contributions to improve Vanguard's documentation! If you notice any mistakes, areas for improvement, or want to add new content:
- Fork the repository
- Create a new branch for your changes
- Make your improvements
- Submit a pull request with a clear description of your changes
Vanguard's documentation is licensed under the MIT Licence. See the LICENSE file for more details.
If you discover a security vulnerability within the documentation or the Vanguard application itself, please follow our security policy. Do not disclose security-related issues publicly until they have been addressed by the Vanguard team.
For questions, suggestions, or help with the documentation please open an issue in this repository.
Thank you for contributing to Vanguard's documentation.