98 lines
No EOL
2.7 KiB
Markdown
98 lines
No EOL
2.7 KiB
Markdown
# Unraid App Templates
|
|
|
|
This repository contains a collection of public application templates for Unraid server platform.
|
|
|
|
## Overview
|
|
|
|
These templates provide ready-to-deploy configurations for various applications that can be easily installed on your Unraid server through the Community Applications (CA) interface.
|
|
|
|
## Usage
|
|
|
|
1. Navigate to the Apps section in your Unraid web interface
|
|
2. Click on "Community Applications"
|
|
3. Search for the desired application
|
|
4. Click "Install"
|
|
|
|
## Template Structure
|
|
|
|
Each template follows the standard Unraid XML format and includes:
|
|
|
|
- Container configuration
|
|
- Port mappings
|
|
- Volume bindings
|
|
- Environment variables
|
|
- Default settings
|
|
- Network configurations
|
|
|
|
## Available Templates
|
|
|
|
*Note: This section will be updated as new templates are added*
|
|
|
|
| Application | Description | Status |
|
|
|-------------|-------------|---------|
|
|
| [Template 1] | Description of app 1 | ✅ Stable |
|
|
| [Template 2] | Description of app 2 | ✅ Stable |
|
|
|
|
## Installation Requirements
|
|
|
|
- Unraid 6.9.0 or later
|
|
- Community Applications plugin installed
|
|
- Docker enabled on your Unraid server
|
|
|
|
## Contributing
|
|
|
|
1. Fork the repository
|
|
2. Create your feature branch (`git checkout -b feature/NewTemplate`)
|
|
3. Commit your changes (`git commit -am 'Add new template for XYZ'`)
|
|
4. Push to the branch (`git push origin feature/NewTemplate`)
|
|
5. Create a new Pull Request
|
|
|
|
## Template Testing
|
|
|
|
Before submitting a pull request, please ensure:
|
|
|
|
- [ ] The template successfully creates a container
|
|
- [ ] All specified ports are correctly mapped
|
|
- [ ] Volume mappings are working as expected
|
|
- [ ] The application starts without errors
|
|
- [ ] Documentation is clear and complete
|
|
|
|
## Support
|
|
|
|
- For template-specific issues, create an issue in this repository
|
|
- For application-specific issues, refer to the application's official documentation
|
|
- For Unraid-specific questions, visit the [HHF Technology Forums](https://forum.hhf.technology/)
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
|
|
## Acknowledgments
|
|
|
|
- Unraid community members
|
|
- Docker container maintainers
|
|
- Application developers
|
|
|
|
## Security
|
|
|
|
Please report any security vulnerabilities to the repository owner. Do not create public issues for security concerns.
|
|
|
|
---
|
|
|
|
## Template Development Guidelines
|
|
|
|
When creating new templates, please follow these guidelines:
|
|
|
|
1. Use clear, descriptive names for variables
|
|
2. Include comprehensive documentation
|
|
3. Specify version tags for base images
|
|
4. Include health checks where possible
|
|
5. Follow Unraid's best practices for container configuration
|
|
|
|
---
|
|
|
|
*Made with ❤️ for the Unraid community*
|
|
|
|
## Disclaimer
|
|
|
|
These templates are provided as-is, without warranty of any kind. Always backup your data before testing new containers. |