thetemplateblog/hosting

There is no license information available for the latest version (dev-main) of this package.

Hosting management addon for Statamic

dev-main 2024-11-02 20:07 UTC

Requires

• statamic/cms: ^4.0 || ^5.0

Unknown License

README

A comprehensive hosting infrastructure management addon for Statamic that helps you manage providers, servers, and sites with a clean, intuitive interface.

Features

Provider Management

• Secure API key storage with encryption
• Support for major cloud providers:
  • DigitalOcean
  • AWS
  • Linode
  • Vultr
• Easy provider configuration
• API key visibility toggling

Server Management

• Link servers to configured providers
• Environment tracking (Production/Staging/Development)
• Server status monitoring
• SSH credential management
• Server health indicators

Site Management

• Domain management
• Server assignment
• Site status tracking
• Environment indicators
• Quick access to site details

Screenshots

Provider Management

• Configure hosting providers
• Securely store API credentials
• View provider status

Server Management

• Manage server configurations
• Track server environments
• Monitor server status

Site Management

• Manage hosted sites
• Associate with servers
• Track domains and status

Installation

You can install this addon via composer:

composer require TheTemplateBlog/hosting

Requirements

• Statamic 4.x
• PHP 8.1 or higher
• Laravel 10.x

Quick Start

1. Install the addon
2. Configure your first provider
3. Add your servers
4. Start managing your sites

Detailed Setup

1. Provider Configuration

Navigate to CP → Hosting → Providers and click "Add Provider":

1. Select your provider type
2. Enter your provider label
3. Add your API credentials
4. Save the provider configuration

2. Server Management

Once you have a provider configured, go to CP → Hosting → Servers:

1. Click "Add Server"
2. Select your configured provider
3. Enter server details:
   • Name
   • Username
   • Environment
4. Save the server configuration

3. Site Management

With servers configured, go to CP → Hosting → Sites:

1. Click "Add Site"
2. Select the hosting server
3. Enter site details:
   • Name
   • Domain
4. Save the site configuration

Configuration

Publish the configuration file:

bash

php artisan vendor:publish --tag="hosting-config"

Provider Configuration (config/hosting.php)

php

return [
    'providers' => [
        [
            'label' => 'DigitalOcean',
            'provider_type' => 'digitalocean',
            'description' => 'DigitalOcean is a cloud infrastructure provider.'
        ],
        [
            'label' => 'AWS',
            'provider_type' => 'aws',
            'description' => 'Amazon Web Services (AWS) is a comprehensive cloud platform.'
        ],
        [
            'label' => 'Linode',
            'provider_type' => 'linode',
            'description' => 'Linode provides simple, affordable, and fast cloud infrastructure.'
        ],
        [
            'label' => 'Vultr',
            'provider_type' => 'vultr',
            'description' => 'Vultr delivers high-performance cloud compute environments.'
        ]
    ]
];

Data Storage

All data is stored securely in the user's YAML file:

• Provider configurations (with encrypted API keys)
• Server details
• Site information

Security

API Key Encryption

All API keys are encrypted using Laravel's encryption system before storage.

Access Control

The addon integrates with Statamic's permission system.

Data Protection

Sensitive data is stored in secure user YAML files.

Troubleshooting

Common Issues

1. Provider Not Showing

   • Check provider configuration
   • Verify API credentials

2. Server Connection Issues

   • Verify SSH credentials
   • Check server firewall settings

3. Site Management Issues

   • Confirm server configuration
   • Verify domain settings

Development

Local Development Setup

1. Clone the repository:

bash

git clone https://github.com/TheTemplateBlog/hosting.git

1. Install dependencies:

bash

composer install

1. Link to your Statamic installation:

bash

php artisan package:discover

Testing

Run the test suite:

bash

composer test

Contributing

Please see CONTRIBUTING.md for details.

Security

If you discover any security-related issues, please email [e-mail] instead of using the issue tracker.

Please see SECURITY.md for more details.

Credits

• Your Name
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Support

Documentation

Full documentation is available at docs.example.com

Issues

Please report issues via the GitHub issue tracker

Community

Join our Discord community for support and discussion

Roadmap

• Provider API Integration
• Automated Server Provisioning
• Backup Management
• SSL Certificate Management
• Site Deployment Automation
• Server Monitoring
• Performance Analytics
• Multi-user Support