Documentation for configs management

Author: tzurbaev

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+### Added
+- Configuration (nginx and ENV) files management;
 
 ## [1.0.1] - 2017-03-14
 ### Added

docs/config-files.md

@@ -0,0 +1,74 @@
+# Overview
+
+SDK provides Configs Manager that allows you to view and edit NGINX and ENV configuration files for your sites.
+
+# Usage
+
+Documentation assumes that you've already retrieved site instance from `SitesManager` class.
+
+All operations are performed via `Laravel\Forge\Configs\ConfigsManager` instance.
+
+## Get Nginx configuration
+
+```php
+<?php
+
+use Laravel\Forge\Configs\ConfigsManager;
+
+$configs = new ConfigsManager();
+$nginxConfiguration = $configs->get('nginx')->from($site);
+```
+
+The value of `$nginxConfiguration` is actual content of your nginx configuration file.
+
+## Update Nginx configuration
+
+```php
+<?php
+
+use Laravel\Forge\Configs\ConfigsManager;
+
+$configs = new ConfigsManager();
+
+// Load new configuration file from appropirate source.
+$configuration = file_get_contents('nginx.conf');
+
+if ($configs->update('nginx', $configuration)->on($site)) {
+    echo 'Nginx configuration on '.$site->domain().' site was updated.';
+}
+```
+
+## Get ENV configuration
+
+ENV confguration stored in `.env` file of your application.
+
+```php
+<?php
+
+use Laravel\Forge\Configs\ConfigsManager;
+
+$configs = new ConfigsManager();
+
+$env = $configs->get('env')->from($site);
+```
+
+The value of `$env` is actual content of your `.env` configuration file.
+
+## Update ENV configuration
+
+```php
+<?php
+
+use Laravel\Forge\Configs\ConfigsManager;
+
+$configs = new ConfigsManager();
+
+// Load new configuration file from appropirate source.
+$configuration = file_get_contents('.env');
+
+if ($configs->update('env', $configuration)->on($site)) {
+    echo 'ENV configuration on '.$site->domain().' site was updated.';
+}
+```
+
+[Back to Table of Contents](./readme.md)

docs/getting-started.md

@@ -12,6 +12,7 @@ This SDK supports following Forge API features:
 - Services management - install, uninstall, reboot & stop nginx, MySQL, Postgres and other services;
 - MySQL databases & users;
 - Sites & applications management;
+- Site configuration (`nginx.conf` & `.env` files);
 - Deployment management - enable to disable quick deployment, view logs, edit deployment script & deploy-on-demand;
 - SSH keys;
 - Daemons;
@@ -22,7 +23,6 @@ This SDK supports following Forge API features:
 ## Coming soon
 
 - SSL certificates management;
-- Services configuration;
 - Recipes.
 
 # Requirements

docs/readme.md

@@ -13,5 +13,6 @@
 - [Firewall Rules](./firewall-rules.md)
 - [Sites](./sites.md)
     + [Site Applications](./site-applications.md)
+    + [Configuration Files](./config-files.md)
     + [Deployment](./deployment.md)
     + [Workers](./workers.md)