https://github.com/vanguardbackup/docs
Documentation for the Vanguard project.
https://github.com/vanguardbackup/docs
docs documentation open-source open-source-docs vanguard-docs vitepress
Last synced: about 1 year ago
JSON representation
Documentation for the Vanguard project.
- Host: GitHub
- URL: https://github.com/vanguardbackup/docs
- Owner: vanguardbackup
- License: mit
- Created: 2024-07-19T11:33:08.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-07T22:04:33.000Z (over 1 year ago)
- Last Synced: 2025-03-07T23:18:56.074Z (over 1 year ago)
- Topics: docs, documentation, open-source, open-source-docs, vanguard-docs, vitepress
- Language: CSS
- Homepage: https://docs.vanguardbackup.com/
- Size: 27 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vanguard Documentation
Documentation for Vanguard, an open-source Laravel application for managing remote server backups.
## About
Vanguard enables users to connect to remote Linux servers, create backups to various destinations (S3, etc.), and run scheduled or manual backup operations.
## Development
This documentation uses [VitePress](https://vitepress.dev/).
### Prerequisites
- Node.js (v20+)
- npm or yarn
### Quick Start
```bash
# Install dependencies
npm install
# Development server
npm run docs:dev
# Build for production
npm run docs:build
```
## Structure
- `/`: Documentation markdown files
- `/.vitepress`: Configuration and theme
- `/api`: API markdown files
- `/public`: Static assets
## Contributing
To contribute:
1. Fork the repository
2. Create a branch for your changes
3. Submit a pull request
## License
MIT License. See the [LICENSE](LICENSE) file.
## Security
Please report security vulnerabilities according to our [security policy](https://github.com/vanguardbackup/vanguard/blob/main/SECURITY.md).
## Support
For questions or suggestions, please open an issue in this repository.